CUcustomer
Customers

List customers, attributes, and devices

Changed on

Return attributes and devices for up to 100 customers by ID. If an ID in the request does not exist, the response omits it.

post/v1/customers/attributes

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/customers/attributes
  • Auth
    HTTP bearer

Query parameters

id_type'id' | 'email' | 'phone' | 'cio_id'

The type of customer_id you want to use to reference a person. If you don't provide this parameter, we assume that the customer_id in your request is a person's id. You can use email and phone only if they're enabled as identifiers in your workspace settings; otherwise the request returns 400. Reference phone values in E.164 format, like +14155552671, and URL-encode the leading + as %2B.

Request body

idsstring[] required

An array of up to 100 customer identifiers. All values must match the id_type query parameter—id values by default.

Response

Returns an array of customers. Each object represents a customer profile.

Example response

{
  "customers": [
    {
      "customer": {
        "id": "1",
        "attributes": {
          "_last_emailed": "1528932553",
          "created_at": "1489014595",
          "email": "test@example.com",
          "title": "tester",
          "department": "qa",
          "id": "1",
          "cio_id": "03000001",
          "cio_subscription_preferences": "{\"topics\":{\"topic_7\":false,\"topic_8\":false}}",
          "_cio_subscription_preferences_computed": "{\"topics\":{\"topic_6\":false,\"topic_7\":false,\"topic_8\":false}}"
        },
        "timestamps": {
          "cio_id": 1489014595,
          "_last_emailed": 1528932553,
          "created_at": 1489014595,
          "email": 1508932553,
          "id": 1489014595,
          "department": 1508932553,
          "title": 1508932553,
          "_cio_subscription_preferences_computed": 0,
          "cio_subscription_preferences": 1673987303
        },
        "unsubscribed": false,
        "devices": [
          {
            "id": "my_android_device_id",
            "last_used": 1514764800,
            "platform": "android",
            "token_type": "fid"
          },
          {
            "id": "my_ios_device_id",
            "last_used": 1514764800,
            "platform": "ios"
          }
        ]
      }
    }
  ]
}

Changes

  • 157b9f7600baRevision changes
    • breaking

      removed the required property ////// from the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added to the //// response property allOf list for the response status

    • info

      removed from the //// response property allOf list for the response status

  • 00b93971a49fRevision changes
    • info

      added the optional property ////////// to the response with the status