List
List customers
v1.customers.list(CustomerListParams**kwargs) -> SyncCursorPage[idstrcreated_atdatetimecustom_fieldsDict[str, str]customer_configCustomerConfigexternal_idstringest_aliaseslistnamestrarchived_atdatetimecurrent_billable_statusCurrentBillableStatusCustomerDetail]
get/v1/customers
List all customers.
Parameters
customer_idslist
optional
List[str]
Filter the customer list by customer_id. Up to 100 ids can be provided.
ingest_aliasstr
optional
Filter the customer list by ingest_alias
limitint
optional
Max number of results that should be returned
minimum1
maximum100
next_pagestr
optional
Cursor that indicates where the next page of results should start.
Filter the customer list to only return archived customers. By default, only active customers are returned.
salesforce_account_idslist
optional
List[str]
Filter the customer list by salesforce_account_id. Up to 100 ids can be provided.
Returns
idstrcreated_atdatetimecustom_fieldsDict[str, str]customer_configCustomerConfigexternal_idstringest_aliaseslistnamestrarchived_atdatetimecurrent_billable_statusCurrentBillableStatusCustomerDetail
from metronome import Metronome
client = Metronome(
bearer_token="My Bearer Token",
)
page = client.v1.customers.list()
page = page.data[0]
print(page.id)
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"
}