HomeGuidesAPI ExplorerAnnouncements
API Explorer
AboutContactRev.io

Search agents

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

Search for one or more agents.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Metadata
search.agent_id
array of int32s

Query by agent identifier.

search.agent_id
search.parent_agent_id
array of int32s

Query by parent agent identifier.

search.parent_agent_id
search.agent_type_id
array of int32s

Query by foreign identifier indicating the type of agent.

search.agent_type_id
search.default_commission_plan_id
array of int32s

Query by foreign identifier indicating the commission plan assigned to the agent.

search.default_commission_plan_id
search.address_id
array of int32s

Query by foreign identifier indicating the address for this agent.

search.address_id
search.account_number
array of strings

Query by customizable account identifier.

search.account_number
search.name
array of strings

Query by name of the agent or agency.

search.name
search.email
array of strings

Query by primary contact email address(es).

search.email
search.phone
array of strings

Query by primary contact phone number.

search.phone
search.fax
array of strings

Query by primary contact fax number.

search.fax
search.status
array of strings

Query by current status of the agent.

search.status
search.tax_identification_number
array of strings

Query by tax identification number (e.g. SSN, EIN).

search.tax_identification_number
search.company_bill_profile_id
array of int32s

Query by foreign identifier indicating the bill profile associated with this agent.

search.company_bill_profile_id
date-time

Search for agents created after this date.

date-time

Search for agents created before this date.

search.created_by
array of int32s

Query by foreign identifier indicating the user who created this agent.

search.created_by
search.logo_file_id
array of int32s

Query by foreign identifier indicating the file that contains the agent logo.

search.logo_file_id
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
:
LoadingLoading…
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