RErev-io
Customers

Search customers

Changed on

Search for one or more customers.

get/v1/Customers

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

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.

Changes

  • f175f5a3b11dRevision changes
    • warning

      added the new ANT enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: text/html)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: text/html)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: text/html)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: text/html)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: text/html)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: text/html)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: text/html)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: text/html)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: text/html)