ESescape
Users

List users

List users of the organization. Filter by activation status with deactivated, and search by email with search. Pass cursor and size to page through the members: without them the whole organization is returned, as before.

get/users

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Query parameters

cursorstring

The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.

Example:R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5
sizeinteger

The number of items to return per page

Example:50
deactivated'true' | 'false'

Filter by activation status: true returns only deactivated users, false only active ones. Omit to return both.

Example:true
searchstring

Search users whose email contains this value

Example:alice@example.com

Response

OK

idstring uuid required

The id of the user

emailstring email required

The email of the user

createdAtstring date-time required

The date and time the user was created

activatedAtstring date-time nullable required

The date and time the user was activated

deactivatedAtstring date-time nullable required

The date and time the user was deactivated

firstLoginAtstring date-time nullable required

The date and time the user first logged in

lastLoginAtstring date-time nullable required

The date and time the user last logged in

Changes

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