activities

12 endpoints at a glance

Method	Path	Summary
GET	/activities	List Activities
POST	/activities	Create Activity
DELETE	/activities/{activity_id}	Delete Activity
GET	/activities/{activity_id}	Get Activity
PATCH	/activities/{activity_id}	Update Activity
POST	/activities/{activity_id}/participants	Add Participant
DELETE	/activities/{activity_id}/participants/{link_id}	Remove Participant
GET	/activities/for-entity	List For Entity
GET	/activity-types	List Types
POST	/activity-types	Create Type
DELETE	/activity-types/{key}	Delete Type
PATCH	/activity-types/{key}	Update Type

activities

---

List Activities

GET

/activities

Team-scope activity feed.

Default: everything the viewer can see — their own activities plus
activities logged by anyone against a shareable entity (project /
company / deal) the viewer can read. Pass entity_type +
entity_id to narrow to one record ("involving X").

Returns the standard list envelope plus a by_type breakdown over
the full filtered set (for the summary header).

Parameters

Header Parameters

authorization

Query Parameters

type

date_from

date_to

entity_type

entity_id

page

Type

integer

Default

1

limit

Type

integer

Default

50

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/activities

Playground

Headers

authorization

Variables

Key

Value

type

date_from

date_to

entity_type

entity_id

page

limit

Samples

---

Create Activity

POST

/activities

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"type": "string",

  

"subject": "string",

  

"body_md": "string",

  

"occurred_at": "string",

  

"duration_minutes": 0,

  

"outcome": "string",

  

"tag_ids": [

  

  

"string"

  

],

  

"links": [

  

  

{

  

  

  

"type": "string",

  

  

  

"id": "string",

  

  

  

"ref": {

  

  

  

  

"additionalProperties": "string"

  

  

  

}

  

  

}

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/activities

Playground

Headers

authorization

Body

Samples

---

List For Entity

GET

/activities/for-entity

Activities linked to one entity, newest-first.

Access is gated on the entity: any user who can read it sees all activities
logged for it, regardless of author (members of a shared project see each
other's call notes). For contact/person the timeline is sourced from
the shared person (ACL-filtered) so it survives the contact→person migration.

Parameters

Header Parameters

authorization

Query Parameters

entity_type*

Type

string

Required

entity_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/activities/for-entity

Playground

Headers

authorization

Variables

Key

Value

entity_type*

entity_id*

Samples

---

Get Activity

GET

/activities/{activity_id}

Parameters

Header Parameters

authorization

Path Parameters

activity_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/activities/{activity_id}

Playground

Headers

authorization

Variables

Key

Value

activity_id*

Samples

---

Delete Activity

DELETE

/activities/{activity_id}

Parameters

Header Parameters

authorization

Path Parameters

activity_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/activities/{activity_id}

Playground

Headers

authorization

Variables

Key

Value

activity_id*

Samples

---

Update Activity

PATCH

/activities/{activity_id}

Parameters

Header Parameters

authorization

Path Parameters

activity_id*

Type

string

Required

Request Body

application/json

{

  

"type": "string",

  

"subject": "string",

  

"body_md": "string",

  

"occurred_at": "string",

  

"duration_minutes": 0,

  

"outcome": "string",

  

"tag_ids": [

  

  

"string"

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/activities/{activity_id}

Playground

Headers

authorization

Variables

Key

Value

activity_id*

Body

Samples

---

Add Participant

POST

/activities/{activity_id}/participants

Link another entity to an existing activity (author only).

Requires read access to the entity being attached — same gate as
create-time linking, so you can't probe for hidden entities.

Parameters

Header Parameters

authorization

Path Parameters

activity_id*

Type

string

Required

Request Body

application/json

{

  

"type": "string",

  

"id": "string",

  

"ref": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/activities/{activity_id}/participants

Playground

Headers

authorization

Variables

Key

Value

activity_id*

Body

Samples

---

Remove Participant

DELETE

/activities/{activity_id}/participants/{link_id}

Unlink a participant edge from an activity (author only).

Parameters

Header Parameters

authorization

Path Parameters

activity_id*

Type

string

Required

link_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/activities/{activity_id}/participants/{link_id}

Playground

Headers

authorization

Variables

Key

Value

activity_id*

link_id*

Samples

---

List Types

GET

/activity-types

Built-in defaults + the user's custom types.

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/activity-types

Playground

Headers

authorization

Samples

---

Create Type

POST

/activity-types

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"label": "string",

  

"icon": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/activity-types

Playground

Headers

authorization

Body

Samples

---

Delete Type

DELETE

/activity-types/{key}

Remove a custom type. Activities already using it keep their value.

Parameters

Header Parameters

authorization

Path Parameters

key*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/activity-types/{key}

Playground

Headers

authorization

Variables

Key

Value

key*

Samples

---

Update Type

PATCH

/activity-types/{key}

Edit a custom type's label and/or icon. The key stays fixed.

Parameters

Header Parameters

authorization

Path Parameters

key*

Type

string

Required

Request Body

application/json

{

  

"label": "string",

  

"icon": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/activity-types/{key}

Playground

Headers

authorization

Variables

Key

Value

key*

Body

Samples

---