Skip to content
Voicebot

List users

GET
/v1/user
curl --request GET \
  --url 'https://example.com/v1/user?show_deleted=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
X-Account-Sid
string

Target account for account-scoped resources. Principals without an account scope (superuser, tenant API key) MUST send it to declare which account to operate in. Account-scoped principals may omit it; if sent it must match their own account or the request is rejected with scope_conflict. For tenant API keys the account must belong to the key’s tenant.

Query Parameters

Section titled “Query Parameters”
show_deleted
boolean

Include soft-deleted users in the listing.

order_by
string

Sort field. Accepted: created_at, name, email (default created_at).

order
string

Sort direction: asc | desc (default desc).

limit
integer
<= 500

Page size, max 500 (default 100); a larger value is rejected with 400.

offset
integer

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
items
required
Array<object>
object
sid
required
string
account_sid
required
string
email
required
string
name
required
string
roles
required
Array<string>
status
required
string
Allowed values: active inactive
has_password
required
boolean
last_login_at
required
string format: date-time
nullable
deleted_at
required
string format: date-time
nullable
total
required

Total matching users, ignoring paging.

integer format: int64
limit
required

Page size applied to this request.

integer
offset
required

Offset applied to this request.

integer
has_more
required

Whether records beyond this page match the query.

boolean
Example
{
  "items": [
    {
      "status": "active"
    }
  ]
}

400

Section titled “400”

Invalid request body or parameters

Media typeapplication/json
object
error
required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string
code
required

Registered machine code — generic ERRxxx by status class (ERR001–ERR020 reserved); entity-prefixed codes (SCN1xx) appear only inside validation details; registry in docs/specifications/error-envelope-design.md, append-only, never renumbered

string
message
required
string
data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object
topic
string
errors

Validation errors keyed by entity

object
scenario
Array<object>
object
code

SCN1xx constructor validation code

string
message
string
summary
string
tree_id
string
node_id
string
output_type
string
duplicate_tree_index
string
duplicate_node_index
string
property
string
invalid_value
string
agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}