Skip to main content

Get Public Client Registration (v1)

Method & Path​

GET /api/v1/workspace/public/client-registration/:token

Actual backend path: /v1/workspace/public/client-registration/:token

Description​

Returns workspace branding/meta for the Customer self-registration page. If the one-time invite was already used, the response still succeeds with status: "used" and the registered client name so the page can show a clear message.

Authentication​

None (public).

Persona access: Customer (unauthenticated).

Path Parameters​

ParameterTypeRequiredDescription
tokenstringYesOne-time registration token

Response 200 OK (available)​

{
  "registration": {
    "workspaceName": "Randerma",
    "workspaceSlogan": null,
    "branding": {},
    "enabled": true,
    "status": "available",
    "registeredName": null
  }
}

Response 200 OK (already used)​

{
  "registration": {
    "workspaceName": "Randerma",
    "workspaceSlogan": null,
    "branding": {},
    "enabled": false,
    "status": "used",
    "registeredName": "Sara Ahmad"
  }
}

Common Errors​

  • 404 Not Found: Invalid token
  • 500 Internal Server Error: Unexpected server error