Get Client Registration Link (v1)

Method & Path

GET /api/v1/workspace/:workspaceId/clients/registration-link

Actual backend path: /v1/workspace/:workspaceId/clients/registration-link

Description

Get (or create) a one-time client self-registration invite link used in People Management → Clients. The link is ready to share immediately — there is no enable toggle. After one successful registration the link status becomes used.

Authentication

Required: Workspace Owner JWT or Staff JWT.

Persona access:

• Workspace Owner: full access
• Staff with client.create: can view/copy and regenerate the link
• Customer: uses the public link (separate public endpoints)

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier

Response 200 OK

{
  "link": {
    "enabled": true,
    "status": "available",
    "token": "a1b2c3...",
    "publicPath": "/register/a1b2c3...",
    "registeredName": null
  }
}

Field	Type	Description
status	available | used	Whether the current token can still accept a registration
enabled	boolean	Deprecated alias for status === 'available'
registeredName	string | null	Name of the client who consumed the link when status is used

Common Errors

• 401 Unauthorized: Missing or invalid authentication token
• 404 Not Found: Workspace not found
• 500 Internal Server Error: Unexpected server error