List
List customers
get/v1/customers
List all customers.
Query Parameters
customer_idsarray of string
optional
Filter the customer list by customer_id. Up to 100 ids can be provided.
ingest_aliasstring
optional
Filter the customer list by ingest_alias
limitnumber
optional
Max number of results that should be returned
minimum1
maximum100
next_pagestring
optional
Cursor that indicates where the next page of results should start.
only_archivedboolean
optional
Filter the customer list to only return archived customers. By default, only active customers are returned.
salesforce_account_idsarray of string
optional
Filter the customer list by salesforce_account_id. Up to 100 ids can be provided.
Returns
dataarray of idstringcreated_atstringcustom_fieldsmapcustomer_configobjectexternal_idstringingest_aliasesarray of stringnamestringarchived_atstringcurrent_billable_statusobjectCustomerDetail
next_pagestring
curl https://api.metronome.com/v1/customers \
-H "Authorization: Bearer $METRONOME_BEARER_TOKEN"
200 Example
{
"data": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"custom_fields": {
"foo": "string"
},
"customer_config": {
"salesforce_account_id": "salesforce_account_id"
},
"external_id": "external_id",
"ingest_aliases": [
"string"
],
"name": "name",
"archived_at": "2019-12-27T18:11:19.117Z",
"current_billable_status": {
"value": "billable",
"effective_at": "2019-12-27T18:11:19.117Z"
}
}
],
"next_page": "next_page"
}