v1

latestOpenAPI 3.0.22026-08-045831103.6 KB

Activities

Get activity

Retrieve a single activity by ID. Only returns activities belonging to the authenticated owner. Requires the ACTIVITIES_API feature flag and an API key with the activities:read scope. Unlike the list endpoint, this reads from the primary database and is always fresh.

get/v2/activities/{id}

Path parameters

idstring uuid required

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

UUID

Headers

api-tokenstring required

API Token

Response

An activity object

statusinteger

Response status

Example response

{
  "status": 200,
  "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"
      }
    }
  }
}