---
title: "Who this credential is"
method: GET
path: "/v1/me"
tags: ["workspace"]
---

# Who this credential is

`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`)

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.

## Response `200`

SUCCESS

- Context: Who the credential is and what it may do — the first call to make when wiring an integration.
  - `workspaceId` string, required
  - `workspaceName` string, required
  - `credentialId` string: The key or client this token belongs to.
  - `credentialName` string
  - `role` 'admin' | 'member' | 'viewer', required: The credential’s role in the workspace. It decides what every other call may do.
  - `scopes` string[], required
  - `plan` 'free' | 'pro', required

## Other responses

- `401`: UNAUTHORIZED · CREDENTIAL_REVOKED
- `403`: FORBIDDEN · PLAN_REQUIRED · INSUFFICIENT_SCOPE
- `429`: RATE_LIMITED

---

[API](https://skmtc.dev/flowral/apis/flowral-api.md) · [All operations](https://skmtc.dev/flowral/apis/flowral-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flowral/apis/flowral-api/revisions/6cd2337b682c?raw)