contacts list
GET {{baseUrl}}/contacts
Returns a list of Contact objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was deleted in the third-party service. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_id | string | The API provider's ID for the given object. | |
company_id | string | ||
is_customer | boolean | ||
is_supplier | boolean |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"c640b80b-fac9-409f-aa19-1f9221aec445","remote_id":"11167","name":"Gil Feig's Pickleball Team","is_supplier":false,"is_customer":true,"email_address":"pickleball@merge.dev","tax_number":"12-3456789","status":"ARCHIVED","currency":"USD","remote_updated_at":"2020-03-31T00:00:00Z","addresses":["2f2702aa-8948-492b-a412-2acdf6d2c499","d98c7428-8dda-48a8-a1da-c570f65e2375"],"phone_numbers":[{"number":"+3198675309","type":"Mobile"}]},{"id":"c640b80b-fac9-409f-aa19-1f9221aec445","remote_id":"11167","name":"Gil Feig's Pickleball Team","is_supplier":true,"is_customer":true,"email_address":"pickleball@merge.dev","tax_number":"12-3456789","status":"ARCHIVED","currency":"USD","remote_updated_at":"2020-03-31T00:00:00Z","addresses":["2f2702aa-8948-492b-a412-2acdf6d2c499","d98c7428-8dda-48a8-a1da-c570f65e2375"],"phone_numbers":[{"number":"+3198675309","type":"Mobile"}]}]}