v3

latestSwagger 2.02026-08-067506752.0 MB

customer

Return all visible customers, paginated by name

get/v1/customer

Query parameters

fromstring

Customer id to start from

limitinteger

Number of results to return

statusstring

Customer.Status. (ACTIVE/INACTIVE/TRAIL)

trialAsOfstring date

Only return customers with a product trial in progress as of this date (range inclusive)

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "billAddress": {
        "street1": "123 Anywhere Street",
        "street2": "Apt 6L",
        "street3": "Sixth Floor",
        "city": "New York",
        "state": "NY",
        "country": "NY",
        "postal": "10001"
      },
      "products": [
        {
          "productId": "588f7ee98f138b19220041a7"
        }
      ],
      "trialProducts": [
        {
          "productId": "588f7ee98f138b19220041a7"
        }
      ],
      "featureOptionOverrides": [
        {
          "name": "smart_fields"
        }
      ],
      "createAt": "2017-01-24T13:57:52Z",
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      }
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}