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

# List agents

> Lists the workspace's agents, Statisfy's first and then by name, as the Agents tab does. Archived agents are left out unless `status=archived`. Look an agent up by name with `name`: names are not unique, so it can return more than one. An agent is a custom agent from Agent Studio's Agents tab: instructions it follows, and the toolkits, skills and knowledge bases it may use. `source` says whether Statisfy ships it or the workspace built it.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/agents
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/agents:
    get:
      tags:
        - agents
      summary: List agents
      description: >-
        Lists the workspace's agents, Statisfy's first and then by name, as the
        Agents tab does. Archived agents are left out unless `status=archived`.
        Look an agent up by name with `name`: names are not unique, so it can
        return more than one. An agent is a custom agent from Agent Studio's
        Agents tab: instructions it follows, and the toolkits, skills and
        knowledge bases it may use. `source` says whether Statisfy ships it or
        the workspace built it.
      operationId: agents_list
      parameters:
        - description: Only agents with this name, ignoring case. Names are not unique
          in: query
          name: name
          required: false
          schema:
            anyOf:
              - maxLength: 255
                minLength: 1
                type: string
              - type: 'null'
            default: null
        - description: 'Only agents with this status. Unset: active and draft'
          in: query
          name: status
          required: false
          schema:
            anyOf:
              - enum:
                  - draft
                  - active
                  - archived
                type: string
              - type: 'null'
            default: null
        - description: Only agents from this source
          in: query
          name: source
          required: false
          schema:
            anyOf:
              - enum:
                  - statisfy
                  - workspace
                type: string
              - type: 'null'
            default: null
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentsResponse'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    AgentsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Agent'
          title: Data
          type: array
      required:
        - data
      title: AgentsResponse
      type: object
    Agent:
      properties:
        context:
          description: >-
            global (runs about nothing in particular) or account (runs about one
            account)
          enum:
            - global
            - account
          title: Context
          type: string
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          description: ISO 8601 UTC
          title: Created At
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The user who built it, an id from GET /v1/objects/user/records; null
            for a Statisfy agent, or a user who is gone
          title: Created By
        customized:
          description: >-
            Whether this workspace changed a Statisfy agent from its defaults;
            false for a workspace's own
          title: Customized
          type: boolean
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        id:
          title: Id
          type: string
        name:
          title: Name
          type: string
        source:
          description: >-
            statisfy (shipped by Statisfy, in the app's Statisfy Library) or
            workspace (built by this workspace)
          enum:
            - statisfy
            - workspace
          title: Source
          type: string
        status:
          description: active, draft or archived
          enum:
            - draft
            - active
            - archived
          title: Status
          type: string
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          description: ISO 8601 UTC
          title: Updated At
      required:
        - id
        - name
        - description
        - status
        - source
        - customized
        - context
        - created_by
        - created_at
        - updated_at
      title: Agent
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

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