Skip to main content
A workspace is the client folder at Notifique: instances, keys, plan, balance, and webhooks all live inside it.

​
In short

  • Every /v1/... call runs in the workspace of your API key
  • The first workspace is created on POST /v1/platform/verify (registration)
  • Additional workspaces: POST /v1/workspaces with workspace:create
  • Login with workspaceId + createApiKey: true for a key in another workspace
Full flow: Registration and verification.

​
One or many?

​
API (/v1/workspaces)

Scopes: workspace:read, workspace:create, workspace:update, workspace:delete.

​
List with session (all workspaces)

With login sessionToken (not messaging API key): GET /v1/platform/workspaces — all account workspaces with role (OWNER, ADMIN, MEMBER). ?include=billing requires billing:read.

​
Workspace billing

Plan, balance, and cards use Platform routes with the same workspaceId:
  • GET /v1/platform/workspaces/:id/subscription
  • GET /v1/platform/workspaces/:id/balance
  • GET /v1/platform/workspaces/:id/payment-methods
  • GET /v1/platform/workspaces/:id/credits/usage — credit ledger with correlationId, channel, and key used (billing:read)
See Billing.

​
Team (members and invites)

Manage workspace access via Platform API — scopes workspace:members:read / workspace:members:manage: Same routes exist at /v1/workspaces/:id/* with a messaging API key.

​
Next steps