Skip to main content
GET
Get current user profile
Returns the authenticated user’s profile in a single call: their identity, organisation context, team assignment, and the feature modules enabled for their organisation. Useful for initialising application state after authentication without needing to stitch together multiple requests.

Best Practices

  1. Session initialisation: Call this endpoint immediately after authentication to hydrate your application with user and org context.
  2. Feature gating: Use enabled_feature_modules to conditionally show or hide features in your integration before making downstream API calls.
  3. Early access: Check organisation.early_access to determine whether the organisation has access to preview features.
  4. Report language: organisation.language is the language your organisation’s analysis reports are written in, as a BCP 47 tag such as en-GB (the default) or nl-NL.
  5. Team context: The team field is the user’s currently assigned team within the organisation, or null if the user has not been assigned to one. Use it to scope team-specific UI and actions.
  6. API keys: Called with an API key, this endpoint returns the person who created the key: organisation.role and organisation.permissions are that person’s, not the key’s. To see the key’s own permissions, call Authentication Status and read permissions. See Permissions and API Keys.
  7. Caching: The response is cheap to fetch but safe to cache for the duration of a session. Invalidate on logout or org changes.

Authorizations

x-api-key
string
header
required

Response

User profile retrieved successfully

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
name
string
required
email
string
required
organisation
object
required
enabled_feature_modules
string[]
required
team
object | null
required