COconductor-is

List all end-users

Changed on

Returns a list of your end-users.

get/end-users

Request

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"
        }
      ]
    }
  ]
}

Changes

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property data/items/integrationConnections/items/lastRequestAt list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/integrationConnections/items/lastSuccessfulRequestAt list-of-types was widened by adding types null to media type application/json of response 200

  • 8e0b7df2044dRevision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • info

      response property data/items/integrationConnections/items/lastRequestAt list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/items/integrationConnections/items/lastSuccessfulRequestAt list-of-types was narrowed by removing types null from media type application/json of response 200