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

# Get a state



## OpenAPI

````yaml /openapi/nimbo_public.yml get /api/v1/states/{id}
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/states/{id}:
    get:
      tags:
        - Catalogs
      summary: Get a state
      operationId: getState
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          example: '123'
      responses:
        '200':
          description: State with the response root.
          content:
            application/json:
              schema:
                type: object
                required:
                  - state
                additionalProperties: false
                properties:
                  state:
                    type: object
                    required:
                      - abbrv
                      - id
                      - links
                      - name
                    additionalProperties: false
                    example:
                      id: 9001
                      name: Ciudad de Mexico
                      abbrv: CDMX
                      links:
                        country: /api/v1/countries/484
                        counties: /api/v1/states/9001/counties
                    properties:
                      id:
                        type: integer
                      name:
                        type:
                          - string
                          - 'null'
                      abbrv:
                        type:
                          - string
                          - 'null'
                      links:
                        type: object
                        required:
                          - country
                          - counties
                        additionalProperties: false
                        properties:
                          country:
                            type: string
                          counties:
                            type: string
        '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

````