Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Activities

get

Get logged activity record by ID

Authorizations
X-API-KEYstringRequired
X-BUSINESS-IDstringRequired
X-USER-IDstringRequired
Path parameters
idstring · uuidRequired

A UUID string identifying this logged activity record.

Responses
200Success
application/json
idstring · uuidRequired
notesstringRequired
logged_atstring · date-timeRequired
completed_atstring · date-time · nullableRead-onlyRequired
scheduled_activity_idstring · uuid · nullableRead-onlyRequired
mentionsstring · uuid[]Read-onlyRequired
get/api/activities/logged/{id}
GET /api/activities/logged/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
Accept: */*
200Success
{
  "fields": [
    {
      "value": null,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "field_type": "text",
      "custom_field_type": "text",
      "name": "text",
      "display_name": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "notes": "text",
  "activity_object": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "api_name": "text",
    "association_mode": "text"
  },
  "associated_entities": [
    {
      "custom_object_id": "123e4567-e89b-12d3-a456-426614174000",
      "object_name": "text",
      "entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "display_name": "text",
      "custom_object_name": "text",
      "object_api_name": "text"
    }
  ],
  "logged_at": "2026-01-01T00:00:00.000Z",
  "logged_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "full_name": "text",
    "display_name": "text",
    "email": "name@gmail.com",
    "deleted": true
  },
  "completed_at": "2026-01-01T00:00:00.000Z",
  "completed_by": {
    "picture_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "first_name": "text",
    "last_name": "text",
    "email": "name@gmail.com",
    "display_name": "text",
    "account_type": "text"
  },
  "scheduled_activity_id": "123e4567-e89b-12d3-a456-426614174000",
  "mentions": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
get

List Scheduled Activities

Authorizations
X-API-KEYstringRequired
X-BUSINESS-IDstringRequired
X-USER-IDstringRequired
Query parameters
assigned_to_mebooleanOptional

Filter Scheduled Activities assigned to the logged in employee

Example: {"value":"True","summary":"Example 1"}
completedbooleanOptional

Filter Scheduled Activities that have had a logged activity

Example: {"value":"True","summary":"Example 1"}
from_datestring · dateOptional

Filter Scheduled Activities Due Datetime starting from date

Example: {"value":"2022-01-23","summary":"Example 1"}
orderingstringOptional

Order Scheduled Activities by field. The negative sign in front of the '-activity_object' indicates descending order

Example: {"value":"employee","summary":"Orders by Employees full name"}
pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional
to_datestring · dateOptional

Filter Scheduled Activities Due Datetime ending on date

Example: {"value":"2022-02-27","summary":"Example 1"}
Responses
200Success
application/json
countintegerRequiredExample: 123
nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4
previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2
errorsstring[] · nullableOptionalExample: ["error message"]
get/api/activities/scheduled-activity
GET /api/activities/scheduled-activity HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "associated_entities": [
        {
          "custom_object": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "object_name": "text"
          },
          "entity": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "email": "text",
            "display_name": "text"
          }
        }
      ],
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "note": "text",
      "due_datetime": "2026-01-01T00:00:00.000Z",
      "original_due_datetime": "2026-01-01T00:00:00.000Z",
      "completed_at": "2026-01-01T00:00:00.000Z",
      "logged_activity_id": "123e4567-e89b-12d3-a456-426614174000",
      "activity_object": "text",
      "employee": "text",
      "role": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "default_for_new_users": true
      },
      "mentions": {
        "picture_url": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "first_name": "text",
        "last_name": "text",
        "email": "name@gmail.com",
        "display_name": "text",
        "account_type": "text"
      },
      "associated_fields": "text",
      "notifications": "text",
      "created": "2026-01-01T00:00:00.000Z",
      "access": {
        "view": true,
        "edit": true,
        "remove": true
      }
    }
  ],
  "errors": [
    "error message"
  ]
}
post

Create scheduled activity

Authorizations
X-API-KEYstringRequired
X-BUSINESS-IDstringRequired
X-USER-IDstringRequired
Body
activity_object_idstring · uuidOptional
activity_object_namestring · min: 1 · nullableOptional
due_datetimestring · date-timeOptional
original_due_datetimestring · date-timeOptional
employee_idstring · uuid · nullableOptional
role_idstring · uuid · nullableOptional
notestringOptional
mentionsstring · uuid[]Optional
notify_mentionedbooleanOptionalDefault: false
Responses
201Success
application/json
idstring · uuidRequired
notestringRequired
due_datetimestring · date-timeRequired
original_due_datetimestring · date-timeRequired
completed_atstring · date-timeRequired
logged_activity_idstring · uuidRequired
activity_objectstringRequired
employeestringRequired
associated_fieldsstringRequired
notificationsstringRequired
createdstring · date-timeRequired
post/api/activities/scheduled-activity
POST /api/activities/scheduled-activity HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "activity_object_name": "call",
  "employee_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "due_datetime": "2024-01-20T15:00:00Z"
}
201Success
{
  "associated_entities": [
    {
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "object_name": "text"
      },
      "entity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "display_name": "text"
      }
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "note": "text",
  "due_datetime": "2026-01-01T00:00:00.000Z",
  "original_due_datetime": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z",
  "logged_activity_id": "123e4567-e89b-12d3-a456-426614174000",
  "activity_object": "text",
  "employee": "text",
  "role": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "default_for_new_users": true
  },
  "mentions": {
    "picture_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "first_name": "text",
    "last_name": "text",
    "email": "name@gmail.com",
    "display_name": "text",
    "account_type": "text"
  },
  "associated_fields": "text",
  "notifications": "text",
  "created": "2026-01-01T00:00:00.000Z",
  "access": {
    "view": true,
    "edit": true,
    "remove": true
  }
}
get

Get scheduled activity record by ID

Authorizations
X-API-KEYstringRequired
X-BUSINESS-IDstringRequired
X-USER-IDstringRequired
Path parameters
idstringRequiredPattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$
Responses
200Success
application/json
idstring · uuidRequired
notestringRequired
due_datetimestring · date-timeRequired
original_due_datetimestring · date-timeRequired
completed_atstring · date-timeRequired
logged_activity_idstring · uuidRequired
activity_objectstringRequired
employeestringRequired
associated_fieldsstringRequired
notificationsstringRequired
createdstring · date-timeRequired
get/api/activities/scheduled-activity/{id}
GET /api/activities/scheduled-activity/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
Accept: */*
200Success
{
  "associated_entities": [
    {
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "object_name": "text"
      },
      "entity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "display_name": "text"
      }
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "note": "text",
  "due_datetime": "2026-01-01T00:00:00.000Z",
  "original_due_datetime": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z",
  "logged_activity_id": "123e4567-e89b-12d3-a456-426614174000",
  "activity_object": "text",
  "employee": "text",
  "role": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "default_for_new_users": true
  },
  "mentions": {
    "picture_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "first_name": "text",
    "last_name": "text",
    "email": "name@gmail.com",
    "display_name": "text",
    "account_type": "text"
  },
  "associated_fields": "text",
  "notifications": "text",
  "created": "2026-01-01T00:00:00.000Z",
  "access": {
    "view": true,
    "edit": true,
    "remove": true
  }
}
delete

