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.

post/v1/api-keys

Request

  • Base URL: https://api.pinbridge.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.pinbridge.io/v1/api-keys
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Headers

x-api-keystring nullable
authorizationstring nullable

Request body

namestring required

Human-readable name for this API key

scopesstring[] nullable

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_idsstring[] nullable

Optional allow-list of Pinterest account IDs this key may act on. Omit or send null to allow every account in the workspace.

Response

Successful Response

idstring uuid required
workspace_idstring uuid required
namestring required
scopesstring[] required
pinterest_account_idsstring[] nullable
api_keystring required

The actual API key - save this, it won't be shown again

created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.