# Get agency details

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

Endpoint: GET /agencies/{agencyId}
Version: 1.6.0
Security: bearerAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer opaque

## Path parameters:

  - `agencyId` (integer, required)

## Response 200:

  - `200` (unknown)
    Agency details

## Response 200 fields (application/json):

  - `data` (object)

  - `data.id` (integer)

  - `data.name` (string | null)

  - `data.description` (string | null)

  - `data.model` (string | null)

  - `data.schedule` (string | null)

  - `data.is_demo` (boolean)

  - `data.fee_schedule` (string | null)
    Fee schedule image URL

  - `data.site_id` (integer | null)

  - `data.site_code` (string | null)

  - `data.logo` (string | null)
    Logo URL

  - `data.picture` (string | null)
    Agency photo URL

  - `data.location` (object)

  - `data.location.address` (string | null)

  - `data.location.zip_code` (string | null)

  - `data.location.city` (string | null)

  - `data.location.coordinates` (object | null)

  - `data.location.coordinates.latitude` (number)

  - `data.location.coordinates.longitude` (number)

  - `data.phones` (object)

  - `data.phones.phone` (string | null)

  - `data.phones.phone_location` (string | null)

  - `data.emails` (object)

  - `data.emails.email` (string | null)

  - `data.emails.email_leasing` (string | null)

  - `data.details` (object | null)
    Agency detail information

  - `data.social_links` (object | null)
    Social media links

  - `data.users` (array | null)
    List of users (agents) attached to the agency

  - `data.users.id` (integer)

  - `data.users.firstname` (string | null)

  - `data.users.lastname` (string | null)

  - `data.users.email` (string | null)

  - `data.users.phone` (string | null)

  - `data.users.mobile_phone` (string | null)

  - `data.users.status` (integer | null)

  - `data.users.picture` (string | null)

## Response 403:

  - `403` (unknown)
    Access denied. The error `code` is always `FORBIDDEN`; the `message` gives the cause:
- `You do not have permission to perform this action.`
 — the access does not

hold the API pack / right required by the endpoint.
- `Insufficient scope for this request.`
 — the resource targeted by the request

(user, customer, product, agency, transaction, ...) is outside the scope of

the authenticated access.
- `Access denied for this editor.`
 /
`Your IP address has been blocked.`
 —

editor or IP restriction.

## Response 403 fields (application/json):

  - `error` (object)

  - `error.code` (string, required)

  - `error.message` (string, required)

## Response 403 examples:

  - `Missing API pack / right` (unknown)

  - `Resource outside the scope of the access` (unknown)

