leads list

GET {{baseUrl}}/leads

Returns a list of Lead objects.

Request Params

KeyDatatypeRequiredDescription
cursorstringThe pagination cursor value.
expandstringWhich relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_databooleanWhether to include data that was deleted in the third-party service.
include_remote_databooleanWhether to include the original data Merge fetched from the third-party to produce these models.
page_sizenumberNumber of results to return per page.

HEADERS

KeyDatatypeRequiredDescription
X-Account-Tokenstring(Required) Token identifying the end user.
Acceptstring

RESPONSES

status: OK

{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"urn:uuid:5ef96ab9-582d-7f3b-46e0-bac6173e73fd","remote_id":"19202938","owner":"0358cbc6-2040-430a-848e-aafacbadf3aa","lead_source":"API Blogger","title":"Co-Founder","company":"Merge API","first_name":"Gil","last_name":"Feig","addresses":[{"street_1":"50 Bowling Green Dr","street_2":"Golden Gate Park","city":"San Francisco","state":"CA","postal_code":"94122","country":"USA","address_type":"Shipping"}],"email_addresses":[{"email_address":"hello@merge.dev","email_address_type":"Work"}],"phone_numbers":[{"phone_number":"+16789932455","phone_number_type":"Mobile"}],"remote_updated_at":"2022-02-10T00:00:00Z","remote_created_at":"2021-11-10T00:00:00Z","converted_date":"2022-03-10T00:00:00Z","converted_contact":"urn:uuid:ed25716a-a1bc-af62-2db5-624f2962abaa","converted_account":"9c9de072-29cf-48e3-9578-1ca5b145b40e"},{"id":"urn:uuid:0a54c312-277e-0f65-c5df-58ee695e6054","remote_id":"19202938","owner":"0358cbc6-2040-430a-848e-aafacbadf3aa","lead_source":"API Blogger","title":"Co-Founder","company":"Merge API","first_name":"Gil","last_name":"Feig","addresses":[{"street_1":"50 Bowling Green Dr","street_2":"Golden Gate Park","city":"San Francisco","state":"CA","postal_code":"94122","country":"USA","address_type":"Shipping"}],"email_addresses":[{"email_address":"hello@merge.dev","email_address_type":"Work"}],"phone_numbers":[{"phone_number":"+16789932455","phone_number_type":"Mobile"}],"remote_updated_at":"2022-02-10T00:00:00Z","remote_created_at":"2021-11-10T00:00:00Z","converted_date":"2022-03-10T00:00:00Z","converted_contact":"d92fbe44-e4b3-7a9d-905b-edf8e2f22331","converted_account":"9c9de072-29cf-48e3-9578-1ca5b145b40e"}]}