CRcrowdin
Users

List Users

Required scopes: user (Read only).

get/users

Request

Query parameters

orderBy'id' | 'username' | 'firstName' | 'lastName' | 'email' | 'status' | 'createdAt' | 'lastSeen'

Read more about sorting rules

status'active' | 'pending' | 'blocked'

Filter users by status

searchstring

Search users by firstName, lastName, username, or email

twoFactor'enabled' | 'disabled'

Filter users by two-factor authentication status

organizationRolesstring

Filter by role in organization. It can be one role or a list of comma-separated ones.

Possible values: admin, manager, vendor, client

teamIdinteger

Filter by team identifier. Get via List Teams

projectIdsstring

Filter by project identifier. Get via List Projects. It can be one project or a list of comma-separated ones

projectRolesstring

Filter by role in project. It can be one role or a list of comma-separated ones.

Possible values: manager, developer, translator, proofreader, language_coordinator, member

languageIdsstring

Filter project languages. Get via List Supported Languages. It can be one language or a list of comma-separated ones

groupIdsstring

Filter by group identifier. Get via List Groups. It can be one group or a list of comma-separated ones

lastSeenFromstring

Date in UTC, ISO 8601.

NOTE: Must be used together with lastSeenTo

lastSeenTostring

Date in UTC, ISO 8601.

NOTE: Must be used together with lastSeenFrom

limitinteger

A maximum number of items to retrieve

offsetinteger

A starting offset in the collection

Response

Users list

Example response

{
  "data": [
    {
      "data": {
        "id": 12,
        "username": "john_smith",
        "firstName": "John",
        "lastName": "Smith",
        "fields": {
          "some-field-1": "some value 1",
          "some-field-2": 12,
          "some-field-3": true,
          "some-field-4": [
            "en",
            "ja"
          ]
        },
        "isAdmin": true,
        "status": "active",
        "createdAt": "2019-07-11T07:40:22+00:00",
        "lastSeen": "2019-10-23T11:44:02+00:00",
        "email": "jsmith@example.com",
        "twoFactor": "enabled",
        "timezone": "Europe/Kyiv",
        "joinDetails": {
          "type": "privateInvitation",
          "invitedBy": {
            "id": 19,
            "username": "john_doe",
            "fullName": "John Smith"
          }
        },
        "deviceVerification": "enabled",
        "loginMethods": [
          "crowdin"
        ],
        "mfaMethods": [
          "authenticatorApp"
        ]
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.