Users

GET List users

Retrieve a paginated list of users for the authenticated user's account

GEThttps://app.screendesk.io/api/v2/users

Authorization

BearerAuth

Query parameters

Response

200403500

Successful response

Body

*/*

paginationPaginationV2 (object)

usersarray of UserV2 (object)

Request

cURLJS

curl -X GET 'https://app.screendesk.io/api/v2/users?page=1' \
-H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
-H 'Content-Type: application/json'

Response

200

{
  "pagination": {
    "next_page": 0,
    "prev_page": 0,
    "last_page": 0,
    "page": 0,
    "items": 0,
    "pages": 0,
    "from": 0,
    "to": 0,
    "count": 0
  },
  "users": [
    {
      "email": "text",
      "name": "text",
      "has_avatar": false,
      "role": "text",
      "notifications": {
        "notify_first_view": "Enabled",
        "notify_new_account_recording": "Enabled",
        "notify_new_recording": "Enabled"
      },
      "created_at": "2024-12-21T12:28:34.971Z",
      "updated_at": "2024-12-21T12:28:34.971Z"
    }
  ]
}

GET Search for a specific user

Search for a specific user by their email

GEThttps://app.screendesk.io/api/v2/users/search

Authorization

BearerAuth

Query parameters

Response

200403404500

Successful response

Body

*/*

emailstring

namestring

has_avatarboolean

rolestring

notificationsobject

created_atstring (date-time)

updated_atstring (date-time)

Request

cURLJS

curl -X GET 'https://app.screendesk.io/api/v2/users/search?email=[e-mail]' \
-H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
-H 'Content-Type: application/json'

Response

200

{
  "email": "text",
  "name": "text",
  "has_avatar": false,
  "role": "text",
  "notifications": {
    "notify_first_view": "Enabled",
    "notify_new_account_recording": "Enabled",
    "notify_new_recording": "Enabled"
  },
  "created_at": "2024-12-21T12:28:34.971Z",
  "updated_at": "2024-12-21T12:28:34.971Z"
}