Search external agents

POSThttp://localhost:4000/api/externalAgents/search

Returns a list of external agents, with only the fields you ask for.

Your API key needs the externalAgents.VIEW permission.

Body Params

fieldsarray of stringrequired

The fields to return. Required.

filtersarray of object

Conditions to match. Items in the array are combined with OR, and fields inside one item with AND. See the Filtering guide.

orderByobject

Field to sort by. The field must also be listed in fields.

limitinteger

How many records to return. Always set this, because leaving it out can return every record.

offsetinteger

How many records to skip.

Responses

200Successful response.

400The request is not valid.

401The API key is missing, invalid, expired or disabled.

403The API key does not have the permission this endpoint needs.

Language

Credentials

Bearer

Kept in this browser tab and sent only to the Estactics API. Requests act on your real data.

cURL Request

curl --request POST \
  --url http://localhost:4000/api/externalAgents/search \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"fields":["id","fullName","company"],"limit":25}'

Response

Click Try It! to send a request and see the response here, or choose an example: