Object Events

get

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

objectIdstringRequired

Query parameters

afterstringOptional

limitnumberOptional

record_idstringOptional

external_idstringOptional

sync_tokenstringOptional

sourcestring · enumOptionalPossible values:

review_statusstring · enumOptionalPossible values:

event_typestringOptional

start_at_gtestringOptional

ISO 8601 format

start_at_ltestringOptional

ISO 8601 format

end_at_gtestringOptional

ISO 8601 format

end_at_ltestringOptional

ISO 8601 format

has_external_idbooleanOptional

Responses

200Success

application/json

and

get

/v1/objects/{objectId}/events

HTTPcURLJavaScriptPython

GET /v1/objects/{objectId}/events HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "paging": {
    "next": {
      "after": "text"
    }
  },
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "source": "external",
      "object": "text",
      "record_id": "text",
      "external_id": "text",
      "sync_token": "text",
      "event_type": "text",
      "start_at": "text",
      "end_at": "text",
      "location_object": "text",
      "location_record_id": "text",
      "location_record_label": "text",
      "review_status": "pending",
      "recommendation_reason": "text",
      "planning_strategy": "text"
    }
  ]
}

post

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

objectIdstringRequired

Body

application/json

namestringRequired

Label of the event

descriptionstring · nullableRequired

Description of the event

sourcestring · enumRequired

Source of the event: external, manual, or system_recommendation

Possible values:

record_idstringRequired

ID of the record in the object

external_idstring · nullableRequired

ID of the event in the external system

sync_tokenstring · nullableRequired

Token used to sync the event with external systems (auto-generated UUID if not provided)

event_typestring · nullableRequired

Type of event (e.g., meeting, call, visit, holiday)

start_atstringRequired

Start date and time of the event (ISO 8601 format)

end_atstringRequired

End date and time of the event (ISO 8601 format)

location_objectstring · nullableRequired

Object ID representing the location of the event

location_record_idstring · nullableRequired

Record ID in location object

location_record_labelstring · nullableRequired

Human-readable location label

review_statusstring · enum · nullableRequired

Status of the review: pending, approved, or rejected (default: approved)

Possible values:

recommendation_reasonstring · nullableRequired

Reason for system recommendation (only for system_recommendation source)

planning_strategystring · nullableRequired

Encoded planning strategy ID

Responses

200Success

application/json

idstringRequired

Unique ID

namestringRequired

Label of the event

descriptionstring · nullableRequired

Description of the event

sourcestring · enumRequired

Source of the event: external, manual, or system_recommendation

Possible values:

objectstringRequired

Object ID representing the object of the event

record_idstringRequired

ID of the record in the object

external_idstring · nullableRequired

ID of the event in the external system (ex. CRM)

sync_tokenstring · nullableRequired

Token used to sync the event with external systems having an async create API

event_typestring · nullableRequired

Type of event (e.g., meeting, call, visit, holiday)

start_atstringRequired

Start date and time of the event (ISO 8601 format)

end_atstringRequired

End date and time of the event (ISO 8601 format)

location_objectstring · nullableRequired

Encoded object ID for location

location_record_idstring · nullableRequired

Record ID in location object

location_record_labelstring · nullableRequired

Human-readable location label

review_statusstring · enumRequired

Status of the review: pending, approved, or rejected

Possible values:

recommendation_reasonstring · nullableRequired

Reason for system recommendation (only for system_recommendation source)

planning_strategystring · nullableRequired

Planning strategy ID (only for system_recommendation source)

post

/v1/objects/{objectId}/events

HTTPcURLJavaScriptPython

POST /v1/objects/{objectId}/events HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "name": "text",
  "description": "text",
  "source": "external",
  "record_id": "text",
  "external_id": "text",
  "sync_token": "text",
  "event_type": "text",
  "start_at": "text",
  "end_at": "text",
  "location_object": "text",
  "location_record_id": "text",
  "location_record_label": "text",
  "review_status": "pending",
  "recommendation_reason": "text",
  "planning_strategy": "text"
}

200Success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "source": "external",
  "object": "text",
  "record_id": "text",
  "external_id": "text",
  "sync_token": "text",
  "event_type": "text",
  "start_at": "text",
  "end_at": "text",
  "location_object": "text",
  "location_record_id": "text",
  "location_record_label": "text",
  "review_status": "pending",
  "recommendation_reason": "text",
  "planning_strategy": "text"
}

get

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

eventIdstringRequired

objectIdstringRequired

Responses

200Success

application/json

idstringRequired

Unique ID

namestringRequired

Label of the event

descriptionstring · nullableRequired

Description of the event

sourcestring · enumRequired

Source of the event: external, manual, or system_recommendation

Possible values:

objectstringRequired

Object ID representing the object of the event

record_idstringRequired

ID of the record in the object

external_idstring · nullableRequired

ID of the event in the external system (ex. CRM)

