List customers
GET {{baseUrl}}/customers?limit=<integer>&next_page=<string>&ingest_alias=<string>&customer_ids=<string>&customer_ids=<string>&only_archived=<boolean>&salesforce_account_ids=<string>&salesforce_account_ids=<string>
List all customers.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | string | Max number of results that should be returned | |
next_page | string | Cursor that indicates where the next page of results should start. | |
ingest_alias | string | Filter the customer list by ingest_alias | |
customer_ids | string | Filter the customer list by customer_id. Up to 100 ids can be provided. | |
customer_ids | string | Filter the customer list by customer_id. Up to 100 ids can be provided. | |
only_archived | string | Filter the customer list by only archived customers. | |
salesforce_account_ids | string | Filter the customer list by salesforce_account_id. Up to 100 ids can be provided. | |
salesforce_account_ids | string | Filter the customer list by salesforce_account_id. Up to 100 ids can be provided. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"external_id":"\u003cstring\u003e","id":"\u003cuuid\u003e","name":"\u003cstring\u003e","customer_config":{"salesforce_account_id":"\u003cstring\u003e"},"ingest_aliases":["\u003cstring\u003e","\u003cstring\u003e"],"custom_fields":{"labore06":"\u003cstring\u003e"},"current_billable_status":{"value":"billable","effective_at":"\u003cdateTime\u003e"}},{"external_id":"\u003cstring\u003e","id":"\u003cuuid\u003e","name":"\u003cstring\u003e","customer_config":{"salesforce_account_id":"\u003cstring\u003e"},"ingest_aliases":["\u003cstring\u003e","\u003cstring\u003e"],"custom_fields":{"minim_25":"\u003cstring\u003e","adbb":"\u003cstring\u003e","Ut_5b":"\u003cstring\u003e"},"current_billable_status":{"value":"billable","effective_at":"\u003cdateTime\u003e"}}],"next_page":"\u003cstring\u003e"}