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

# List the organization's public clinician profiles and next availability

> Lists active clinician profiles selected for the organization's site, sorted by name. Use the numeric organization ID from the branding response. Each profile includes a location when available and the first available weekday through Sunday, or null when there is no remaining availability that week. Availability accounts for agenda configuration, busy intervals, pending requests, and organization closures.



## OpenAPI

````yaml /openapi/nimbo_public.yml get /api/v1/sites/organizations/{id}/accounts
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/sites/organizations/{id}/accounts:
    get:
      tags:
        - Sites
      summary: List the organization's public clinician profiles and next availability
      description: >-
        Lists active clinician profiles selected for the organization's site,
        sorted by name. Use the numeric organization ID from the branding
        response. Each profile includes a location when available and the first
        available weekday through Sunday, or null when there is no remaining
        availability that week. Availability accounts for agenda configuration,
        busy intervals, pending requests, and organization closures.
      operationId: listSiteOrganizationAccounts
      parameters:
        - name: id
          in: path
          required: true
          description: Numeric organization ID, not its site slug or encoded domain.
          schema:
            type: integer
          example: 123
        - name: from
          in: query
          description: >-
            Inclusive availability range start; used only together with to.
            Defaults to the current week.
          schema:
            type: string
          example: '2026-09-14T00:00:00-06:00'
        - name: to
          in: query
          description: >-
            Inclusive range end; used only together with from. Subject to the
            stored weeks limit.
          schema:
            type: string
          example: '2026-09-20T23:59:59-06:00'
        - name: date
          in: query
          description: >-
            cutoff that ignores appointments and requests starting after this
            time; does not choose the returned weekday. Permanent schedules also
            apply it to closures.
          schema:
            type: string
          example: '2026-09-14T12:00:00-06:00'
        - name: encounter_type_id
          in: query
          deprecated: true
          description: >-
            unsupported branch. A missing encounter type returns 404; an
            existing type fails because reads metadata while storage uses
            configuration. Sites does not send this parameter.
          schema:
            type: integer
          example: 456
        - name: access_token
          in: query
          description: >-
            Optional token selecting its owner's timezone. Authorization Bearer
            takes precedence. Does not authorize protected data.
          schema:
            type: string
            writeOnly: true
        - name: bearer_token
          in: query
          description: >-
            Optional timezone token fallback after Authorization Bearer and
            access_token.
          schema:
            type: string
            writeOnly: true
      responses:
        '200':
          description: >-
            Selected clinician profiles; data is empty when no account
            qualifies.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - type
                        - attributes
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                          example: '456'
                        type:
                          type: string
                          enum:
                            - account
                        attributes:
                          type: object
                          required:
                            - name
                            - slug
                            - cellphone
                            - bio
                            - specialty_names
                            - location
                            - avatar_url
                            - availability
                            - username
                            - available_hour
                          additionalProperties: false
                          properties:
                            name:
                              type:
                                - string
                                - 'null'
                              example: Demo Doctor
                            slug:
                              type:
                                - string
                                - 'null'
                              example: demo-doctor-profile
                            cellphone:
                              type:
                                - string
                                - 'null'
                              example: '+525550100'
                            bio:
                              type:
                                - string
                                - 'null'
                              example: Synthetic public profile
                            specialty_names:
                              anyOf:
                                - type: object
                                  required:
                                    - name_es
                                    - name_en
                                  additionalProperties: false
                                  properties:
                                    name_es:
                                      type:
                                        - string
                                        - 'null'
                                      example: Medicina general
                                    name_en:
                                      type:
                                        - string
                                        - 'null'
                                      example: General medicine
                                - type: 'null'
                            location:
                              anyOf:
                                - type: object
                                  required:
                                    - id
                                    - name
                                    - organization_id
                                    - created_at
                                    - updated_at
                                    - office_attributes
                                    - state_id
                                    - deleted_at
                                    - metadata
                                    - active
                                    - google_booking_enabled
                                  additionalProperties: false
                                  properties:
                                    id:
                                      type: integer
                                      example: 789
                                    name:
                                      type:
                                        - string
                                        - 'null'
                                      example: Main Office
                                    organization_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 123
                                    created_at:
                                      type: string
                                      example: '2026-01-01T06:00:00.000-06:00'
                                    updated_at:
                                      type: string
                                      example: '2026-01-01T06:00:00.000-06:00'
                                    office_attributes:
                                      type: object
                                      additionalProperties: true
                                      example:
                                        office_city: Test City
                                    state_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 321
                                    deleted_at:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    metadata:
                                      type: object
                                      additionalProperties: true
                                    active:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    google_booking_enabled:
                                      type: boolean
                                      example: false
                                - type: 'null'
                            avatar_url:
                              description: >-
                                Original account attachment as a signed S3 GET
                                URL valid for 3600 seconds; empty when
                                unavailable. Refresh before expiry rather than
                                persisting the URL. Example uses a synthetic
                                nonfunctional signature.
                              type: string
                              example: >-
                                https://synthetic-assets.s3.amazonaws.com/accounts/avatars/000/000/456/original/avatar.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=synthetic-key%2F20261001%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20261001T120000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0000000000000000000000000000000000000000000000000000000000000000
                            availability:
                              anyOf:
                                - type: object
                                  additionalProperties: true
                                - type: 'null'
                              example:
                                mon:
                                  - 08:00-12:00
                                consultation_duration: 30
                            username:
                              type:
                                - string
                                - 'null'
                              example: demo-doctor
                            available_hour:
                              description: >-
                                Next slot for the organization list; null for
                                standalone profile lookup.
                              anyOf:
                                - type: 'null'
                                - type: object
                                  additionalProperties: false
                                  required:
                                    - day
                                    - hour
                                  properties:
                                    day:
                                      type: string
                                      enum:
                                        - mon
                                        - tue
                                        - wed
                                        - thu
                                        - fri
                                        - sat
                                        - sun
                                    hour:
                                      type: string
                                      pattern: ^(0[1-9]|1[0-2]):[0-5][0-9] (am|pm)$
                                  example:
                                    day: tue
                                    hour: 08:00 am
                example:
                  data: []
        '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
        '500':
          description: >-
            malformed agenda or unsupported encounter type duration lookup; no
            stable error body contract.
      security: []

````

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