List users | API Reference

[
  {
    "active_organization_meta": {},
    "avatar": "string",
    "id": 1,
    "initials": "?",
    "last_activity": "2024-01-15T09:30:00Z",
    "organization_membership": {
      "active": true,
      "flex": {},
      "organization_id": 1,
      "role": "string",
      "user_type": "string"
    },
    "username": "string",
    "org_membership": [
      {
        "active": true,
        "flex": {},
        "organization_id": 1,
        "role": "string",
        "user_type": "string"
      }
    ],
    "active_organization": 1,
    "allow_newsletters": true,
    "custom_hotkeys": null,
    "date_joined": "2024-01-15T09:30:00Z",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string"
  }
]

List the users that exist on the Label Studio server.

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>

Query parameters

orderingstringOptional

Which field to use when ordering the results.

Response

active_organization_metamap from strings to stringsRead-only

avatarstring or nullRead-only

idintegerRead-only

initialsstringRead-onlyDefaults to ?

last_activitydatetimeRead-only

organization_membershipobject

usernamestring<=256 characters

org_membershiplist of objectsRead-onlyDeprecated

active_organizationinteger or nullOptional

allow_newslettersboolean or nullOptional

Allow sending newsletters to user

custom_hotkeysany or nullOptional

Custom keyboard shortcuts configuration for the user interface

date_joineddatetimeOptional

emailstringOptionalformat: "email"<=254 characters

first_namestringOptional<=256 characters

last_namestringOptional<=256 characters

phonestringOptional<=256 characters

$	curl http://localhost:8000/api/users/ \
>	-H "Authorization: Token <api_key>"