ROrossum
User

List users

Changed on

Retrieve all user objects.

get/api/v1/users

Request

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

organizationinteger[]

Organization ID(s) filter

usernamestring

Username filter

first_namestring

First name filter

last_namestring

Last name filter

emailstring

Email filter

is_activeboolean

Filter by active/inactive status

last_loginstring date-time

Last login date filter

groupsstring

Filter by user groups

queueinteger[]

Queue ID(s) filter

deletedboolean

Filter by deleted status

ordering'id' | '-id' | 'username' | '-username' | 'first_name' | '-first_name' | 'last_name' | '-last_name' | 'email' | '-email' | 'last_login' | '-last_login' | 'date_joined' | '-date_joined' | 'deleted' | '-deleted' | 'not_deleted' | '-not_deleted'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 10775,
      "url": "https://example.rossum.app/api/v1/users/10775",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john-doe@east-west-trading.com",
      "phone_number": "+1-212-456-7890",
      "date_joined": "2018-09-19T13:44:56.000000Z",
      "username": "john-doe@east-west-trading.com",
      "groups": [
        "https://example.rossum.app/api/v1/groups/3"
      ],
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "queues": [
        "https://example.rossum.app/api/v1/queues/8199"
      ],
      "is_active": true,
      "last_login": "2019-02-07T16:20:18.652253Z",
      "ui_settings": {},
      "metadata": {
        "some_key": "some_value"
      },
      "auth_type": "password"
    }
  ]
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      removed the optional write-only property results/items/password from the response with the status

    • info

      added subschema #2 to the / response property allOf list for the response status