Skip to main content

Workspace, client and plan identifiers

Copy identifiers from dashboard resource details or API responses. Names and email addresses are not substitutes for IDs unless an endpoint explicitly accepts them.

ValueMeaningExample use
Workspace idUUID of your workspaceQuery workspace_id; JSON workspace
OAuth client resource idUUID of the configuration record/developer/clients/{id}/
OAuth client_idPublic application identifierOAuth requests and application oauth_client fields
User idApplication-user identifierDeveloper user detail, group membership
Developer account IDDashboard-account identifierWorkspace invitations/membership
Active plan response idYour user-plan/subscription identifieruser_plan_id during client/provider creation
Catalogue plan id or slugProduct plan selected in BillingSubscription activation

workspace_id in the URL query and workspace in a JSON body are separate fields. Some create operations require both. Read the operation contract before leaving one out.

Use the same workspace and OAuth client throughout registration, verification and login. When an email appears in several workspaces, missing client context can select the wrong account or produce an ambiguity error.

Find the value a guide asks for​

  • YOUR_WORKSPACE_ID: find your workspace by name in the workspace list, then copy its id.
  • YOUR_PUBLIC_CLIENT_ID or YOUR_CONFIDENTIAL_CLIENT_ID: open the intended application in Applications and copy client_id. For a client you create through the API, use client_id from the creation response.
  • A client ID inside a management detail URL such as /developer/clients/{client_id}/: use the configuration record's id, even though the URL parameter is named client_id.
  • YOUR_USER_PLAN_ID: copy the relevant active plan entry's id from the developer plans request.

Copy each ID exactly as returned. Do not generate these IDs yourself. See credentials for tokens and secrets, and the sign-in attempt generator for values your application does generate.