Skip to main content
GET
/
users
/
me
Get current user profile
curl --request GET \
  --url https://api.uk.veridox.ai/users/me
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "email": "<string>",
  "organisation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "role": "administrator",
    "early_access": true
  },
  "enabled_feature_modules": [
    "<string>"
  ],
  "team": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.veridox.ai/llms.txt

Use this file to discover all available pages before exploring further.

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. 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.
  5. Caching: The response is cheap to fetch but safe to cache for the duration of a session. Invalidate on logout or org changes.

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
required