Skip to content

Get agency details

Request

Returns detailed information about a specific agency, including its users.

Security
bearerAuth
Path
agencyIdintegerrequired
Query
formatstring

Response format. Use tag_document for a simplified format used in document generation.

Value:"tag_document"
curl -i -X GET \
  'https://api-doc.immo-facile.com/_mock/openapi/agencies/{agencyId}?format=tag_document' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

Agency details

Bodyapplication/json
dataobject(AgencyFullResponse)
Response
{
  "data": {
    "id": 0,
    "name": "string",
    "description": "string",
    "model": "string",
    "schedule": "string",
    "is_demo": true,
    "fee_schedule": "string",
    "site_id": 0,
    "site_code": "string",
    "logo": "string",
    "picture": "string",
    "location": { … },
    "phones": { … },
    "emails": { … },
    "details": {},
    "social_links": {},
    "users": [ … ]
  }
}