API Keys API

GET /v1/api-keys

List Api Keys

List all API keys for the workspace.

Auth: ApiKeyAuth, BearerAuth

Response 200

curl -X GET "https://api.pinbridge.io/v1/api-keys" \
  -H "X-API-Key: $PINBRIDGE_API_KEY"

---

POST /v1/api-keys

Create Api Key

Create a new API key.

Returns the API key once – save it, it won’t be shown again. Keys can be
restricted to a subset of scopes (read, write, destructive) and to
specific Pinterest accounts; an unrestricted key gets every scope.

Auth: ApiKeyAuth, BearerAuth

Request body (APIKeyCreate)

Field	Type	Required	Description
name	string	yes	Human-readable name for this API key (max 255)
scopes	array?	no	Scopes granted to this key. read covers list/get endpoints, write covers creating and updating pins, schedules, boards, assets and webhooks, and destructive covers deletes and revocations. Omit to grant every scope.
pinterest_account_ids	array?	no	Optional allow-list of Pinterest account IDs this key may act on. Omit or send null to allow every account in the workspace.

Response 201 (APIKeyCreateResponse)

curl -X POST "https://api.pinbridge.io/v1/api-keys" \
  -H "X-API-Key: $PINBRIDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Production key"}'

---

DELETE /v1/api-keys/{key_id}

Revoke Api Key

Revoke an API key.

Auth: ApiKeyAuth, BearerAuth

Parameters

Name	In	Required	Type	Description
key_id	path	yes	string

Response 204

curl -X DELETE "https://api.pinbridge.io/v1/api-keys/$KEY_ID" \
  -H "X-API-Key: $PINBRIDGE_API_KEY"

---

PATCH /v1/api-keys/{key_id}

Update Api Key

Update API key name, scopes, or Pinterest account allow-list.

Auth: ApiKeyAuth, BearerAuth

Parameters

Name	In	Required	Type	Description
key_id	path	yes	string

Request body (APIKeyUpdate)

Field	Type	Required	Description
name	string?	no	Human-readable name for this API key
scopes	array?	no	Scopes granted to this key. read covers list/get endpoints, write covers creating and updating pins, schedules, boards, assets and webhooks, and destructive covers deletes and revocations. Omit to grant every scope.
pinterest_account_ids	array?	no	Optional allow-list of Pinterest account IDs this key may act on. Omit or send null to allow every account in the workspace.

Response 200 (APIKeyResponse)

curl -X PATCH "https://api.pinbridge.io/v1/api-keys/$KEY_ID" \
  -H "X-API-Key: $PINBRIDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Production key", "scopes": ["read", "write"]}'

---