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

# Lister les clés API

> Liste les clés API de l’espace de travail authentifié.

<Note>Ce point de terminaison nécessite une clé API de gestion. Les clés API Gateway standard ne sont pas acceptées.</Note>

Renvoie les clés API de l’espace de travail authentifié avec pagination et un filtre facultatif pour les clés désactivées.


## OpenAPI

````yaml fr/openapi/v1/openapi.localized.yaml GET /keys
openapi: 3.0.3
info:
  title: Phaseo Gateway API
  description: >-
    Une API de passerelle pour accéder à divers modèles d’IA via des points de
    terminaison compatibles avec OpenAI.
  version: 1.0.0
  contact:
    name: Phaseo
    url: https://phaseo.app
    email: danielbutler500@gmail.com
servers:
  - url: https://api.phaseo.app/v1
    description: Routage mondial
security:
  - BearerAuth: []
tags:
  - name: Gateway
    description: Core Phaseo Gateway operations.
paths:
  /keys:
    get:
      tags:
        - Gateway
      summary: Lister les clés API
      description: >-
        Répertorie les clés API de l’espace de travail authentifié. Une clé API
        de gestion est requise.
      operationId: listApiKeys
      parameters:
        - name: include_disabled
          in: query
          description: >-
            Indique s’il faut inclure dans la réponse les clés suspendues ou
            temporairement bloquées.
          schema:
            type: boolean
            default: false
        - name: offset
          in: query
          description: Nombre de clés API à ignorer pour la pagination.
          schema:
            type: integer
            minimum: 0
            default: 0
        - name: limit
          in: query
          description: Nombre maximal de clés API à renvoyer.
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 250
        - name: workspace_id
          in: query
          description: >-
            Remplacement facultatif de l’espace de travail. Il doit correspondre
            à l’espace authentifié, sauf si l’appelant est un contrôleur
            interne.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Liste des clés API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyListResponse'
        '401':
          description: Non autorisé
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Interdit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Erreur du serveur
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ApiKeyListResponse:
      type: object
      required:
        - data
        - total_count
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ApiKey'
        total_count:
          type: integer
          minimum: 0
          example: 3
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        ok:
          type: boolean
          example: false
        error:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          example: error_type
        message:
          type: string
          example: Human-readable error message
        description:
          type: string
          example: Additional error details.
        generation_id:
          type: string
          example: G-abc123
        status_code:
          type: integer
          example: 502
        error_type:
          type: string
          enum:
            - user
            - system
          example: system
        error_origin:
          type: string
          enum:
            - user
            - gateway
            - upstream
          example: upstream
        reason:
          type: string
          example: all_candidates_failed
        attempt_count:
          type: integer
          example: 2
        failed_providers:
          type: array
          items:
            type: string
          example:
            - google-ai-studio
            - openai
        failed_statuses:
          type: array
          items:
            type: integer
          example:
            - 403
            - 429
        upstream_error:
          $ref: '#/components/schemas/ErrorUpstreamError'
        failure_sample:
          type: array
          items:
            $ref: '#/components/schemas/ErrorFailureSampleItem'
        provider_failure_diagnostics:
          $ref: '#/components/schemas/ErrorProviderFailureDiagnostics'
        routing_diagnostics:
          $ref: '#/components/schemas/ErrorRoutingDiagnostics'
        provider_candidate_diagnostics:
          $ref: '#/components/schemas/ErrorProviderCandidateDiagnostics'
        provider_enablement:
          $ref: '#/components/schemas/ErrorProviderEnablementDiagnostics'
        missing_pricing_providers:
          type: array
          items:
            type: string
        provider_payment_required_provider:
          type: string
          example: openai
        provider_payment_required_support_notice:
          type: string
          example: >-
            Our upstream provider billing appears to be unavailable. If this
            persists, contact support.
        details:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    ApiKey:
      type: object
      required:
        - id
        - hash
        - workspace_id
        - name
        - label
        - prefix
        - status
        - disabled
        - soft_blocked
        - scopes
        - creator_user_id
        - include_byok_in_limit
        - limit
        - limit_reset
        - limit_remaining
        - usage
        - usage_daily
        - usage_weekly
        - usage_monthly
        - limits
        - usage_details
        - created_by
        - created_at
        - updated_at
        - last_used_at
        - expires_at
      properties:
        id:
          type: string
          format: uuid
          example: 11111111-1111-4111-8111-111111111111
        hash:
          type: string
          example: a3f5b7c9d8e1f23456789abcdeffedcba9876543210fedcba1234567890abcdef
        workspace_id:
          type: string
          format: uuid
          example: 22222222-2222-4222-8222-222222222222
        name:
          type: string
          nullable: true
          example: Analytics Service Key
        label:
          type: string
          nullable: true
          example: Analytics Service Key
        prefix:
          type: string
          nullable: true
          example: phaseo_v1_sk_abcd1234
        status:
          type: string
          nullable: true
          example: active
        disabled:
          type: boolean
          example: false
        soft_blocked:
          type: boolean
          example: false
        scopes:
          $ref: '#/components/schemas/ApiKeyScopeValue'
        creator_user_id:
          type: string
          nullable: true
        created_by:
          type: string
          nullable: true
          example: user_abc123
        created_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-04-28T12:00:00.000Z'
        updated_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-04-28T12:15:00.000Z'
        last_used_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-04-28T12:30:00.000Z'
        expires_at:
          type: string
          format: date-time
          nullable: true
          example: '2027-12-31T23:59:59.000Z'
        include_byok_in_limit:
          type: boolean
          description: >-
            Indique si les identifiants du fournisseur sont pris en compte dans
            la limite de dépenses de la clé. Actuellement, la valeur est
            toujours false.
        limit:
          type: number
          nullable: true
          description: Plafond de dépenses actif en USD.
        limit_reset:
          type: string
          nullable: true
          enum:
            - daily
            - weekly
            - monthly
        limit_remaining:
          type: number
          nullable: true
        usage:
          type: number
        usage_daily:
          type: number
        usage_weekly:
          type: number
        usage_monthly:
          type: number
        limits:
          $ref: '#/components/schemas/ApiKeyLimitWindows'
        usage_details:
          $ref: '#/components/schemas/ApiKeyUsageWindows'
      additionalProperties: false
    ErrorUpstreamError:
      type: object
      properties:
        code:
          type: string
          nullable: true
          example: PERMISSION_DENIED
        message:
          type: string
          nullable: true
          example: The caller does not have permission.
        description:
          type: string
          nullable: true
        param:
          type: string
          nullable: true
    ErrorFailureSampleItem:
      type: object
      properties:
        provider:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        status:
          type: integer
          nullable: true
        upstream_error_code:
          type: string
          nullable: true
        upstream_error_message:
          type: string
          nullable: true
        upstream_error_description:
          type: string
          nullable: true
        upstream_error_param:
          type: string
          nullable: true
        upstream_payload_preview:
          type: string
          nullable: true
        retryable:
          type: boolean
          nullable: true
      additionalProperties: true
    ErrorProviderFailureDiagnostics:
      type: object
      properties:
        category:
          type: string
          enum:
            - credentials_not_configured
            - credentials_invalid_or_forbidden
            - provider_access_missing
            - region_or_project_restriction
            - model_unavailable_for_endpoint
            - rate_limited
            - server_error
        hint:
          type: string
        provider:
          type: string
          nullable: true
    ErrorRoutingDiagnostics:
      type: object
      properties:
        filterStages:
          type: array
          items:
            type: object
            properties:
              stage:
                type: string
              beforeCount:
                type: integer
              afterCount:
                type: integer
              droppedProviders:
                type: array
                items:
                  type: object
                  properties:
                    providerId:
                      type: string
                      nullable: true
                    reason:
                      type: string
                      nullable: true
                  additionalProperties: true
            additionalProperties: true
      additionalProperties: true
    ErrorProviderCandidateDiagnostics:
      type: object
      properties:
        totalProviders:
          type: integer
        supportsEndpointCount:
          type: integer
        candidateCount:
          type: integer
        droppedUnsupportedEndpoint:
          type: array
          items:
            type: string
        droppedMissingAdapter:
          type: array
          items:
            type: object
            properties:
              providerId:
                type: string
                nullable: true
              endpoint:
                type: string
                nullable: true
            additionalProperties: true
      additionalProperties: true
    ErrorProviderEnablementDiagnostics:
      type: object
      properties:
        capability:
          type: string
        providersBefore:
          type: array
          items:
            type: string
        providersAfter:
          type: array
          items:
            type: string
        dropped:
          type: array
          items:
            type: object
            properties:
              providerId:
                type: string
                nullable: true
              reason:
                type: string
                nullable: true
            additionalProperties: true
      additionalProperties: true
    ApiKeyScopeValue:
      oneOf:
        - type: string
          example: '["chat.completions","responses"]'
        - type: array
          items:
            type: string
          example:
            - chat.completions
            - responses
    ApiKeyLimitWindows:
      type: object
      required:
        - daily
        - weekly
        - monthly
      properties:
        daily:
          $ref: '#/components/schemas/ApiKeyLimitBucket'
        weekly:
          $ref: '#/components/schemas/ApiKeyLimitBucket'
        monthly:
          $ref: '#/components/schemas/ApiKeyLimitBucket'
      additionalProperties: false
    ApiKeyUsageWindows:
      type: object
      required:
        - total
        - daily
        - weekly
        - monthly
      properties:
        total:
          $ref: '#/components/schemas/ApiKeyUsageBucket'
        daily:
          $ref: '#/components/schemas/ApiKeyUsageBucket'
        weekly:
          $ref: '#/components/schemas/ApiKeyUsageBucket'
        monthly:
          $ref: '#/components/schemas/ApiKeyUsageBucket'
      additionalProperties: false
    ApiKeyLimitBucket:
      type: object
      required:
        - requests
        - cost
      properties:
        requests:
          type: integer
          nullable: true
          minimum: 0
        cost:
          type: number
          nullable: true
          minimum: 0
          description: Plafond de dépenses en USD.
      additionalProperties: false
    ApiKeyUsageBucket:
      type: object
      required:
        - requests
        - cost
      properties:
        requests:
          type: integer
          minimum: 0
        cost:
          type: number
          minimum: 0
          description: Dépenses en USD.
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authentification par jeton Bearer

````

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