Go to Rilla

UserListResponse

One page of the user list from GET /export/users. Without limit, every user in your key's scope is on one page.

4 fieldsapplication/jsonDownload JSON Schema ↓

Fields

Required means the key is present; nullable means its value may be null. These are different. Examples are synthetic, complete for the documented fields, and not real customer data.

Users on this page, sorted by name.

currentPagenumberrequired

The page returned.

Example 1
totalPagesnumberrequired

Pages available; request the next page to get more.

Example 1
totalUsersnumberrequired

Users across all pages.

Example 1

Complete example

UserListResponse · complete example
{
  "users": [
    {
      "userId": "33333333-3333-4333-8333-333333333333",
      "email": "alex@example.com",
      "isRemoved": false,
      "role": "Sales Rep",
      "name": "Alex Morgan"
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalUsers": 1
}

All response types →

On this page