> ## 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.

# Read the agenda across listings

> The viewings, requests and open houses of every listing in the account's agenda, as on the portal's „Agenda” page: your listings, those whose viewings were given to you, a manager's team's and a consultant's projects (their own clients only). By default from today for 14 days, at most 93 days a call, one page at a time. A viewing whose hour has passed has the state `completed` at once. The clients' details and the note from „Cum a fost?” come only to a key with the `leads:read` ability.



## OpenAPI

````yaml en/openapi.json GET /account/viewings
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/viewings:
    get:
      tags:
        - Viewings
      summary: Read the agenda across listings
      description: >-
        The viewings, requests and open houses of every listing in the account's
        agenda, as on the portal's „Agenda” page: your listings, those whose
        viewings were given to you, a manager's team's and a consultant's
        projects (their own clients only). By default from today for 14 days, at
        most 93 days a call, one page at a time. A viewing whose hour has passed
        has the state `completed` at once. The clients' details and the note
        from „Cum a fost?” come only to a key with the `leads:read` ability.
      operationId: v1.viewings.agenda
      parameters:
        - name: from
          in: query
          schema:
            type:
              - string
              - 'null'
            maxLength: 40
          description: >-
            The start of the range: a day (`2026-11-12`, on Romania's clock) or
            a moment with its time zone. By default, today.
        - name: to
          in: query
          schema:
            type:
              - string
              - 'null'
            maxLength: 40
          description: >-
            The end of the range: a day, taken in whole, or a moment with its
            time zone. By default, 14 days after `from`. At most 93 days after
            `from`.
        - name: listing
          in: query
          schema:
            type:
              - string
              - 'null'
            maxLength: 40
          description: >-
            Only the hours of one listing, by its code. A code outside the
            agenda gives an empty list.
        - name: agent
          in: query
          schema:
            type:
              - string
              - 'null'
            format: email
            maxLength: 254
          description: >-
            Only what one colleague runs, by their email. A manager, an admin or
            the owner can name any colleague; anyone else only themselves. An
            email outside the agenda gives an empty list.
        - name: status
          in: query
          schema:
            type:
              - string
              - 'null'
            maxLength: 60
          description: >-
            The viewings' states, comma separated: `pending`, `booked`,
            `completed`, `available`. By default `pending,booked,completed`.
            `available` needs `listing`.
        - name: kind
          in: query
          schema:
            type:
              - string
              - 'null'
            enum:
              - viewing
              - open_house
              - null
          description: '`viewing` or `open_house`. Without it, both.'
        - name: per_page
          in: query
          schema:
            type:
              - integer
              - 'null'
            minimum: 1
            maximum: 100
          description: Results per page (default 50, maximum 100).
        - name: cursor
          in: query
          schema:
            type:
              - string
              - 'null'
          description: >-
            The next page's cursor, from `meta.next_cursor`, sent exactly as you
            received it. Any other value gets 422 (`pagination_cursor`).
        - 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/ViewingSlotApiResource'
                    description: The result of the request.
                  links:
                    type: object
                    properties:
                      first:
                        type:
                          - string
                          - 'null'
                        description: The first page's URL.
                      last:
                        type:
                          - string
                          - 'null'
                        description: The last page's URL (null with cursor pagination).
                      prev:
                        type:
                          - string
                          - 'null'
                        description: The previous page's URL, or null.
                      next:
                        type:
                          - string
                          - 'null'
                        description: >-
                          The next page: its URL, or the cursor to pass on. Null
                          when there is nothing left.
                    required:
                      - first
                      - last
                      - prev
                      - next
                    description: Pagination links.
                  meta:
                    type: object
                    properties:
                      path:
                        type:
                          - string
                          - 'null'
                        description: The list's base URL.
                      per_page:
                        type: integer
                        minimum: 0
                        description: Results per page.
                      next_cursor:
                        type:
                          - string
                          - 'null'
                        description: The next page's cursor; null when the list has ended.
                      prev_cursor:
                        type:
                          - string
                          - 'null'
                        description: The previous page's cursor; null on the first page.
                      pending_requests:
                        type: integer
                        minimum: 0
                        description: >-
                          How many viewing requests wait for your answer. A
                          request you answered with another time waits for the
                          client and is not counted.
                      next_at:
                        type:
                          - string
                          - 'null'
                        description: >-
                          The next viewing or request in the agenda, whatever
                          the range asked for. Null when nothing is coming.
                    required:
                      - path
                      - per_page
                      - next_cursor
                      - prev_cursor
                      - pending_requests
                      - next_at
                    description: >-
                      Data about the response, outside the result, for example a
                      list's pagination.
                required:
                  - data
                  - links
                  - meta
          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`).
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationProblem'
          description: >-
            The data fails the rules: one entry per field in `errors[]`, each
            with a stable `code`.
        '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:
    ViewingSlotApiResource:
      type: object
      properties:
        id:
          anyOf:
            - type: integer
            - []
          description: >-
            The event ID (ULID, increasing). Send it as `after` to continue
            where you left off.
        kind:
          anyOf:
            - type: string
              enum:
                - viewing
                - open_house
            - []
          description: Type.
        starts_at:
          anyOf:
            - type: string
            - []
          description: Start time.
        ends_at:
          anyOf:
            - type: string
            - []
          description: End time.
        status:
          anyOf:
            - type: string
              const: completed
            - []
          description: >-
            `available`, `pending`, `booked` or `completed` (a booked viewing
            whose hour has passed).
        request_expires_at:
          anyOf:
            - type:
                - string
                - 'null'
            - []
          description: >-
            When you have to answer a request by. After it, the request expires
            and the time is free again. Null when the time is not requested.
        visitor:
          anyOf:
            - anyOf:
                - type: object
                  properties:
                    name:
                      type:
                        - string
                        - 'null'
                      description: Name.
                    email:
                      type: 'null'
                      description: The client's email, if they have one.
                    phone:
                      type:
                        - string
                        - 'null'
                      description: Phone.
                    account:
                      type: boolean
                      description: >-
                        `true`: the client has a Housera account. `false`: you
                        added them by hand and they have no email.
                  required:
                    - name
                    - email
                    - phone
                    - account
                - type: 'null'
                - type: object
                  properties:
                    name:
                      type: string
                      description: Name.
                    email:
                      type: string
                      description: The client's email, if they have one.
                    phone:
                      type:
                        - string
                        - 'null'
                      description: Phone.
                    account:
                      type: boolean
                      description: >-
                        `true`: the client has a Housera account. `false`: you
                        added them by hand and they have no email.
                  required:
                    - name
                    - email
                    - phone
                    - account
                - type: object
                  properties:
                    name:
                      type: string
                      description: Name.
                    email:
                      type: string
                      description: The client's email, if they have one.
                    phone:
                      type:
                        - string
                        - 'null'
                      description: Phone.
                  required:
                    - name
                    - email
                    - phone
            - []
          description: >-
            The client: `name`, `email`, `phone` and `account`. Only for a key
            with the `leads:read` ability, otherwise null. The name and phone of
            a client added by hand are erased 90 days after the viewing.
        source:
          anyOf:
            - type: string
              enum:
                - schedule
                - manual
            - []
          description: >-
            `schedule`: the hour was generated by the weekly schedule. `manual`:
            it was put in by hand.
        duration_min:
          anyOf:
            - type: integer
            - []
          description: 'How long a viewing lasts, in minutes: 15, 30, 45, 60 or 90.'
        held:
          anyOf:
            - type: boolean
            - []
          description: >-
            The hour is kept for a short while for someone signing in to book
            it. While it is kept, nobody else can book it.
        bookable:
          anyOf:
            - type: string
            - []
          description: >-
            On a free hour: whether a client can book it now (the notice,
            whoever runs the viewings is not busy at another listing, the hour
            is not kept). Null on the other hours.
        booked_at:
          anyOf:
            - type:
                - string
                - 'null'
            - []
          description: When the hour was booked or asked for.
        proposed_starts_at:
          anyOf:
            - type:
                - string
                - 'null'
            - []
          description: >-
            The hour proposed to the client instead of the booked one, while it
            waits for their answer. Null otherwise.
        attendance_confirmed_at:
          anyOf:
            - type:
                - string
                - 'null'
            - []
          description: When the client answered „Da, vin” to the reminder.
        reminded_day_at:
          anyOf:
            - type:
                - string
                - 'null'
            - []
          description: When the client was sent the reminder on the day before.
        reminded_soon_at:
          anyOf:
            - type:
                - string
                - 'null'
            - []
          description: When the client was sent the reminder two hours before.
        outcome:
          anyOf:
            - type:
                - string
                - 'null'
              enum:
                - offer
                - again
                - not_interested
                - no_show
                - null
            - []
          description: >-
            The answer to „Cum a fost?”: `offer`, `again`, `not_interested` or
            `no_show`. Null until it is given.
        outcome_at:
          anyOf:
            - type:
                - string
                - 'null'
            - []
          description: When „Cum a fost?” was answered.
        agent:
          anyOf:
            - type:
                - object
                - 'null'
              properties:
                name:
                  type: string
                  description: >-
                    The name of the agent's account. The portal shows the name
                    in `display_name`.
                email:
                  type:
                    - string
                    - 'null'
                  description: >-
                    The agent's email; `null` when we have no real address for
                    them, for example a colleague who came from a CRM with no
                    email on their team record.
              required:
                - name
                - email
            - []
          description: >-
            Who meets the client: the consultant the booking went to on a
            project, otherwise whoever runs the listing's viewings. `name` and
            `email`.
        place:
          anyOf:
            - type:
                - string
                - 'null'
              enum:
                - office
                - show_flat
                - unit
                - null
            - []
          description: >-
            On a developer's project, where the client is met: `office`,
            `show_flat` or `unit`. Null elsewhere.
        place_rooms:
          anyOf:
            - type:
                - integer
                - 'null'
            - []
          description: >-
            On a developer's project: how many rooms the flat the client wants
            to see has.
        seat:
          anyOf:
            - type: integer
            - []
          description: >-
            On a developer's project, the hour's place: one for each consultant,
            with the same `starts_at`. 0 elsewhere.
      required:
        - id
        - kind
        - starts_at
        - ends_at
        - status
        - request_expires_at
        - visitor
        - source
        - duration_min
        - held
        - bookable
        - booked_at
        - proposed_starts_at
        - attendance_confirmed_at
        - reminded_day_at
        - reminded_soon_at
        - outcome
        - outcome_at
        - agent
        - place
        - place_rooms
        - seat
      additionalProperties: {}
      title: ViewingSlotApiResource
    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
    ValidationProblem:
      type: object
      title: ValidationProblem
      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: `422`.'
        errors:
          type: array
          items:
            type: object
            properties:
              pointer:
                type: string
                description: The field it refers to, as a JSON Pointer (`/features/2`).
              code:
                type: string
                description: >-
                  The rule that failed, as a stable code (the list is on the
                  Errors page).
              detail:
                type: string
                description: >-
                  The explanation, in the request's language. The wording can
                  change, so handle the error by `code`.
            required:
              - pointer
              - code
              - detail
          description: One entry for each field that fails the rules.
      required:
        - type
        - title
        - status
        - errors
  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.