Zernio
Zernio
API Reference

Invites

Create invite tokenPOST
Dashboard
llms.txtOpenAPI
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

{  "token": "inv_abc123def456ghi789",  "scope": "profiles",  "invitedProfileIds": [    "64f0a1b2c3d4e5f6a7b8c9d0",    "64f0a1b2c3d4e5f6a7b8c9d1"  ],  "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.

Download a TikTok video

Get a download URL or list available formats for a TikTok video. Requires Tools API access and uses the Tools API rate limit. Provider gateway failures and provider-side access blocks return 503; an unavailable video returns 404.

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"
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'.