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

# A state's consumers

> Everything that binds the state — flows, hooks, schedules, agents — as the Consumers
tab reads it; a consumer family the deployment cannot list is a labelled, muted row.



## OpenAPI

````yaml /openapi.json get /api/states/{name}/consumers
openapi: 3.1.0
info:
  description: The operator HTTP surface served under /api/*.
  title: tai42-skeleton API
  version: 14.0.2
servers: []
security: []
paths:
  /api/states/{name}/consumers:
    get:
      tags:
        - states
      summary: A state's consumers
      description: >-
        Everything that binds the state — flows, hooks, schedules, agents — as
        the Consumers

        tab reads it; a consumer family the deployment cannot list is a
        labelled, muted row.
      operationId: get_api_states_name_consumers
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/StateConsumerList'
                required:
                  - data
                type: object
          description: Success.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Missing or invalid api key.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Resource not found.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error.
      security:
        - ApiKeyAuth: []
components:
  schemas:
    StateConsumerList:
      description: >-
        The bare-list body of ``state_consumers`` — everything that binds the
        state (flows,

        hooks, schedules, agents), each a ``ConsumerRow`` (an unlistable
        consumer family is a

        labelled ``unavailable`` row).
      items:
        $ref: '#/components/schemas/ConsumerRow'
      title: StateConsumerList
      type: array
    Error:
      properties:
        code:
          description: >-
            Stable machine-readable reason a client keys a dedicated error state
            on, present on refusals that opt in (e.g. a 501 not-configured
            refusal). Optional: absent when the error carries only a
            human-readable message.
          type: string
        error:
          type: string
      required:
        - error
      type: object
    ConsumerRow:
      additionalProperties: false
      description: >-
        One thing that binds a state, as the Consumers tab reads it: its
        ``kind``

        (hook / schedule / agent / a consumer plugin's own kind), ``name``,
        human ``detail`` and optional

        ``link``. ``unavailable`` (mutually exclusive with the rest) marks a
        consumer

        family that cannot be listed on this deployment (e.g. no scheduling
        backend),

        surfaced as a muted line — never swallowed.
      properties:
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Detail
        kind:
          title: Kind
          type: string
        link:
          anyOf:
            - $ref: '#/components/schemas/ConsumerLink'
            - type: 'null'
          default: null
        name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Name
        unavailable:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Unavailable
      required:
        - kind
      title: ConsumerRow
      type: object
    ConsumerLink:
      additionalProperties: false
      description: >-
        Where the Studio opens a consumer: a feature ``token`` + ``search`` (a
        states

        page → hooks/scheduling/agents cross-link) OR a ``plugin_path`` +
        ``search`` (a

        plugin's own screen). All optional — a consumer that renders no link
        supplies

        none.
      properties:
        plugin_path:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Plugin Path
        search:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          title: Search
        token:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Token
      title: ConsumerLink
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey

````