Allows you to retrieve all contacts in a Xero organisation

GET {{baseUrl}}/Contacts?where=EmailAddress="{{email}}"

Request Params

KeyDatatypeRequiredDescription
orderstringOrder by an any element
IDsstringFilter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
pagestringe.g. page=1 - Up to 100 contacts will be returned in a single API call.
includeArchivedstringe.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
wherestring

HEADERS

KeyDatatypeRequiredDescription
If-Modified-SincestringOnly records created or modified since this timestamp will be returned
xero-tenant-idstring(Required) Xero identifier for Tenant

RESPONSES

status: OK

"\u003cResponse xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\u003e\n    \u003cId\u003ed8fa34d0-4d26-4529-b5f0-53e282721667\u003c/Id\u003e\n    \u003cStatus\u003eOK\u003c/Status\u003e\n    \u003cProviderName\u003eFlows\u003c/ProviderName\u003e\n    \u003cDateTimeUTC\u003e2023-02-07T03:02:04.0246394Z\u003c/DateTimeUTC\u003e\n    \u003cContacts\u003e\n        \u003cContact\u003e\n            \u003cContactID\u003e12bfc618-5aa3-41a2-8d7d-6c214d3935ae\u003c/ContactID\u003e\n            \u003cContactStatus\u003eACTIVE\u003c/ContactStatus\u003e\n            \u003cName\u003eJoe Smith\u003c/Name\u003e\n            \u003cEmailAddress\u003ejoe@company.com\u003c/EmailAddress\u003e\n            \u003cAddresses\u003e\n                \u003cAddress\u003e\n                    \u003cAddressType\u003eSTREET\u003c/AddressType\u003e\n                \u003c/Address\u003e\n                \u003cAddress\u003e\n                    \u003cAddressType\u003ePOBOX\u003c/AddressType\u003e\n                \u003c/Address\u003e\n            \u003c/Addresses\u003e\n            \u003cPhones\u003e\n                \u003cPhone\u003e\n                    \u003cPhoneType\u003eDDI\u003c/PhoneType\u003e\n                \u003c/Phone\u003e\n                \u003cPhone\u003e\n                    \u003cPhoneType\u003eDEFAULT\u003c/PhoneType\u003e\n                \u003c/Phone\u003e\n                \u003cPhone\u003e\n                    \u003cPhoneType\u003eFAX\u003c/PhoneType\u003e\n                \u003c/Phone\u003e\n                \u003cPhone\u003e\n                    \u003cPhoneType\u003eMOBILE\u003c/PhoneType\u003e\n                \u003c/Phone\u003e\n            \u003c/Phones\u003e\n            \u003cUpdatedDateUTC\u003e2023-02-07T02:38:36.17\u003c/UpdatedDateUTC\u003e\n            \u003cIsSupplier\u003efalse\u003c/IsSupplier\u003e\n            \u003cIsCustomer\u003efalse\u003c/IsCustomer\u003e\n            \u003cHasAttachments\u003efalse\u003c/HasAttachments\u003e\n        \u003c/Contact\u003e\n    \u003c/Contacts\u003e\n\u003c/Response\u003e"