Users

List users

List the users that exist on the Label Studio server.

get/api/users/

Query parameters

orderingstring

Which field to use when ordering the results.

Response

active_organizationinteger nullable
active_organization_metaobject required
allow_newslettersboolean nullable

Allow sending newsletters to user

avatarstring nullable required
{"stackTrail":"components:schemas:LseUserAPI:properties:custom_hotkeys","oasType":"schema","type":"unknown","description":"Custom keyboard shortcuts configuration for the user interface","nullable":true}
date_joinedstring date-time
emailstring email
first_namestring
idinteger required
initialsstring required
last_activitystring date-time required
last_namestring
phonestring
usernamestring required

Changes

Changed in 2 of the 97 revisions of this API.44

    • added the required property items/org_membership/items/flex to the response with the 200 status

      response-required-property-added

    • added the required property items/org_membership/items/user_type to the response with the 200 status

      response-required-property-added

    • added the required property items/organization_membership/allOf[OrganizationMembership]/flex to the response with the 200 status

      response-required-property-added

    • added the required property items/organization_membership/allOf[OrganizationMembership]/user_type to the response with the 200 status

      response-required-property-added

    • the response property items/avatar became nullable for the status 200

      response-property-became-nullable

    • the items/active_organization_meta response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • the items/org_membership/items/active response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • the items/organization_membership/allOf[OrganizationMembership]/active response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

Of the 97 revisions, 1 has no diff computed.