Sign in

v1

latestSwagger 2.02026-08-06291030.8 KB
Activity

Get activity by id

Retrieves the activity by it's id.

get/v1/activity/{activity_id}

Path parameters

activity_idstring required

ID of the activity

Response

activity retrieved successfully

idinteger

ID of the activity entry

contact_idinteger

Meta ID of the contact

activity_type_namestring

Name of the activity type

post_idstring

ID of Post

automation_namestring

Name of the Automation

campaign_namestring

Name of the Campaign

fieldsobject

Key/Value pairs of fields for the activity

last_updated_onstring date-time

Last updated timestamp

created_onstring date-time

Created timestamp

Example response

[
  {
    "id": 123,
    "contact_id": 456,
    "activity_type_name": "Purchased",
    "post_id": "123_533553",
    "automation_name": "Comment Reply Join Now",
    "campaign_name": "March Madness",
    "fields": {
      "Location": "New York",
      "Capacity": 100
    }
  }
]