Retrieve my user | API Reference

curl http://localhost:8000/api/current-user/whoami \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json"

{
  "active_organization_meta": "Acme Corp - Premium Plan",
  "avatar": "https://example.com/avatars/user42.png",
  "id": 42,
  "initials": "JD",
  "last_activity": "2024-06-10T08:15:00Z",
  "lse_fields": {
    "active_organization_external_id": "org-42-ext",
    "email_notification_settings": "daily_summary",
    "invite_expired": "false",
    "invite_expired_at": "2024-12-31T23:59:59Z",
    "invite_activated": true,
    "invited_at": "2023-05-01T10:00:00Z",
    "invited_by": 7,
    "onboarding_state": "complete",
    "social_auth_finished": true,
    "trial_company": "Acme Corp",
    "trial_experience_labeling": "Image annotation and text classification",
    "trial_license_enterprise": false,
    "trial_models_in_production": "Object detection, Sentiment analysis",
    "trial_role": "data_scientist"
  },
  "organization_membership": {
    "active": "true",
    "organization_id": 42,
    "role": "admin"
  },
  "pause": "none",
  "permissions": [
    "read",
    "write",
    "admin"
  ],
  "social_accounts": [
    {
      "provider": "github",
      "username": "janedoe"
    }
  ],
  "username": "janedoe",
  "org_membership": [
    {
      "active": "true",
      "organization_id": 42,
      "role": "admin"
    }
  ],
  "active_organization": 42,
  "allow_newsletters": true,
  "custom_hotkeys": null,
  "date_joined": "2023-06-10T14:22:00Z",
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "+1-555-123-4567"
}

Retrieve details of the account that you are using to access the API.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Response

active_organization_metastringRead-only

avatarstringRead-only

idintegerRead-only

initialsstringRead-onlyDefaults to ?

last_activitydatetimeRead-only

lse_fieldsobject

organization_membershipobject

pausestringRead-only

permissionslist of stringsRead-only

social_accountslist of maps from strings to anyRead-only

usernamestring<=256 characters

org_membershiplist of objectsRead-onlyDeprecated

active_organizationinteger or null

allow_newslettersboolean or null

Allow sending newsletters to user

custom_hotkeysany or null

Custom keyboard shortcuts configuration for the user interface

date_joineddatetime

emailstringformat: "email"<=254 characters

first_namestring<=256 characters

last_namestring<=256 characters

phonestring<=256 characters