Bloss Docs

List the brand's invite links

Developers
GET
/brands/{brandId}/invite-codes

The invite links on Invite Links, newest first: label, join link, uses and limit, expiry, whether it's on, the creator it credits, and the group it adds people to.

Authorization

bearerAuth brand: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: brand:read

Path Parameters

brandId*string

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

Length1 <= length

Response Body

Success.

application/json
  1. response
data*array<>
curl -X GET 'https://example.com/api/v1/brands/string/invite-codes'
{  "data": [    {      "code": "string",      "url": "string",      "label": "string",      "uses": 0,      "maxUses": 0,      "active": true,      "expiresAt": "string",      "expired": true,      "exhausted": true,      "referrer": {        "creatorId": "string",        "name": "string"      },      "group": {        "id": "string",        "name": "string"      },      "createdAt": "string"    }  ]}

Was this page helpful?