Customer.io
v1.0.0
OpenAPI 3.1.0

Get Object Relationships

US region

Client Libraries
Shell Curl

Get Object Relationships

​

Get a list of people people related to an object.

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
  • object_type_id
    Type: integer
    required

    The object type an object belongs to—like "Companies" or "Accounts". Object type IDs begin at 1 and increment for each new type.

  • object_id
    Type: string
    required

    The object_id or cio_object_id of an object, depending on the id_type specified in query params. id_type defaults to object_id.

Query Parameters
  • 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.

  • id_type
    Type: stringenum
    values
    • object_id
    • cio_object_id
Responses
  • application/json
  • 401

    Unauthorized request. Make sure that you provided the right credentials.

  • 429

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

Request Example for get/v1/objects/{object_type_id}/{object_id}/relationships
curl 'https://api.customer.io/v1/objects/1/abc123/relationships?start=&limit=1&id_type=object_id' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "cio_relationships": [
    [
      {
        "identifiers": {
          "cio_id": "ob020101",
          "id": "acmeInc"
        },
        "object_type_id": "1",
        "object_type_disabled": false
      }
    ]
  ],
  "next": "string"
}

Returns an array of cio_relationships. Each object in the array represents a person related to the object specified in the endpoint path.