workspace

Who this credential is

The workspace, the credential's role and scopes, and the plan. Cheap, and the right health check for an integration. For a person-token (authorization_code), also includes userId — the same id GET /team/members lists them under, for a client that wants "assign to me"/"my work" to work without asking the person to pick themselves out of their own team — and orgs: every workspace they belong to, for a client that wants to offer a "switch workspace" action (see POST /oauth/token's refresh_token grant). Unlike every other /v1 route, this one is NOT refused on a Free-plan workspace — it reports plan: "free" truthfully instead, which is what lets a client explain the refusal (or, for a person-token, offer switching to a different workspace) rather than just receiving one.

get/v1/me

Request

  • Base URL: https://api.flowral.app
  • URL: https://api.flowral.app/v1/me
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.flowral.app/v1/oauth/token)

Response

SUCCESS

workspaceIdstring required
workspaceNamestring required
credentialIdstring

The key or client this token belongs to.

credentialNamestring
role'admin' | 'member' | 'viewer' required

The credential’s role in the workspace. It decides what every other call may do.

scopesstring[] required
plan'free' | 'pro' required

Example response

{
  "credentialName": "Acme CI"
}

Changes

No recorded changes to this operation across all 1 revision of this API.