v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Endpoints

List Endpoint API Keys

Lists all API keys configured on the given Webhook/Generic Endpoint. The response never contains the SHA-256 hash or the plaintext key — only the masked preview, name, id, and creation timestamp.

get/v2.0/endpoints/{endpointId}/apikeys

Path parameters

endpointIdstring required

The Id of the Endpoint

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Array of Endpoint API Keys (metadata only).

_idstring

namestring

Customer-provided display name for the key.

keyPreviewstring

Masked preview of the plaintext key (first 4 chars + masked middle + last 4 chars). Captured at generation time.

createdAtinteger

Unix-timestamp

Example response

[
  {
    "name": "My CRM webhook",
    "keyPreview": "8a4f••••••••7c2e",
    "createdAt": 1694518620
  }
]