Existing Casafari API · API v1 · References
Get agents
GET
https://api.casafari.com/v1/references/agentsStatic token1 parameterAPI v1
Send Authorization: Token $CASAFARI_TOKEN with your existing API token; see where to get it.
The same path under /api, signed in with a bearer token, is in the REST API reference: GET /api/v1/references/agents.
Description
Returns a list of all possible agents with user restrictions.
Query parameters
namestringrequiredA name of the agent to search.
Example request
Placeholders only: replace the token and the values with your own.
curl "https://api.casafari.com/v1/references/agents?name=<name>" \
-H "Authorization: Token $CASAFARI_TOKEN"Responses
200
Type: object[].
Show the response shape (1 fields)
agentsstring[]requiredThe list of suggested agents.
Example from the API description
{
"agents": [
"Paulo Diogo",
"Paulo Costa"
]
}401 Unauthorized
Type: object.
Show the response shape (1 fields)
detailstringDescription of the error encountered.
403 Forbidden
Type: object.
Show the response shape (1 fields)
detailstringDescription of the error encountered.