v1

latestSwagger 2.0Private2026-08-04128286690.5 KB
Bulk Activities

GET Activity Status Collection

This endpoint returns a collection of activities. Use the state query parameter to include only activities with a specific status (processing, completed, cancelled, failed, or time_out). Use the limit query parameter to define the number of activities returned per page. Learn more.

get/activities

Query parameters

limitinteger

Specifies the number of results displayed per page of output, from 1 - 500, default = 50.

state'processing' | 'completed' | 'cancelled' | 'failed' | 'timed_out'

Use this parameter to filter the response to include only activities in one of the following states: cancelled, completed, failed, processing, or timed_out.

Response

Request Successful

Example response

{
  "activities": [
    {
      "activity_id": "86b90820-cc52-11ea-9dad-fa163e3d9194",
      "state": "initialized",
      "started_at": "2016-01-23T13:48:44.108Z",
      "completed_at": "2016-01-23T13:48:44.108Z",
      "created_at": "2016-01-23T13:48:44.108Z",
      "updated_at": "2016-01-23T13:48:44.108Z",
      "source_file_name": "2016-21-04-contact_import.xls",
      "percent_done": 75,
      "activity_errors": [
        "Message describing the error condition."
      ],
      "status": {
        "items_total_count": 2200,
        "items_completed_count": 2100,
        "person_count": 8750,
        "error_count": 1,
        "correctable_count": 1,
        "cannot_add_to_list_count": 1,
        "list_count": 3
      },
      "_links": {
        "self": {
          "href": "/v3/activities/04fe9a97-a579-43c5-bb1a-58ed29bf0a6a"
        },
        "results": {
          "href": "/v3/contacts_exports/04fe9a97-a579-43c5-bb1a-58ed29bf0a6a"
        }
      }
    }
  ],
  "_links": {
    "next": {
      "href": "/v3/activities/04fe9a97-a579-43c5-bb1a-58ed29bf0a6a"
    }
  }
}