List
List customers
v1.customers.list(**kwargs) -> CursorPage<idStringcreated_atTimecustom_fieldshashcustomer_configobjectexternal_idStringingest_aliasesarraynameStringarchived_atTimecurrent_billable_statusobjectCustomerDetail>
get/v1/customers
List all customers.
Parameters
customer_idsarray
optional
Array[String]
Filter the customer list by customer_id. Up to 100 ids can be provided.
ingest_aliasString
optional
Filter the customer list by ingest_alias
limitInteger
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_archivedbool
optional
Filter the customer list to only return archived customers. By default, only active customers are returned.
salesforce_account_idsarray
optional
Array[String]
Filter the customer list by salesforce_account_id. Up to 100 ids can be provided.
Returns
idStringcreated_atTimecustom_fieldshashcustomer_configobjectexternal_idStringingest_aliasesarraynameStringarchived_atTimecurrent_billable_statusobjectCustomerDetail
require "metronome_sdk"
metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")
page = metronome.v1.customers.list
puts(page)
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"
}