HomeGuidesAPI ExplorerAnnouncements
API Explorer
AboutContactRev.io

Search customers

get
https://restapi.rev.io/v1/Customers

Search for one or more customers.

Metadata
search.customer_id
array of int32s

Query by customer account identifier.

search.customer_id
search.account_number
array of strings

Query by all or part of customized account identifier.

search.account_number
search.parent_customer_id
array of int32s

Query by parent account identifier.

search.parent_customer_id
boolean

Only return parent accounts, if true.

search.bill_profile_id
array of int32s

Query by bill profile identifier.

search.bill_profile_id
string
enum

Query by status.

Allowed:
string

Query by all or part of name.

date-time

Return only entries created after this date.

date-time

Return only entries created before this date.

search.agent_id
array of int32s

Query by agent identifier.

search.agent_id
date-time

Return only entries updated after this date.

date-time

Return only entries updated before this date.

boolean

Query for customers that are suspended or not.

int32

Defines how many items to return at a time.

int32

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

string

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/html
Updated 7 months ago