> For the complete documentation index, see [llms.txt](https://docs.screendesk.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.screendesk.io/api/screendesk-api/api-reference/users.md).

# Users

## List users

> Returns a paginated list of all users in the account. Admin only.

```json
{"openapi":"3.0.3","info":{"title":"Screendesk API v2","version":"2.0.0"},"servers":[{"url":"https://app.screendesk.io/api/v2","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API token obtained from Screendesk account settings"}},"schemas":{"Pagination":{"type":"object","description":"Pagination metadata","properties":{"count":{"type":"integer","description":"Total number of records"},"page":{"type":"integer","description":"Current page number"},"items":{"type":"integer","description":"Number of items per page"},"pages":{"type":"integer","description":"Total number of pages"},"next_page":{"type":"integer","nullable":true,"description":"Next page number (absent if on last page)"},"prev_page":{"type":"integer","nullable":true,"description":"Previous page number (absent if on first page)"},"last_page":{"type":"integer","description":"Last page number"},"from":{"type":"integer","description":"Index of the first item on this page"},"to":{"type":"integer","description":"Index of the last item on this page"}}},"User":{"type":"object","properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"},"has_profile_picture":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"role":{"type":"string","description":"The user's role in the account","enum":["admin","member"]},"notifications":{"$ref":"#/components/schemas/UserNotifications"}}},"UserNotifications":{"type":"object","properties":{"notify_first_view":{"type":"string","enum":["Enabled","Disabled"]},"notify_all_recordings":{"type":"string","enum":["Enabled","Disabled"]},"notify_own_recordings":{"type":"string","enum":["Enabled","Disabled"]}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}},"required":["error"]}},"responses":{"Unauthorized":{"description":"Invalid or missing API token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"API access not enabled or insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/users":{"get":{"operationId":"listUsers","summary":"List users","description":"Returns a paginated list of all users in the account. Admin only.","tags":["Users"],"responses":{"200":{"description":"A paginated list of users","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/Pagination"},"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}}}}
```

## Search for a user by email

> Returns a single user matching the provided email address. Admin only.

```json
{"openapi":"3.0.3","info":{"title":"Screendesk API v2","version":"2.0.0"},"servers":[{"url":"https://app.screendesk.io/api/v2","description":"Production"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API token obtained from Screendesk account settings"}},"schemas":{"User":{"type":"object","properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"},"has_profile_picture":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"role":{"type":"string","description":"The user's role in the account","enum":["admin","member"]},"notifications":{"$ref":"#/components/schemas/UserNotifications"}}},"UserNotifications":{"type":"object","properties":{"notify_first_view":{"type":"string","enum":["Enabled","Disabled"]},"notify_all_recordings":{"type":"string","enum":["Enabled","Disabled"]},"notify_own_recordings":{"type":"string","enum":["Enabled","Disabled"]}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}},"required":["error"]}},"responses":{"Unauthorized":{"description":"Invalid or missing API token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"API access not enabled or insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/users/search":{"get":{"operationId":"searchUser","summary":"Search for a user by email","description":"Returns a single user matching the provided email address. Admin only.","tags":["Users"],"parameters":[{"name":"email","in":"query","required":true,"description":"The email address to search for","schema":{"type":"string","format":"email"}}],"responses":{"200":{"description":"User details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Missing email parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.screendesk.io/api/screendesk-api/api-reference/users.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.