Existing Casafari API · API v1 · References
Get agencies
GET
https://api.casafari.com/v1/references/agenciesStatic 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/agencies.
Description
Returns a list of all possible agencies with user restrictions.
Query parameters
namestringrequiredA name of the agency to search.
Example request
Placeholders only: replace the token and the values with your own.
curl "https://api.casafari.com/v1/references/agencies?name=<name>" \
-H "Authorization: Token $CASAFARI_TOKEN"Responses
200
Type: object[].
Show the response shape (3 fields)
namestringrequiredName of the agency.
agency_typestringrequiredType of the agency.
source_idsinteger[]requiredList of source IDs that belongs to the agency.
Example from the API description
{
"agencies": [
{
"name": "ComprarCasa Guimarães & Guimarães Centro",
"agency_type": "company",
"source_ids": [
1616,
2492
]
},
{
"name": "ComprarCasa Setúbal Estádio",
"agency_type": "company",
"source_ids": [
1616
]
}
]
}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.