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

# List API keys

> Returns all Signal API keys for the project.

### Requirements

- **Permission:** `usage:read`.
- **Project access:** the path project must match the API key's project.



## OpenAPI

````yaml /signal/api-reference/openapi.json get /v1/projects/{projectId}/api-keys
openapi: 3.1.0
info:
  title: Apollo Signal API
  version: 1.0.0
  description: >-
    Public REST API for transactional email, contacts, audiences, webhooks,
    metrics, projects, and sending domains.
servers:
  - url: https://api.signal.apollodeploy.com
    description: Production
security: []
tags:
  - name: Emails
    description: Send, inspect, cancel, validate, and stream transactional email activity.
  - name: Metrics
    description: Read project, topic, message, and deliverability analytics.
  - name: Suppressions
    description: Manage addresses that Apollo Signal must not send to.
  - name: Segments
    description: Create dynamic contact groups and inspect their membership.
  - name: Topics
    description: Manage subscription topics and topic membership.
  - name: Contact properties
    description: Define the custom fields available on project contacts.
  - name: Contacts
    description: >-
      Manage contacts, audience membership, images, activity, and engagement
      data.
  - name: Webhooks
    description: Manage webhook endpoints, deliveries, tests, and replays.
  - name: API key usage
    description: Inspect API key metadata and request usage without exposing raw keys.
  - name: Projects
    description: Inspect projects and project-scoped email logs.
  - name: Sending domains
    description: >-
      Register, verify, inspect, and remove sending domains and BIMI
      configuration.
paths:
  /v1/projects/{projectId}/api-keys:
    get:
      tags:
        - API key usage
      summary: List API keys
      description: |-
        Returns all Signal API keys for the project.

        ### Requirements

        - **Permission:** `usage:read`.
        - **Project access:** the path project must match the API key's project.
      operationId: listApiKeys
      parameters:
        - name: projectId
          in: path
          description: The project whose keys to list.
          required: true
          deprecated: false
          explode: false
          schema:
            type: string
            title: String
      responses:
        '200':
          description: List of API keys (raw key never included).
          headers: {}
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/com.apollodeploy.signal.feature.apikey.domain.ApiKey
                  title: List<ApiKey>
                title: Map<String,List<ApiKey>>
        '401':
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: >-
                  #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem
          description: >-
            The API key or stream token is missing, invalid, expired, or
            inactive.
        '403':
          description: >-
            The credential lacks the required permission or cannot access this
            project.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: >-
                  #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    com.apollodeploy.signal.feature.apikey.domain.ApiKey:
      type: object
      properties:
        configId:
          type: string
          title: String
        createdAt:
          type: string
          title: String
        enabled:
          type: boolean
          title: Boolean
        expiresAt:
          type: string
          title: String
        id:
          type: string
          title: String
        lastRequest:
          type: string
          title: String
        metadata:
          type: object
          additionalProperties:
            type: string
            title: String
          title: Map<String,String>
        name:
          type: string
          title: String
        organizationId:
          type: string
          title: String
        permissions:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              title: String
            title: List<String>
          title: Map<String,List<String>>
        prefix:
          type: string
          title: String
        projectId:
          type: string
          title: String
        rateLimitEnabled:
          type: boolean
          title: Boolean
        rateLimitMax:
          type: integer
          format: int32
          title: Int
        rateLimitTimeWindow:
          type: integer
          format: int64
          title: Long
        remaining:
          type: integer
          format: int32
          title: Int
        requestCount:
          type: integer
          format: int32
          title: Int
        start:
          type: string
          title: String
        updatedAt:
          type: string
          title: String
      required:
        - configId
        - createdAt
        - enabled
        - id
        - organizationId
        - rateLimitEnabled
        - requestCount
        - updatedAt
      title: ApiKey
    com.apollodeploy.commons.core.error.ApiProblem:
      type: object
      properties:
        code:
          type: string
          title: ErrorCode
        detail:
          type: string
          title: String
        errors:
          type: array
          items:
            $ref: >-
              #/components/schemas/com.apollodeploy.commons.core.error.FieldProblem
          title: List<FieldProblem>
        instance:
          type: string
          title: ProblemInstance
        requestId:
          type: string
          title: String
        status:
          type: integer
          format: int32
          title: Int
        title:
          type: string
          title: String
        type:
          type: string
          title: ProblemType
      required:
        - code
        - status
        - title
        - type
      title: ApiProblem
    com.apollodeploy.commons.core.error.FieldProblem:
      type: object
      properties:
        detail:
          type: string
          title: String
        pointer:
          type: string
          title: String
      required:
        - detail
        - pointer
      title: FieldProblem
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Project-bound Apollo Signal API key. Keys begin with `ap_signal_` and
        must carry the permission shown on the operation.

````