v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

List all end-users

Returns a list of your end-users.

get/end-users

Response

Returns an object with a data property that contains an array of end-user objects. Each entry in the array is a separate end-user object. If no more end-users are available, the resulting array will be empty.

objectType'list' required

The type of object. This value is always "list".

urlstring required

The endpoint URL where this list can be accessed.

Example response

{
  "objectType": "list",
  "url": "/v1/end-users",
  "data": [
    {
      "id": "end_usr_1234567abcdefg",
      "objectType": "end_user",
      "createdAt": "2024-01-01T12:34:56.789Z",
      "companyName": "Acme Inc.",
      "sourceId": "12345678-abcd-abcd-example-1234567890ab",
      "email": "bob@acme.com",
      "integrationConnections": [
        {
          "id": "int_conn_1234567abcdefg",
          "objectType": "integration_connection",
          "createdAt": "2024-01-01T12:34:56.789Z",
          "lastRequestAt": "2024-01-01T12:34:56.789Z",
          "lastSuccessfulRequestAt": "2024-01-01T12:34:56.789Z"
        }
      ]
    }
  ]
}