v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Agents

Search agents

Search for one or more agents.

get/v1/Agents

Query parameters

search.agent_idinteger[]

Query by agent identifier.

search.parent_agent_idinteger[]

Query by parent agent identifier.

search.agent_type_idinteger[]

Query by foreign identifier indicating the type of agent.

search.default_commission_plan_idinteger[]

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

search.address_idinteger[]

Query by foreign identifier indicating the address for this agent.

search.account_numberstring[]

Query by customizable account identifier.

search.namestring[]

Query by name of the agent or agency.

search.emailstring[]

Query by primary contact email address(es).

search.phonestring[]

Query by primary contact phone number.

search.faxstring[]

Query by primary contact fax number.

search.statusstring[]

Query by current status of the agent.

search.tax_identification_numberstring[]

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

search.company_bill_profile_idinteger[]

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

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Search for agents created after this date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Search for agents created before this date.

search.created_byinteger[]

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

search.logo_file_idinteger[]

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

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.