DocumentationTypeship CLITypeship MCPTypeship SDKsAPI Reference
Console
API keys

Retrieve an API key

GET
/api-keys/{api_key_id}

Returns the key summary and its ETag for conditional revocation.

Authorization

apiKey
AuthorizationBearer <token>

Organization API key from the console (ak_...), or an OAuth access token with user:org:read, the organization selected during consent, and the capability required by the operation.

In: header

Path Parameters

api_key_id*string

Identifier returned by the API key list.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api-keys/apikey_2nY8mR6pQ4vK9cH3"
{  "id": "apikey_2nY8mR6pQ4vK9cH3",  "object": "api_key",  "name": "Parcel deployment",  "last4": "c0de",  "revoked": false,  "last_used_at": "2026-09-23T08:00:00Z",  "created_at": "2026-09-23T08:00:00Z",  "request_id": "req_3k8m1v6q9p2d7h4c"}

List API keys GET

Lists key metadata and the last four characters of each key. Full keys are not returned. Create keys in the Console.

Revoke an API key DELETE

Revokes a key. Repeating the request returns the same result. With OAuth, members can revoke their own keys; organization admins can revoke any key. Organization API keys can revoke any key in their account. See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag and If-Match.