sync_tokenstring · nullableRequired

Token used to sync the event with external systems having an async create API

event_typestring · nullableRequired

Type of event (e.g., meeting, call, visit, holiday)

start_atstringRequired

Start date and time of the event (ISO 8601 format)

end_atstringRequired

End date and time of the event (ISO 8601 format)

location_objectstring · nullableRequired

Encoded object ID for location

location_record_idstring · nullableRequired

Record ID in location object

location_record_labelstring · nullableRequired

Human-readable location label

review_statusstring · enumRequired

Status of the review: pending, approved, or rejected

Possible values:

recommendation_reasonstring · nullableRequired

Reason for system recommendation (only for system_recommendation source)

planning_strategystring · nullableRequired

Planning strategy ID (only for system_recommendation source)

get

/v1/objects/{objectId}/events/{eventId}

HTTPcURLJavaScriptPython

GET /v1/objects/{objectId}/events/{eventId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "source": "external",
  "object": "text",
  "record_id": "text",
  "external_id": "text",
  "sync_token": "text",
  "event_type": "text",
  "start_at": "text",
  "end_at": "text",
  "location_object": "text",
  "location_record_id": "text",
  "location_record_label": "text",
  "review_status": "pending",
  "recommendation_reason": "text",
  "planning_strategy": "text"
}

put

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

eventIdstringRequired

objectIdstringRequired

Body

application/json

namestring · nullableRequired

Label of the event

descriptionstring · nullableRequired

Description of the event

sourcestring · enum · nullableRequired

Source of the event: external, manual, or system_recommendation

Possible values:

external_idstring · nullableRequired

ID of the event in the external system

sync_tokenstring · nullableRequired

Token used to sync the event with external systems

event_typestring · nullableRequired

Type of event (e.g., meeting, call, visit, holiday)

start_atstring · nullableRequired

Start date and time of the event (ISO 8601 format)

end_atstring · nullableRequired

End date and time of the event (ISO 8601 format)

location_objectstring · nullableRequired

Object ID for location

location_record_idstring · nullableRequired

Record ID in location object

location_record_labelstring · nullableRequired

Human-readable location label

review_statusstring · enum · nullableRequired

Status of the review: pending, approved, or rejected

Possible values:

recommendation_reasonstring · nullableRequired

Reason for system recommendation (only for system_recommendation source)

planning_strategystring · nullableRequired

Planning strategy ID (only for system_recommendation source)

Responses

200Success

application/json

idstringRequired

Unique ID

namestringRequired

Label of the event

descriptionstring · nullableRequired

Description of the event

sourcestring · enumRequired

Source of the event: external, manual, or system_recommendation

Possible values:

objectstringRequired

Object ID representing the object of the event

record_idstringRequired

ID of the record in the object

external_idstring · nullableRequired

ID of the event in the external system (ex. CRM)

sync_tokenstring · nullableRequired

Token used to sync the event with external systems having an async create API

event_typestring · nullableRequired

Type of event (e.g., meeting, call, visit, holiday)

start_atstringRequired

Start date and time of the event (ISO 8601 format)

end_atstringRequired

End date and time of the event (ISO 8601 format)

location_objectstring · nullableRequired

Encoded object ID for location

location_record_idstring · nullableRequired

Record ID in location object

location_record_labelstring · nullableRequired

Human-readable location label

review_statusstring · enumRequired

Status of the review: pending, approved, or rejected

Possible values:

recommendation_reasonstring · nullableRequired

Reason for system recommendation (only for system_recommendation source)

planning_strategystring · nullableRequired

Planning strategy ID (only for system_recommendation source)

put

/v1/objects/{objectId}/events/{eventId}

HTTPcURLJavaScriptPython

PUT /v1/objects/{objectId}/events/{eventId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 319

{
  "name": "text",
  "description": "text",
  "source": "external",
  "external_id": "text",
  "sync_token": "text",
  "event_type": "text",
  "start_at": "text",
  "end_at": "text",
  "location_object": "text",
  "location_record_id": "text",
  "location_record_label": "text",
  "review_status": "pending",
  "recommendation_reason": "text",
  "planning_strategy": "text"
}

200Success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "source": "external",
  "object": "text",
  "record_id": "text",
  "external_id": "text",
  "sync_token": "text",
  "event_type": "text",
  "start_at": "text",
  "end_at": "text",
  "location_object": "text",
  "location_record_id": "text",
  "location_record_label": "text",
  "review_status": "pending",
  "recommendation_reason": "text",
  "planning_strategy": "text"
}

delete

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

eventIdstringRequired

objectIdstringRequired

Responses

200Success

application/json

idstringRequired

isDeletedbooleanRequired

delete

/v1/objects/{objectId}/events/{eventId}

HTTPcURLJavaScriptPython

DELETE /v1/objects/{objectId}/events/{eventId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "text",
  "isDeleted": true
}