Zernio
APIFor you
Zernio
APIFor you
API Reference

Invites

Create invite tokenPOST
Dashboard
OverviewPlatformsAPI ReferenceResources
Invites

Create invite token

Generate a secure invite link to grant team members access to your profiles. Invites expire after 7 days and are single-use.

Returns 403 when a requested profile is not found or not owned, or when called with a restricted (zrk_) API key: invite management is admin-plane.

POST
/v1/invite/tokens

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.invites.createInviteToken({  body: {    scope: 'all',  },});console.log(data);
{  "token": "inv_abc123def456ghi789",  "scope": "profiles",  "invitedProfileIds": [    "64f0a1b2c3d4e5f6a7b8c9d0",    "64f0a1b2c3d4e5f6a7b8c9d1"  ],  "disabledResourceGroups": [],  "expiresAt": "2024-11-08T10:30:00Z",  "inviteUrl": "https://zernio.com/invite/inv_abc123def456ghi789"}
Was this page helpful?

Get user

Returns a single user's details by ID, including name, email, and role.

Open the creator's Stripe dashboard

Returns a one-time link into the creator's Stripe Express dashboard, where they change bank details and see each payout. Only after the creator submitted their payout details. About 20 attempts per participant every 10 minutes.

scope*string

'all' grants access to all profiles, 'profiles' restricts to specific profiles

Value in

  • "all"
  • "profiles"
profileIds?array<string>

Required if scope is 'profiles'. Array of profile IDs to grant access to.

role?string

Org role granted to the invitee. Defaults to 'member'. 'admin' can manage the team (invite/remove members, change roles and access) and billing, but not ownership transfer or account deletion. 'billing_admin' (displayed as Billing Manager) manages billing only. 'viewer' creates a read-only member who can view everything in their profile scope but cannot perform any content mutation (publish, edit, delete, connect accounts).

Default"member"

Value in

  • "admin"
  • "member"
  • "billing_admin"
  • "viewer"
disabledResourceGroups?array<>

Resource groups the invitee may not use once they join (the same groups as restricted API keys). Their dashboard hides those sections and every API request into a disabled group, with any credential they hold, is refused with 403. Omitted or empty means full access. Groups the caller lacks themselves are always added.

readOnly?boolean
Deprecated

Deprecated. Use role 'viewer' instead. When true, the invite is created with role 'viewer'. Cannot be combined with role 'billing_admin' or 'admin'.