Customers

View a customer metadata

Changed on

Find customer metadata by search model

get/v1/Customers/Metadata

Request

Query parameters

search.customer_idinteger[]

Query by customer account identifier.

search.account_numberstring[]

Query by all or part of customized account identifier.

search.parent_customer_idinteger[]

Query by parent account 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.namestring

Query by all or part of name.

search.created_date_startstring date-time

Return only entries created after this date.

search.created_date_endstring date-time

Return only entries created before this date.

search.agent_idinteger[]

Query by agent identifier.

search.updated_date_startstring date-time

Return only entries updated after this date.

search.updated_date_endstring date-time

Return only entries updated before this date.

search.suspendedboolean

Query for customers that are suspended or not.

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

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

customer_IDinteger

Primary identifier for this customer.

namestring

friendly name of the customer

account_numberstring

Customizable account identifier.

Changes

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type text/html for the response with the status

    • breaking

      removed the media type text/html for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • breaking

      removed the media type text/json for the response with the status