List all end-users

curl --request GET \
  --url https://api.conductor.is/v1/end-users \
  --header 'Authorization: Bearer <token>'

{
  "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": "[email protected]",
      "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"
        }
      ]
    }
  ]
}

GET

end-users

List all end-users

curl --request GET \
  --url https://api.conductor.is/v1/end-users \
  --header 'Authorization: Bearer <token>'

{
  "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": "[email protected]",
      "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.

Show child attributes

data.id

string

required

The unique identifier for this end-user. You must save this value to your database because it is how you identify which of your users to receive your API requests.

Example:

"end_usr_1234567abcdefg"

data.objectType

string

required

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

Allowed value: "end_user"

Example:

"end_user"

data.createdAt

string

required

The date and time when this end-user record was created.

Example:

"2024-01-01T12:34:56.789Z"

data.companyName

string

required

The end-user's company name that will be shown elsewhere in Conductor.

Example:

"Acme Inc."

data.sourceId

string

required

The end-user's unique identifier from your system. Maps users between your database and Conductor.

Example:

"12345678-abcd-abcd-example-1234567890ab"

data.email

string

required

The end-user's email address for identification purposes.

Example:

"[email protected]"

data.integrationConnections

object[]

required

The end-user's integration connections.

Show child attributes

data.integrationConnections.id

string

required

The unique identifier for this integration connection.

Example:

"int_conn_1234567abcdefg"

data.integrationConnections.objectType

string

required

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

Allowed value: "integration_connection"

Example:

"integration_connection"

data.integrationConnections.createdAt

string

required

The date and time when this integration connection record was created.

Example:

"2024-01-01T12:34:56.789Z"

data.integrationConnections.integrationSlug

enum<string>

required

The identifier of the third-party platform to integrate.

Available options:

quickbooks_desktop

data.integrationConnections.lastRequestAt

string | null

required

The date and time of your last API request to this integration connection.

Example:

"2024-01-01T12:34:56.789Z"

data.integrationConnections.lastSuccessfulRequestAt

string | null

required

The date and time of your last successful API request to this integration connection. A successful request means the integration fully processed and returned a response without any errors end-to-end.

Example:

"2024-01-01T12:34:56.789Z"

Retrieve an end-user Delete an end-user

⌘I

QuickBooks Desktop API

Core Resources

Utilities

Transactions

General

Items

More

List all end-users

Authorizations

Response