Delete Scheduled Activity partially

Authorizations
X-API-KEYstringRequired
X-BUSINESS-IDstringRequired
X-USER-IDstringRequired
Path parameters
idstringRequiredPattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$
Responses
204

No response body

No content
delete/api/activities/scheduled-activity/{id}
DELETE /api/activities/scheduled-activity/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
Accept: */*
204

No response body

No content
patch

Update Scheduled Activity partially

Authorizations
X-API-KEYstringRequired
X-BUSINESS-IDstringRequired
X-USER-IDstringRequired
Path parameters
idstringRequiredPattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$
Body
activity_object_idstring · uuidOptional
activity_object_namestring · min: 1 · nullableOptional
due_datetimestring · date-timeOptional
original_due_datetimestring · date-timeOptional
employee_idstring · uuid · nullableOptional
role_idstring · uuid · nullableOptional
notestringOptional
mentionsstring · uuid[]Optional
notify_mentionedbooleanOptionalDefault: false
Responses
200Success
application/json
idstring · uuidRequired
notestringRequired
due_datetimestring · date-timeRequired
original_due_datetimestring · date-timeRequired
completed_atstring · date-timeRequired
logged_activity_idstring · uuidRequired
activity_objectstringRequired
employeestringRequired
associated_fieldsstringRequired
notificationsstringRequired
createdstring · date-timeRequired
patch/api/activities/scheduled-activity/{id}
PATCH /api/activities/scheduled-activity/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
Content-Type: application/json
Accept: */*
Content-Length: 620

{
  "activity_object_id": "123e4567-e89b-12d3-a456-426614174000",
  "activity_object_name": "text",
  "due_datetime": "2026-01-01T00:00:00.000Z",
  "original_due_datetime": "2026-01-01T00:00:00.000Z",
  "employee_id": "123e4567-e89b-12d3-a456-426614174000",
  "role_id": "123e4567-e89b-12d3-a456-426614174000",
  "note": "text",
  "mentions": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "notifications": [
    {
      "type": "email",
      "time_amount": 1,
      "time_unit": "minute"
    }
  ],
  "associated_entities": [
    {
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "entity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      }
    }
  ],
  "notify_mentioned": false
}
200Success
{
  "associated_entities": [
    {
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "object_name": "text"
      },
      "entity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "display_name": "text"
      }
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "note": "text",
  "due_datetime": "2026-01-01T00:00:00.000Z",
  "original_due_datetime": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z",
  "logged_activity_id": "123e4567-e89b-12d3-a456-426614174000",
  "activity_object": "text",
  "employee": "text",
  "role": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "default_for_new_users": true
  },
  "mentions": {
    "picture_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "first_name": "text",
    "last_name": "text",
    "email": "name@gmail.com",
    "display_name": "text",
    "account_type": "text"
  },
  "associated_fields": "text",
  "notifications": "text",
  "created": "2026-01-01T00:00:00.000Z",
  "access": {
    "view": true,
    "edit": true,
    "remove": true
  }
}
PreviousKizen API Reference
NextPermissions

Last updated

Was this helpful?