> ## Documentation Index > Fetch the complete documentation index at: https://docs.signalmd.dev/llms.txt > Use this file to discover all available pages before exploring further. # List agents > The workspace's agents, newest first, and the shared demo agent when it is on (marked `readOnly`). A key tied to one agent sees only that agent. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/agents openapi: 3.1.0 info: title: Signal API version: 1.0.0 description: >- Signal reads a voice agent's production calls and says what to fix, then tests whether the fix worked. This API exposes the same data the web app shows: agents, calls and their traces, signals, issues, versions and their comparisons, tests, and test runs. Authenticate with `Authorization: Bearer sig_...` (an API key from the API keys page). Read keys may call every `read` operation; write keys may also call `write` operations, within their monthly budget. Each operation's scope is in `x-signal-scope`. Errors share one envelope (`Error`), lists share one cursor scheme (`limit`, `cursor`, `hasMore`, `nextCursor`), and every response carries `Request-Id` and `RateLimit-*` headers. servers: - url: https://first-signal-api.fly.dev description: Production - url: http://localhost:43124 description: Local development security: - bearerAuth: [] tags: - name: Account description: Who the token belongs to and what it may do. - name: Agents description: Voice agents connected to the workspace. - name: Calls description: Production calls, their traces and per-call signals. - name: Signals description: What Signal noticed across calls. - name: Issues description: 'Problems worth fixing: where, why, and what to change.' - name: Versions description: Agent versions and how each one did. - name: Comparisons description: Stored comparisons between two versions. - name: Tests description: Tests, test sets, personas and coverage. - name: Runs description: Test runs and the attempts inside them. paths: /v1/agents: get: tags: - Agents summary: List agents description: >- The workspace's agents, newest first, and the shared demo agent when it is on (marked `readOnly`). A key tied to one agent sees only that agent. operationId: listAgents parameters: - schema: type: integer minimum: 1 maximum: 100 default: 25 description: Items per page, 1 to 100. example: 25 required: false description: Items per page, 1 to 100. name: limit in: query - schema: type: string minLength: 1 description: '`nextCursor` from the previous page.' required: false description: '`nextCursor` from the previous page.' name: cursor in: query responses: '200': description: A page of agents. content: application/json: schema: $ref: '#/components/schemas/AgentList' '400': description: 'Invalid request: a parameter or the body failed validation.' content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Not permitted for this principal. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limited. See Retry-After. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Server error. The message is generic; quote the request id. content: application/json: schema: $ref: '#/components/schemas/Error' x-codeSamples: - lang: bash label: curl source: |- curl "https://first-signal-api.fly.dev/v1/agents" \ -H "Authorization: Bearer $SIGNAL_API_KEY" components: schemas: AgentList: type: object properties: object: type: string enum: - list data: type: array items: $ref: '#/components/schemas/AgentSummary' hasMore: type: boolean nextCursor: type: - string - 'null' description: Pass as `cursor` for the next page; null on the last page. required: - object - data - hasMore - nextCursor Error: type: object properties: error: type: object properties: type: $ref: '#/components/schemas/ErrorType' code: type: string example: agent_not_found description: The specific reason; stable within v1. message: type: string example: Agent not found. param: type: - string - 'null' description: The request field at fault, for a validation error. requestId: type: - string - 'null' example: req_8c1f0e2b4a6d9e3f7a5c1b0d quota: type: object properties: metric: type: string example: test_calls description: analysed_calls, agents, copilot_messages or test_calls. limit: type: integer used: type: integer plan: type: string example: free_org description: The workspace's plan slug. upgradePath: type: string example: /billing description: Where in the web app the plan is changed. required: - metric - limit - used - plan - upgradePath description: >- Present when code is quota_exceeded: the plan limit the request would pass. required: - type - code - message - param - requestId required: - error example: error: type: not_found_error code: agent_not_found message: Agent not found. param: null requestId: req_8c1f0e2b4a6d9e3f7a5c1b0d AgentSummary: type: object properties: object: type: string enum: - agent id: type: string format: uuid pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ example: 3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f name: type: - string - 'null' provider: type: string enum: - retell description: The voice platform. providerAgentId: type: string description: The agent's id on that platform. source: type: string enum: - retell - demo description: '"demo" for synthetic data shaped like the platform''s.' currentVersion: type: - integer - 'null' setupStatus: type: string enum: - pending - approved - rejected onboardingStep: type: string readOnly: type: boolean description: >- True only for the shared demo agent, which is readable by everyone and refuses every write with `demo_read_only`. A demo copied into the workspace (when the shared demo is off) is the workspace's own agent: false, and writes are accepted. graceDays: type: integer description: >- The agent's grace period in days, 1 to 90, 7 unless the workspace set its own: an open issue counts as resolved once the agent has taken calls for this long without it, and a version is judged on an issue only once it has taken calls for this long. example: 7 createdAt: type: string format: date-time example: '2026-10-02T14:03:07.120Z' updatedAt: type: string format: date-time example: '2026-10-02T14:03:07.120Z' required: - object - id - name - provider - providerAgentId - source - currentVersion - setupStatus - onboardingStep - readOnly - graceDays - createdAt - updatedAt example: object: agent id: 6f1d2c3b-4a5e-4f60-8b7a-9c0d1e2f3a4b name: Northwind Dental, front desk provider: retell providerAgentId: agent_7c1e5b2f9d0a4e86b3c1 source: retell currentVersion: 8 setupStatus: approved onboardingStep: done readOnly: false graceDays: 7 createdAt: '2026-09-02T09:14:00.000Z' updatedAt: '2026-10-02T08:30:12.000Z' ErrorType: type: string enum: - invalid_request_error - authentication_error - budget_error - permission_error - not_found_error - conflict_error - rate_limit_error - api_error securitySchemes: bearerAuth: type: http scheme: bearer description: An API key (`sig_...`), or a session token from the web app. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.