Bloss Docs

Get the brand's API keys and webhooks

Developers
GET
/brands/{brandId}/integrations

Settings › Integrations: the brand's API keys (name, prefix, permissions, status, last use; never the key) and its webhooks (destination host, masked URL, what they notify about). Webhook URLs are secrets, so only the host is returned in full.

Authorization

bearerAuth integrations:read
headerAuthorizationBearer <token>

Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, recruitment:read, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read.

Scope: integrations:read

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length

Response Body

Success.

application/json
  1. response
apiKeys*array<>
webhooks*array<>
curl -X GET 'https://example.com/api/v1/brands/string/integrations'
{  "apiKeys": [    {      "id": "string",      "name": "string",      "keyPrefix": "string",      "kind": "v1",      "scopes": [        "string"      ],      "status": "active",      "createdAt": "string",      "expiresAt": "string",      "lastUsedAt": "string",      "revokedAt": "string"    }  ],  "webhooks": [    {      "id": "string",      "label": "string",      "platform": "string",      "host": "string",      "maskedUrl": "string",      "enabled": true,      "videoPlatforms": [        "string"      ],      "notifications": [        {          "type": "video_view_threshold",          "enabled": true,          "threshold": 0,          "fields": [            "string"          ],          "inactiveHours": 0,          "minVideos": 0        }      ],      "createdAt": "string",      "updatedAt": "string"    }  ]}

Was this page helpful?