Sign in

v1

latestOpenAPI 3.0.22026-08-045831103.6 KB
Activities

List activities

Retrieve a paginated list of deal activities, filterable by type, activity status, deal status, origin, stage, assigned user, deal, free text, tags, and a date range. Requires the ACTIVITIES_API feature flag and an API key with the activities:read scope.

Consistency note: listing is served from the search index and is eventually consistent (typically seconds behind writes). GET /v2/activities/:id reads from the primary database and is always fresh — poll that endpoint instead of the list if you need to confirm a just-written change.

get/v2/activities

Query parameters

typestring
Example:CALL,TASK

Comma-separated list of activity types to filter by (CALL, MAIL, SCHEDULE, TASK, MEETING, WHATSAPP, INSTAGRAM).

activity_statusstring
Example:DELAYED,ON_TIME

Comma-separated list of activity statuses to filter by (DELAYED, ON_TIME, COMPLETE, IGNORED).

deal_statusstring
Example:OPEN

Comma-separated list of deal statuses to filter by (OPEN, WON, LOST).

origin_idsstring
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Comma-separated list of origin UUIDs to filter by.

stage_idsstring
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Comma-separated list of stage UUIDs to filter by.

user_idstring uuid
Example:7c9e6679-7425-40de-944b-e07fc1f90ae7

Filter by the deal's assigned user (single UUID).

deal_idstring uuid
Example:550e8400-e29b-41d4-a716-446655440000

Filter by a single deal UUID.

textstring
Example:follow up

Free-text search across the activity title and content.

tagsstring
Example:tag-uuid-1,tag-uuid-2

Comma-separated list of tag UUIDs. An activity matches when its deal has any of these tags.

tags_excludestring
Example:tag-uuid-1

Comma-separated list of tag UUIDs to exclude. An activity is excluded when its deal has any of these tags.

date_type'due' | 'created' | 'won' | 'lost'
Example:due

Which date field date_start/date_end filter against. due (default) is the activity's due date, created is when the activity was created, won/lost are the deal's won_at/lost_at.

date_startstring date-time
Example:2024-01-01T00:00:00.000Z

Inclusive start of the date range (ISO 8601), applied to the field selected by date_type.

date_endstring date-time
Example:2024-01-31T23:59:59.999Z

Inclusive end of the date range (ISO 8601), applied to the field selected by date_type.

limitinteger

Max number of rows returned

pageinteger

Select the page of the result

Headers

api-tokenstring required

API Token

Response

A paginated list of activities

statusinteger

Response status

total_countinteger

Total items based on current filters

pageinteger

Current page

total_pagesinteger

Total pages based on current filters

has_nextboolean

Indicates that has next page

has_previousboolean

Indicates that has previous page

Example response

{
  "status": 200,
  "total_count": 50,
  "page": 1,
  "total_pages": 10,
  "has_next": true,
  "data": [
    {
      "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "title": "Call the customer back",
      "type": "CALL",
      "content": "Discuss the renewal proposal.",
      "due_at": "2024-01-20T14:00:00.000Z",
      "custom": true,
      "stage_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "created_at": "2020-01-01T14:15:00.000000+00:00",
      "deal": {
        "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
        "status": "OPEN",
        "origin_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
        "stage_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
        "contact": {
          "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
          "name": "Jane Doe"
        }
      }
    }
  ]
}