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.
| Value | Meaning | Example use |
|---|---|---|
Workspace id | UUID of your workspace | Query workspace_id; JSON workspace |
OAuth client resource id | UUID of the configuration record | /developer/clients/{id}/ |
OAuth client_id | Public application identifier | OAuth requests and application oauth_client fields |
User id | Application-user identifier | Developer user detail, group membership |
| Developer account ID | Dashboard-account identifier | Workspace invitations/membership |
Active plan response id | Your user-plan/subscription identifier | user_plan_id during client/provider creation |
Catalogue plan id or slug | Product plan selected in Billing | Subscription 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 itsid.YOUR_PUBLIC_CLIENT_IDorYOUR_CONFIDENTIAL_CLIENT_ID: open the intended application in Applications and copyclient_id. For a client you create through the API, useclient_idfrom the creation response.- A client ID inside a management detail URL such as
/developer/clients/{client_id}/: use the configuration record'sid, even though the URL parameter is namedclient_id. YOUR_USER_PLAN_ID: copy the relevant active plan entry'sidfrom 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.