Customer.io
v1.0.0
OpenAPI 3.1.0

Lookup a customer's relationships

US region

Client Libraries
Shell Curl

Lookup a customer's relationships

​

Return a list of objects that a person is related to.

You can use the start parameter with the next property in responses to return pages of results. However, it's possible that you'll see duplicate entries across pages. If you want to export objects or relationships, you may want to use the export feature in our UI to return complete results.

Path Parameters
  • customer_id
    Type: string
    required

    The ID of the customer you want to perform an operation against.

Query Parameters
  • id_type
    Type: stringenum

    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.

    values
    • id
    • email
    • phone
    • cio_id
  • start
    Type: string

    The token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.

  • limit
    Type: integer

    The maximum number of results you want to retrieve per page.

Responses
  • application/json
  • 404

    The customer_id does not exist.

  • 429

    Your request is over the 10-per-second limit.

Request Example for get/v1/customers/{customer_id}/relationships
curl 'https://api.customer.io/v1/customers/12345/relationships?id_type=id&start=&limit=1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "cio_relationships": [
    {
      "object_type_id": 1,
      "identifiers": {
        "object_id": "string",
        "cio_object_id": "string"
      },
      "attributes": {
        "Object Attributes": null
      },
      "timestamps": {
        "Object Attribute Timestamps": 1
      }
    }
  ],
  "next": "string"
}

Returns an array of cio_relationships.