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

# List sites

> List your organization's sites.



## OpenAPI

````yaml /openapi.json get /sites
openapi: 3.1.0
info:
  title: OpenLoop API
  version: 0.1.0
  description: >-
    Unified reference for the OpenLoop Patient (clinical) and Payments & Revenue
    APIs.
servers:
  - url: https://api.openloophealth.com/v0.1
    description: Production partner edge
  - url: https://api-staging.openloophealth.com/v0.1
    description: Staging partner edge (sandbox credentials)
security: []
paths:
  /sites:
    get:
      tags:
        - Sites
      summary: List sites
      description: List your organization's sites.
      parameters:
        - schema:
            type: string
            maxLength: 2048
            pattern: ^[A-Za-z0-9_-]+$
          required: false
          name: cursor
          in: query
          description: >-
            Opaque pagination token. Pass back the `after` (next page) or
            `before` (previous page) value from a prior response's envelope to
            fetch that page. Do not construct or decode it.
        - schema:
            anyOf:
              - type: integer
              - type: string
                pattern: ^\d+$
          required: false
          name: limit
          in: query
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Site'
                  after:
                    type: string
                    description: >-
                      Forward pagination cursor. Present when more results
                      follow; absent on the last page. To fetch the next page,
                      send this exact value back as the `cursor` query parameter
                      (note the different name) — do not send it as `after`.
                      Opaque; do not construct or decode it.
                  before:
                    type: string
                    description: >-
                      Backward pagination cursor for the previous page, when
                      available. Send this value back as the `cursor` query
                      parameter (same `cursor` param as forward paging; there is
                      no separate `before` parameter). Opaque; do not construct
                      or decode it.
                  request_id:
                    type: string
                required:
                  - items
                  - request_id
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - serviceToken: []
        - userToken: []
components:
  schemas:
    Site:
      type: object
      properties:
        key_name:
          type: string
        value:
          type: string
        status:
          type: string
          enum:
            - deployed
            - draft
            - error
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        tenant_id:
          type: string
        program_count:
          type: integer
          minimum: 0
      required:
        - key_name
        - value
        - status
        - created_at
        - updated_at
        - tenant_id
        - program_count
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            error_code:
              type: string
          required:
            - message
            - error_code
        request_id:
          type: string
      required:
        - error
        - request_id
  securitySchemes:
    serviceToken:
      type: oauth2
      description: >-
        Service (M2M) access token issued by POST /auth/token using the
        client_credentials grant. Required scopes, where known, are listed on
        each operation below.
      flows:
        clientCredentials:
          tokenUrl: https://api.openloophealth.com/v0.1/auth/token
          scopes: {}
    userToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        User access token issued by POST /auth/token via the verification-code
        grant (after Verify a one-time code) or the refresh_token grant.

````

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