Customer.io
v1.0.0
OpenAPI 3.1.0

List activities

US region

Client Libraries
Shell Curl

List activities

​

This endpoint returns a list of "activities" for people, similar to your workspace's Activity Logs. This endpoint is guaranteed to return activity history within the past 30 days. It might return data older than 30 days in some circumstances, but activites older than 30 days are not guaranteed.

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.

  • type
    Type: string enum

    The type of activity you want to search for. Types with _o:<object_type_id> are for objects and types with _r:<object_type_id> are for relationships.

    The type of activity. Types with _o:<object_type_id> are for objects and types with _r:<object_type_id> are for relationships.

    values
    • add_relationship
    • anon_merge
    • attempted_action
    • attempted_email
    • attempted_in_app
  • name
    Type: string

    The name of the event or attribute you want to return.

  • deleted
    Type: boolean

    If true, return results for deleted people.

  • customer_id
    Type: string

    The identifier of the person you want to look up. By default, this is a person's id. You can use the id_type parameter to look up a person by email, phone, or cio_id.

    If you use a person's cio_id, you must prefix the value with cio_ when using it to find or reference a person (i.e. cio_03000010 for a cio_id value of 03000010).

  • id_type
    Type: string enum

    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
  • limit
    Type: integer
    max:  
    100

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

Responses
  • application/json
  • application/json
Request Example for get/v1/activities
curl https://api.customer.io/v1/activities \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "activities": [
    {
      "customer_id": "42",
      "customer_identifiers": {
        "cio_id": "a3000001",
        "email": "test@example.com",
        "id": 2
      },
      "data": {
        "delivered": null,
        "delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
        "opened": null
      },
      "delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
      "delivery_type": "email",
      "id": "01AK4N8V8G8KVA4HN8Y50CCZ59",
      "name": "string",
      "timestamp": 1397566226,
      "type": "sent_email",
      "url": "string"
    }
  ],
  "next": "string"
}

Returns an array of activities.