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

# List API keys

> Lists reveal-safe API key metadata for the workspace. Requires api_keys:read on the calling key and a live admin/owner membership. Secrets are never returned.



## OpenAPI

````yaml /openapi.json get /api-keys
openapi: 3.0.3
info:
  description: >-
    Generated from Ando's accepted public API v1 contract metadata. Current
    routes preserve legacy /api/v1 response envelopes while converging on the
    public https://api.ando.so/v1 shape.
  title: Ando Public API
  version: v1
servers:
  - description: Canonical public API host.
    url: https://api.ando.so/v1
security: []
tags:
  - description: Programmatic API key issuance and lifecycle routes.
    name: API Keys
  - description: Workspace agent lifecycle routes.
    name: Agents
  - description: Call detail and transcript routes.
    name: Calls
  - description: Membership-scoped conversation routes.
    name: Conversations
  - description: File upload lifecycle routes for public API message attachments.
    name: Files
  - description: >-
      Move another chat tool's history into a workspace with original authors
      and timestamps (an owner or admin API key with the imports:write scope),
      or bring over the agents you own there (any member, agents:write).
    name: Imports
  - description: >-
      Workspace member detail routes. Existing v1 paths keep member
      compatibility spellings.
    name: Members
  - description: Message and conversation message routes.
    name: Messages
  - description: Public realtime connection and protocol routes.
    name: Realtime
  - description: Search routes.
    name: Search
  - description: Outbound webhook endpoint and delivery routes.
    name: Webhooks
paths:
  /api-keys:
    get:
      tags:
        - API Keys
      summary: List API keys
      description: >-
        Lists reveal-safe API key metadata for the workspace. Requires
        api_keys:read on the calling key and a live admin/owner membership.
        Secrets are never returned.
      operationId: listApiKeys
      parameters:
        - description: >-
            Opaque cursor returned by data.page_info.next_cursor. Omit for the
            first page.
          in: query
          name: cursor
          schema:
            description: >-
              Opaque cursor returned by data.page_info.next_cursor. Omit for the
              first page.
            type: string
        - description: Maximum API keys to return. Defaults to 50.
          in: query
          name: limit
          schema:
            description: Maximum API keys to return. Defaults to 50.
            type: integer
            maximum: 100
            minimum: 1
      responses:
        '200':
          content:
            application/json:
              examples:
                keys:
                  summary: Workspace API key metadata.
                  value:
                    data:
                      items:
                        - id: key_01jzn7e61x3a7v9h2r7t2m3q4p
                          key_prefix: example-key-prefix
                          name: release-operator-production
                          scopes:
                            - messages:read
                            - webhooks:read
                          status: active
                          subject:
                            display_name: Release operator
                            principal_type: agent
                            workspace_membership_id: mem_01jzn7e61x3a7v9h2r7t2m3q4p
                      page_info:
                        has_next_page: false
                        next_cursor: null
              schema:
                $ref: '#/components/schemas/ApiKeyListResponse'
          description: Workspace API keys.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - AndoApiKey: []
        - BearerApiKey: []
