Pocket

Organization API Keys

Create and manage organization-level API keys for programmatic access

Organization API keys provide programmatic access to the Pocket API on behalf of your organization. Keys can be scoped to limit which resources they can access.

List API Keys

GET /api/v1/organization/:orgId/api-keys

Minimum role: viewer

Returns all API keys for the organization.

Response

{
  "keys": [
    {
      "id": "key_abc123",
      "name": "CI Pipeline",
      "scopes": ["recordings:read", "templates:read"],
      "created_at": "2026-01-15T10:00:00.000Z",
      "expires_at": "2026-07-15T10:00:00.000Z",
      "last_used_at": "2026-04-09T14:32:00.000Z"
    }
  ]
}

Get API Key

GET /api/v1/organization/:orgId/api-keys/:keyId

Minimum role: viewer

Returns details for a single API key.

Path Parameters

ParameterTypeDescription
keyIdstringThe API key identifier

Response

{
  "id": "key_abc123",
  "name": "CI Pipeline",
  "scopes": ["recordings:read", "templates:read"],
  "created_at": "2026-01-15T10:00:00.000Z",
  "expires_at": "2026-07-15T10:00:00.000Z",
  "last_used_at": "2026-04-09T14:32:00.000Z"
}

Create API Key

POST /api/v1/organization/:orgId/api-keys

Minimum role: admin

Creates a new API key. The full key value is returned only once in the response — store it securely.

Request Body

FieldTypeRequiredDescription
namestringYesA human-readable label for the key
scopesstring[]NoPermissions to grant. Defaults to all scopes if omitted
expires_atstringNoISO 8601 expiration date. Omit for a non-expiring key

Available Scopes

ScopeDescription
recordings:readList and view recordings
recordings:writeCreate, update, and delete recordings
templates:readList and view templates
templates:writeCreate, update, and delete templates

Example Request

{
  "name": "CI Pipeline",
  "scopes": ["recordings:read", "templates:read"],
  "expires_at": "2026-07-15T10:00:00.000Z"
}

Response

{
  "id": "key_abc123",
  "name": "CI Pipeline",
  "key": "pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "scopes": ["recordings:read", "templates:read"],
  "created_at": "2026-04-10T08:00:00.000Z",
  "expires_at": "2026-07-15T10:00:00.000Z"
}

Delete API Key

DELETE /api/v1/organization/:orgId/api-keys/:keyId

Minimum role: admin

Permanently revokes an API key. Any request using this key will be rejected immediately.

Path Parameters

ParameterTypeDescription
keyIdstringThe API key identifier

Response

{
  "success": true
}

On this page