> ## Documentation Index
> Fetch the complete documentation index at: https://api.housera.ro/llms.txt
> Use this file to discover all available pages before exploring further.

# The offices

> The company's offices, as on the portal's Offices page: the head office first, then the others by name, with the address, contact details and how many colleagues work there. A developer has no offices, so its list is empty. Requires the `listings:read` permission.



## OpenAPI

````yaml en/openapi.json GET /account/offices
openapi: 3.1.2
info:
  title: Housera API
  version: 1.0.0
  description: >-
    Publish and manage real estate listings on Housera from your CRM or your own
    application, under the same rules as the form on the Housera portal.
servers:
  - url: https://staging.housera.ro/api/v1
    description: 'Sandbox (staging): test data, same rules as production.'
  - url: https://housera.ro/api/v1
    description: 'Production: the real listings on housera.ro.'
security:
  - bearer: []
tags:
  - name: Your listings
  - name: Photos
  - name: Events
  - name: Vocabulary
  - name: Connect with Housera
  - name: Client requests
  - name: The company and its team
  - name: Marketing mandates
  - name: Viewings
  - name: Projects
  - name: Partnerships
  - name: API key
  - name: Statistics
paths:
  /account/offices:
    get:
      tags:
        - The company and its team
      summary: The offices
      description: >-
        The company's offices, as on the portal's Offices page: the head office
        first, then the others by name, with the address, contact details and
        how many colleagues work there. A developer has no offices, so its list
        is empty. Requires the `listings:read` permission.
      operationId: v1.firm.offices
      parameters:
        - name: locale
          in: query
          required: false
          schema:
            type: string
            enum:
              - ro
              - en
            default: en
          example: en
          description: >-
            The response language, `ro` or `en`. It changes error messages
            (`title`, `detail`), labels and, when the listing has an approved
            translation in that language, its title and description. Codes are
            the same in every language. It takes precedence over
            `Accept-Language` and over the account's language.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OfficeApiResource'
                    description: The result of the request.
                required:
                  - data
          description: The request succeeded.
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: The key is missing, revoked or expired (`unauthenticated`).
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: >-
            The key lacks the required permission (`missing_ability`) or access
            is denied (`forbidden`).
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: >-
            Too many requests. Try again after the number of seconds in
            `Retry-After`.
components:
  schemas:
    OfficeApiResource:
      type: object
      properties:
        id:
          type: integer
          description: The office's id. Send it as `office` to `GET /leads`.
        name:
          type: string
          description: The office's name.
        kind:
          type: string
          description: '`main` for the head office, `branch` for the others.'
        address:
          type: object
          properties:
            street:
              type:
                - string
                - 'null'
              description: The street.
            number:
              type:
                - string
                - 'null'
              description: The number.
            city:
              type:
                - string
                - 'null'
              description: The town or city.
            county:
              type:
                - string
                - 'null'
              description: The county.
            postal_code:
              type:
                - string
                - 'null'
              description: The postal code.
            country:
              type:
                - string
                - 'null'
              description: The country (ISO 3166-1 alpha-2).
          required:
            - street
            - number
            - city
            - county
            - postal_code
            - country
          description: The office's address, in parts.
        phone:
          type:
            - string
            - 'null'
          description: The office's phone, in international format.
        email:
          type:
            - string
            - 'null'
          description: The office's email.
        members:
          type: integer
          description: How many colleagues work there now, not counting deactivated ones.
      required:
        - id
        - name
        - kind
        - address
        - phone
        - email
        - members
      title: OfficeApiResource
    Problem:
      type: object
      title: Problem
      properties:
        type:
          type: string
          format: uri
          description: The URL of the problem type (RFC 9457).
        title:
          type: string
          description: A short summary of the problem, in the request's language.
        status:
          type: integer
          description: The HTTP status code.
        code:
          type: string
          description: >-
            The stable code of the refusal, the one to handle the error by (the
            list is on the Errors page).
        detail:
          type: string
          description: The explanation, in the request's language.
        existing:
          type: object
          properties:
            code:
              type: string
              description: The existing listing's public code.
            external_ref:
              type:
                - string
                - 'null'
              description: >-
                Your ID for the existing listing, if you set it with `PUT
                /listings/ref/{ref}`. Otherwise `null`.
          required:
            - code
            - external_ref
          description: >-
            Only on `409 duplicate_listing`: the listing you already have for
            the same property.
      required:
        - type
        - title
        - status
        - code
        - detail
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer <key>'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.