Retrieve Agents

get

https://example.com/agents/

Returns a list of Agents applicable to the scope of the API auth token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

agency

integer

Filter via agency ID. Must supply integer value, cannot search by agency name or other field information.

first_name

string

Filter via first name. Wildcards supported. eg. first_name=B% will return all Agents with first names beginning with 'B'. Do not use quotations like first_name="B%".

last_name

string

Filter via last name. Wildcards supported. eg. last_name=B% will return all Agents with last names beginning with 'B'. Do not use quotations like last_name="B%".

string

Filter via email. Wildcards supported. eg. email=B% will return all Agents with emails that beginning with 'B'. Do not use quotations like email="B%".

order_by

string

Order results by a field name. Prefix with - for descending order. eg. order_by=mod_date for ascending or order_by=-mod_date for descending. Must be a valid field on the resource; an invalid field returns a 400 error.

agent_role

string

Filter by agent role. Accepts either an integer role ID or a role name string. Wildcards supported when supplying a name. e.g. agent_role=Admin%.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200search results matching criteria