Skip to main content
GET
/
end-users
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'sk_conductor_...',
});

const endUsers = await conductor.endUsers.list();

console.log(endUsers.data);
{
  "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",
          "integrationSlug": "quickbooks_desktop",
          "lastRequestAt": "2024-01-01T12:34:56.789Z",
          "lastSuccessfulRequestAt": "2024-01-01T12:34:56.789Z"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Response

200 - application/json

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
string
required

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

Allowed value: "list"
Example:

"list"

​
url
string
required

The endpoint URL where this list can be accessed.

Example:

"/v1/end-users"

​
data
object[]
required

The array of end-users.