get: operationId: GetPublishableApiKeys summary: List Publishable API keys description: >- Retrieve a list of publishable API keys. The publishable API keys can be filtered by fields such as `q`. The publishable API keys can also be paginated. x-authenticated: true parameters: - in: query name: q description: term to search publishable API keys' titles. schema: type: string - in: query name: limit description: Limit the number of publishable API keys returned. schema: type: number default: '20' - in: query name: offset description: >- The number of publishable API keys to skip when retrieving the publishable API keys. schema: type: number default: '0' - in: query name: expand description: >- Comma-separated relations that should be expanded in the returned publishable API keys. schema: type: string - in: query name: fields description: >- Comma-separated fields that should be included in the returned publishable API keys. schema: type: string x-codegen: method: list queryParams: GetPublishableApiKeysParams x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_publishable-api-keys/get.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_publishable-api-keys/get.sh security: - api_token: [] - cookie_auth: [] tags: - Publishable Api Keys responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminPublishableApiKeysListRes.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml post: operationId: PostPublishableApiKeys summary: Create Publishable API Key description: Creates a Publishable API Key. requestBody: content: application/json: schema: $ref: ../components/schemas/AdminPostPublishableApiKeysReq.yaml x-authenticated: true x-codegen: method: create x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_publishable-api-keys/post.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_publishable-api-keys/post.sh security: - api_token: [] - cookie_auth: [] tags: - Publishable Api Keys responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminPublishableApiKeysRes.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml