Skip to main content
GET
/
api
/
user
List Users
curl --request GET \
  --url https://app.replay.sale/api/user \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "firstName": "<string>",
      "email": "jsmith@example.com",
      "role": "Rep",
      "createdAt": "2023-11-07T05:31:56Z",
      "lastName": "<string>",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "pagination": {
    "total": 1,
    "offset": 1,
    "limit": 500,
    "hasMore": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.replay.sale/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from your company settings.

Query Parameters

child_company_id
string<uuid>

Optional. When provided, operate on this child company instead of the caller's own company. The child must be a direct child of the caller — otherwise the request is rejected with 403.

Example:

"22222222-2222-4222-8222-222222222222"

offset
integer
default:0

Number of records to skip (default: 0)

Required range: x >= 0
limit
integer
default:100

Maximum records to return (default: 100, max: 1000)

Required range: 1 <= x <= 1000

Response

List of users. Default path returns the legacy paginated shape; child-scoped path returns { users: UserCrudResponse[] }.

data
object[]
required
pagination
object
required