LogoLogo
HomepageSign Up
Version 2.0.0
  • Product Docs
  • API Docs
  • Changelog
Version 2.0.0
  • Overview
  • Screendesk API
    • Overview
    • Authentication
    • Errors
    • Pagination
    • API Reference
      • Recordings
      • Users
  • SCIM / Autoprovisioning
    • Overview
    • Authentication
    • API Reference
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Screendesk API
  2. API Reference

Users

PreviousRecordingsNextOverview

Last updated 7 months ago

Was this helpful?

GET List users

get

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

Authorizations
Query parameters
pageintegerOptional

Page number for pagination

Responses
200
Successful response
application/json
403
Forbidden
500
Internal Server Error
get
curl -X GET 'https://app.screendesk.io/api/v2/users?page=1' \
-H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
-H 'Content-Type: application/json'
{
  "pagination": {
    "next_page": null,
    "prev_page": null,
    "last_page": 1,
    "page": 1,
    "items": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "count": 1
  },
  "users": [
    {
      "email": "text",
      "name": "text",
      "has_avatar": true,
      "role": "text",
      "notifications": {
        "notify_first_view": "Enabled",
        "notify_new_account_recording": "Enabled",
        "notify_new_recording": "Enabled"
      },
      "created_at": "2025-05-09T04:30:17.710Z",
      "updated_at": "2025-05-09T04:30:17.710Z"
    }
  ]
}

GET Search for a specific user

get

Search for a specific user by their email

Authorizations
Query parameters
emailstringRequired

Email of the user to search for

Responses
200
Successful response
application/json
403
Forbidden
404
Not Found
500
Internal Server Error
get
curl -X GET 'https://app.screendesk.io/api/v2/users/search?email=user@example.com' \
-H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
-H 'Content-Type: application/json'
{
  "email": "text",
  "name": "text",
  "has_avatar": true,
  "role": "text",
  "notifications": {
    "notify_first_view": "Enabled",
    "notify_new_account_recording": "Enabled",
    "notify_new_recording": "Enabled"
  },
  "created_at": "2025-05-09T04:30:17.710Z",
  "updated_at": "2025-05-09T04:30:17.710Z"
}
  • GETGET List users
  • GETGET Search for a specific user