GET
/
v1
/
customers
List customers
curl --request GET \
  --url https://api.metronome.com/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
      "external_id": "team@example.com",
      "created_at": "2024-01-01T00:00:00.000Z",
      "ingest_aliases": [
        "team@example.com"
      ],
      "name": "Example, Inc.",
      "customer_config": {
        "salesforce_account_id": "0015500001WO1ZiABL"
      },
      "custom_fields": {
        "x_account_id": "KyVnHhSBWl7eY2bl"
      }
    }
  ],
  "next_page": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer

Max number of results that should be returned

Required range: 1 <= x <= 100
​
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.

​
only_archived
boolean

Filter the customer list to only return archived customers. By default, only active customers are returned.

​
salesforce_account_ids
string[]

Filter the customer list by salesforce_account_id. Up to 100 ids can be provided.

Maximum length: 100

Response

200 - application/json

Success

The response is of type object.