> ## Documentation Index
> Fetch the complete documentation index at: https://dev.nimbo-x.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Resolve the location for a public booking agenda

> Resolves organization-schedule or personal-account locations within the requested organization. Missing or unmatched slugs fall back to that organization's owner location, matching the booking flow. A matched personal account without a location returns location: null instead of selecting the owner's location. An owner without a location also returns null.



## OpenAPI

````yaml /openapi/nimbo_public.yml get /api/v1/portals/locations/agenda
openapi: 3.1.0
info:
  title: Nimbo catalogs and sites
  version: 0.1.0
  description: >-
    Nimbo API reference. Use the API host and integration access provided by
    Nimbo.
servers:
  - url: https://api.example.test
    description: Reference only; not a live API host
security: []
tags:
  - name: Countries
  - name: Catalogs
  - name: SAT Catalogs
  - name: Sites
  - name: Public Portals
  - name: Telehealth
paths:
  /api/v1/portals/locations/agenda:
    get:
      tags:
        - Public Portals
      summary: Resolve the location for a public booking agenda
      description: >-
        Resolves organization-schedule or personal-account locations within the
        requested organization. Missing or unmatched slugs fall back to that
        organization's owner location, matching the booking flow. A matched
        personal account without a location returns location: null instead of
        selecting the owner's location. An owner without a location also returns
        null.
      operationId: showPortalAgendaLocation
      parameters:
        - name: organization_id
          in: query
          required: true
          schema:
            type: integer
          example: 123
        - name: agenda_type
          in: query
          required: false
          schema:
            type: string
            enum:
              - organization
              - personal
          example: personal
        - name: slug
          in: query
          required: false
          schema:
            type: string
          example: demo-doctor
      responses:
        '200':
          description: Public booking location.
          content:
            application/json:
              schema:
                type: object
                required:
                  - location
                additionalProperties: false
                properties:
                  location:
                    anyOf:
                      - type: 'null'
                      - type: object
                        required:
                          - id
                          - name
                          - state_id
                          - office_city
                          - office_name
                          - office_address
                          - office_telephone
                          - office_zipcode
                          - optional_charge
                          - metadata
                          - state_name
                          - google_booking_enabled
                          - google_business_name
                        additionalProperties: false
                        properties:
                          id:
                            type: integer
                            example: 789
                          name:
                            type:
                              - string
                              - 'null'
                            example: Main Office
                          state_id:
                            type:
                              - integer
                              - 'null'
                            example: 321
                          office_city:
                            type:
                              - string
                              - 'null'
                          office_name:
                            type:
                              - string
                              - 'null'
                          office_address:
                            type:
                              - string
                              - 'null'
                          office_telephone:
                            type:
                              - string
                              - 'null'
                          office_zipcode:
                            type:
                              - string
                              - 'null'
                          optional_charge:
                            type: boolean
                            example: false
                          metadata:
                            type: object
                            additionalProperties: true
                          state_name:
                            type:
                              - string
                              - 'null'
                          google_booking_enabled:
                            type: boolean
                            example: false
                          google_business_name:
                            type:
                              - string
                              - 'null'
        '404':
          description: >-
            The requested resource was not found or is outside the authorized
            patient scope.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                additionalProperties: false
                properties:
                  error:
                    type: string
              examples:
                not_found:
                  value:
                    error: Not found

````

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