Get Contact Activity

Paginated activity log for a contact (checkouts, refunds, scans, emails, invoice payments).

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Path Parameters

idRequiredstring

Contact id, discoverable via list_contacts

Query Parameters

filterstring

Restrict to a single activity type

Value in:

"checkout_session_completed" | "product_set_checkout_session_completed" | "order_refunded" | "ticket_scanned" | "email_sent" | "invoice_paid"

sortstring

Default is newest-first; "oldest" reverses

Value in: "oldest"

pageNumberinteger

Default: 0Minimum: 0Maximum: 9007199254740991

pageSizeinteger

Default: 20Minimum: 1Maximum: 100

GET/v1/contacts/{id}/activity

curl -X GET "https://api.3common.com/v1/contacts/string/activity?filter=checkout_session_completed&sort=oldest" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": [
    {
      "_id": "string",
      "vendor_id": "string",
      "email": "string",
      "contact_id": "string",
      "type": "checkout_session_completed",
      "data": {
        "property1": null,
        "property2": null
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "hasMore": true,
  "pageNumber": -9007199254740991,
  "pageSize": -9007199254740991
}

TypeScript

export interface Response {
  data: {
    _id: string;
    vendor_id: string;
    email: string;
    contact_id?: string;
    type:
      | "checkout_session_completed"
      | "product_set_checkout_session_completed"
      | "order_refunded"
      | "ticket_scanned"
      | "email_sent"
      | "invoice_paid";
    data: {
      [k: string]: unknown;
    };
    createdAt: string;
    updatedAt: string;
  }[];
  hasMore: boolean;
  pageNumber: number;
  pageSize: number;
}