Endpoints
List users
List Users with email, role, Org, alert phone, invite state and owned-Unit count, newest first. Filter by role name or search name and email; 20 results at a time by default, up to 500. Only the caller's Org; a super-admin sees every Org. Requires `users:read`.
GET /v1/users/list_users
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
page | query | No | string | Page number, from 1. |
limit | query | No | string | Rows per page, 1 to 500; default 20. |
role | query | No | string | Only Users whose role has this name, e.g. property_owner. |
search | query | No | string | Text to find in the name or email. |
scope | query | No | string | viewed_org keeps a super-admin's list to the Org they are viewing; others ignore it. |
Request examples
Set MYREMOTELY_BASE_URL to the environment you intend to call.
curl --fail-with-body \
--header "x-api-key: $MYREMOTELY_API_KEY" \
"$MYREMOTELY_BASE_URL/v1/users/list_users"const baseUrl = process.env.MYREMOTELY_BASE_URL
const apiKey = process.env.MYREMOTELY_API_KEY
if (!baseUrl || !apiKey) throw new Error('API base URL and key are required')
const response = await fetch(`${baseUrl}/v1/users/list_users`, {
method: 'GET',
headers: { 'x-api-key': apiKey },
})
if (!response.ok) throw new Error(`Request failed: ${response.status}`)
const data = await response.json()Responses
200 Success
application/json
| Field | Type | Required | Description |
|---|---|---|---|
data | array | Yes | — |
pagination | object | Yes | — |
{
"data": [
{
"id": "string",
"email": "string",
"name": "string",
"avatarUrl": "string",
"emailVerified": "string",
"orgId": "string",
"createdAt": "string",
"updatedAt": "string",
"isInvitePending": "string",
"notificationPhone": "string",
"role": "string",
"org": "string",
"_count": "string"
}
],
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"totalPages": 0,
"hasNext": false,
"hasPrev": false
}
}400 The list limit is outside the supported range or is not an integer.
application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | A stable documentation URI for this problem. |
title | string | Yes | A short problem title. |
detail | string | Yes | A safe explanation of this occurrence. |
code | string | Yes | A stable machine-readable problem code. |
requestId | string | Yes | The request ID to include when contacting MyRemotely support. |
status | number | Yes | The HTTP status code. |
{
"type": "https://app.myremotely.ai/en/docs/errors#invalid-request",
"title": "Invalid request",
"status": 400,
"detail": "The limit must be an integer from 1 to 100.",
"code": "invalid_request",
"requestId": "request_demo_01"
}401 The API key is missing, invalid, expired, or revoked.
application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | A stable documentation URI for this problem. |
title | string | Yes | A short problem title. |
detail | string | Yes | A safe explanation of this occurrence. |
code | string | Yes | A stable machine-readable problem code. |
requestId | string | Yes | The request ID to include when contacting MyRemotely support. |
status | number | Yes | The HTTP status code. |
{
"type": "https://app.myremotely.ai/en/docs/errors#invalid-api-key",
"title": "Unauthorized",
"status": 401,
"detail": "Provide a valid API key.",
"code": "invalid_api_key",
"requestId": "request_demo_01"
}403 The API key does not have the users:read scope.
application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | A stable documentation URI for this problem. |
title | string | Yes | A short problem title. |
detail | string | Yes | A safe explanation of this occurrence. |
code | string | Yes | A stable machine-readable problem code. |
requestId | string | Yes | The request ID to include when contacting MyRemotely support. |
status | number | Yes | The HTTP status code. |
{
"type": "https://app.myremotely.ai/en/docs/errors#missing-scope",
"title": "Forbidden",
"status": 403,
"detail": "The users:read scope is required.",
"code": "missing_scope",
"requestId": "request_demo_01"
}429 The API key request budget is exhausted.
application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | A stable documentation URI for this problem. |
title | string | Yes | A short problem title. |
detail | string | Yes | A safe explanation of this occurrence. |
code | string | Yes | A stable machine-readable problem code. |
requestId | string | Yes | The request ID to include when contacting MyRemotely support. |
status | number | Yes | The HTTP status code. |
{
"type": "https://app.myremotely.ai/en/docs/errors#rate-limited",
"title": "Too many requests",
"status": 429,
"detail": "Try the request again later.",
"code": "rate_limited",
"requestId": "request_demo_01"
}500 MyRemotely could not complete the request.
application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | A stable documentation URI for this problem. |
title | string | Yes | A short problem title. |
detail | string | Yes | A safe explanation of this occurrence. |
code | string | Yes | A stable machine-readable problem code. |
requestId | string | Yes | The request ID to include when contacting MyRemotely support. |
status | number | Yes | The HTTP status code. |
{
"type": "https://app.myremotely.ai/en/docs/errors#internal-error",
"title": "Internal error",
"status": 500,
"detail": "The request could not be completed.",
"code": "internal_error",
"requestId": "request_demo_01"
}Last updated Oct 3, 2026