Using the Account endpoint via API

The Account endpoint returns workspace-level information that helps an integration confirm which Worklix account it is connected to.

Keep API credentials server-side.

Do not expose production tokens in browser code, public repositories or shared client-side configuration.

Request

The endpoint requires authentication and does not need a workspace ID in the URL because the token already resolves the account context.

GET https://api.worklix.com/v1/account

Example response

Use account metadata for environment checks and UI labels, not as a substitute for permission checks on individual resources.

{
  "data": {
    "id": "ws_92a1",
    "name": "Northstar Operations",
    "timezone": "America/New_York",
    "locale": "en-US",
    "plan": "business"
  }
}

Fields

Typical account fields include workspace ID, display name, timezone, locale and plan context. Your token scope still determines which workforce resources the integration can access.

Was this article helpful?

Using the Account endpoint via API

Request

Example response

Fields

Know the resource first.Then build the connection.