SUsuprsend

List Users

Changed on

API to list cursor-based paginated list of users in your workspace.

Pass the optional tenant_id query parameter to list only users associated with that tenant. When the filter is applied, each user object in the response also carries a tenant block containing the tenant-scoped property and channel overrides for that user.

get/v1/user/

Request

Query parameters

limitinteger

number of results to be returned in API response (max 100)

afterstring

cursor to fetch the next page (from meta.after of the previous response)

beforestring

cursor to fetch the previous page (from meta.before of the previous response)

tenant_idstring

Filter users associated with the given tenant. When set, each result includes the tenant-scoped properties and channel overrides applied for this user under that tenant.

Response

200

Example response

{
  "meta": {
    "count": 1201709,
    "limit": 10,
    "has_next": true,
    "after": "01JXXXX99APxxxxxx8Wxxxx1B"
  },
  "results": [
    {
      "distinct_id": "_distinct_id_",
      "created_at": "2025-04-04T21:37:36.712496+00:00",
      "updated_at": "2025-04-04T21:37:36.743167+00:00"
    }
  ]
}

Changes

  • 5f0169085547Revision changes
    • info

      added the new optional query request parameter after

    • info

      added the new optional query request parameter before

    • info

      added the new optional query request parameter limit

  • 8bd2574bd2c3Revision changes
    • info

      added the new optional query request parameter tenant_id