v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
CustomersOptimized

Search customers optimized

Search for one or more customers optimized

get/v1/CustomersOptimized

Query parameters

search.customer_idinteger[]

Query by customer account identifier.

search.parent_customer_idinteger[]

Query by parent account identifier.

search.account_numberstring[]

Query by all or part of customized account identifier.

search.agent_idinteger[]

Query by agent identifier.

search.is_parentboolean

Only return parent accounts, if true.

search.bill_profile_idinteger[]

Query by bill profile identifier.

search.status'ALL' | 'PROSPECT' | 'PENDING' | 'CLOSED' | 'OPEN'

Query by status.

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Return only entries created after this date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Return only entries created before this date.

search.updated_date_startstring date-time

Format - date-time (as date-time in RFC3339). Return only entries updated after this date.

search.updated_date_endstring date-time

Format - date-time (as date-time in RFC3339). Return only entries updated before this date.

search.suspendedboolean

Query for customers that are suspended or not.

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.