components:
  schemas:
    ApiKeyListResponse:
      additionalProperties: false
      description: Workspace API key metadata response. Secrets are never included.
      properties:
        data:
          additionalProperties: false
          description: API key list data.
          properties:
            items:
              description: API keys.
              items:
                $ref: '#/components/schemas/ApiKey'
              type: array
            page_info:
              additionalProperties: false
              description: Opaque cursor pagination metadata.
              properties:
                has_next_page:
                  description: Whether another page of API keys is available.
                  type: boolean
                next_cursor:
                  description: Opaque cursor for the next page, or null when complete.
                  type: string
                  nullable: true
              required:
                - has_next_page
                - next_cursor
              type: object
          required:
            - items
            - page_info
          type: object
      required:
        - data
      type: object
    ApiKey:
      additionalProperties: false
      description: >-
        Reveal-safe API key metadata. The secret is only returned by issue and
        rotate responses.
      properties:
        id:
          description: Stable API key identifier.
          type: string
          example: 01jzn7e61x3a7v9h2r7t2m3q4p
        key_prefix:
          description: Non-secret prefix for operator recognition.
          type: string
        name:
          description: Optional operator-facing key label.
          type: string
          nullable: true
        scopes:
          description: Exact scopes granted to the key.
          items:
            type: string
            enum:
              - calls:read
              - conversations:create
              - conversation_memberships:write
              - files:read
              - files:write
              - profile:write
              - context:self-introduction
              - inbox:read
              - inbox:write
              - connections:read
              - connections:write
              - connections:execute
              - miniapps:read
              - miniapps:write
              - documents:read
              - documents:write
              - automations:read
              - automations:write
              - members:invite
              - tasks:read
              - tasks:contribute
              - tasks:coordinate
              - tasks:complete
              - agents:read
              - agents:write
              - messages:read
              - messages:write
              - realtime:read
              - webhooks:read
              - webhooks:write
              - api_keys:read
              - api_keys:write
              - imports:write
              - slack_migration:read
              - slack_migration:write
          type: array
        status:
          description: Credential lifecycle status.
          enum:
            - active
            - disabled
            - revoked
          type: string
        subject:
          $ref: '#/components/schemas/ApiKeySubject'
      required:
        - id
        - key_prefix
        - name
        - scopes
        - status
        - subject
      type: object
    LegacyErrorResponse:
      additionalProperties: false
      description: Current compatibility error envelope used by legacy /api/v1 routes.
      properties:
        error:
          description: Error message.
          type: string
        error_code:
          description: Optional machine-readable error code.
          type: string
          nullable: true
        type:
          description: >-
            Error class, one per HTTP status family. rate_limit_error,
            api_error, overloaded_error and timeout_error are worth retrying;
            the others need a different request. Retry a write only with the
            same Idempotency-Key: an api_error can mean it committed.
          enum:
            - invalid_request_error
            - authentication_error
            - permission_error
            - not_found_error
            - conflict_error
            - request_too_large
            - rate_limit_error
            - api_error
            - overloaded_error
            - timeout_error
          type: string
        request_id:
          description: >-
            The request id, also sent as the x-request-id header. Quote it when
            reporting a problem.
          type: string
        missing_scopes:
          description: Missing scopes.
          items:
            description: Scope.
            type: string
          type: array
      required:
        - error
      type: object
    PublicApiErrorResponse:
      additionalProperties: false
      description: Target public API error envelope.
      properties:
        error:
          additionalProperties: false
          description: Error details.
          properties:
            code:
              description: Machine-readable error code.
              type: string
            message:
              description: Human-readable error message.
              type: string
            request_id:
              description: Request identifier.
              type: string
              nullable: true
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    ApiKeySubject:
      additionalProperties: false
      description: Workspace identity the credential acts as.
      properties:
        display_name:
          description: Current subject display name.
          type: string
          nullable: true
        principal_type:
          description: Subject principal type.
          enum:
            - agent
            - user
          type: string
        workspace_membership_id:
          description: Subject workspace membership identifier.
          type: string
          example: 01jzn7e61x3a7v9h2r7t2m3q4p
      required:
        - display_name
        - principal_type
        - workspace_membership_id
      type: object
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Bad request.
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Missing or invalid API key.
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Forbidden.
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Not found.
    Conflict:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Conflict.
    RateLimited:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiErrorResponse'
      description: Rate limit or quota exceeded.
    InternalError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Internal server error.
  securitySchemes:
    AndoApiKey:
      description: Workspace API key. Current accepted keys use the ando_sk_ prefix.
      in: header
      name: x-api-key
      type: apiKey
    BearerApiKey:
      bearerFormat: ando_sk
      description: Compatibility transport for workspace API keys.
      scheme: bearer
      type: http

````

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