List users | API Reference

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

[
  {
    "active_organization_meta": "Acme Corp",
    "avatar": "https://labelstud.io/static/avatars/user42.png",
    "id": 42,
    "initials": "JD",
    "last_activity": "2024-04-10T08:15:30Z",
    "organization_membership": {
      "active": "true",
      "organization_id": 42,
      "role": "admin"
    },
    "username": "janedoe",
    "org_membership": [
      {
        "active": "true",
        "organization_id": 42,
        "role": "admin"
      }
    ],
    "active_organization": 42,
    "allow_newsletters": false,
    "date_joined": "2023-11-20T14:22:00Z",
    "email": "jane.doe@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "phone": "+1-555-123-4567"
  }
]

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:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

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_metastringRead-only

avatarstringRead-only

idintegerRead-only

initialsstringRead-onlyDefaults to ?

last_activitydatetimeRead-only

organization_membershipobject

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