HTTP API: events

The 5 operations tagged events, each with its parameters, its body and what it answers.

What happened to this document

GET /v1/documents/{id_or_ref}/events

Return this item's history, newest first.

Parameters

• workspace_id (string or null, in query): Which workspace, by id or slug. Needed when you can reach several.
• order (string or null, in query): '-seq' (default, newest first) or 'seq' for oldest first.
• limit (integer or null, in query): How many to return. At least 1; capped at the instance's max_page_size.
• cursor (string or null, in query): Continue after a page.
• format (string or null, in query): 'full' (default), 'compact' for one aligned line per item, or 'ids' for the addresses alone. Compact is roughly a twentieth the size of full.
• fields (string or null, in query): Comma-separated field names to return instead of the whole item, e.g. 'ref,title,due_at'. GET /v1/meta lists what each entity has. Cannot be combined with 'format'.

Responses

• 200: Collection_Event_. Successful Response
• 422: HTTPValidationError. Validation Error

What happened to this document, with what was said

GET /v1/documents/{id_or_ref}/journal

Return what happened to this item, newest first, with who did it and what they said.

The same entries /v1/journal gives about this item, read from this item's history: who did each thing and through which door, what a change moved between, and how a comment on it opens. No entry carries a whole text, and /events beside this has every change whole.

Parameters

• workspace_id (string or null, in query): Which workspace, by id or slug. Needed when you can reach several.
• order (string or null, in query): '-seq' (default, newest first) or 'seq' for oldest first.
• limit (integer or null, in query): How many to return. At least 1; capped at the instance's max_page_size.
• cursor (string or null, in query): Continue after a page.
• format (string or null, in query): 'full' (default), 'compact' for one aligned line per item, or 'ids' for the addresses alone. Compact is roughly a twentieth the size of full.
• fields (string or null, in query): Comma-separated field names to return instead of the whole item, e.g. 'ref,title,due_at'. GET /v1/meta lists what each entity has. Cannot be combined with 'format'.

Responses

• 200: Collection_JournalEntry_. Successful Response
• 422: HTTPValidationError. Validation Error

What happened to this project

GET /v1/projects/{id_or_key}/events

Return this item's history, newest first.

Parameters

• workspace_id (string or null, in query): Which workspace, by id or slug. Needed when you can reach several.
• order (string or null, in query): '-seq' (default, newest first) or 'seq' for oldest first.
• limit (integer or null, in query): How many to return. At least 1; capped at the instance's max_page_size.
• cursor (string or null, in query): Continue after a page.
• format (string or null, in query): 'full' (default), 'compact' for one aligned line per item, or 'ids' for the addresses alone. Compact is roughly a twentieth the size of full.
• fields (string or null, in query): Comma-separated field names to return instead of the whole item, e.g. 'ref,title,due_at'. GET /v1/meta lists what each entity has. Cannot be combined with 'format'.

Responses

• 200: Collection_Event_. Successful Response
• 422: HTTPValidationError. Validation Error

What happened to this task

GET /v1/tasks/{id_or_ref}/events

Return this item's history, newest first.

Parameters

• workspace_id (string or null, in query): Which workspace, by id or slug. Needed when you can reach several.
• order (string or null, in query): '-seq' (default, newest first) or 'seq' for oldest first.
• limit (integer or null, in query): How many to return. At least 1; capped at the instance's max_page_size.
• cursor (string or null, in query): Continue after a page.
• format (string or null, in query): 'full' (default), 'compact' for one aligned line per item, or 'ids' for the addresses alone. Compact is roughly a twentieth the size of full.
• fields (string or null, in query): Comma-separated field names to return instead of the whole item, e.g. 'ref,title,due_at'. GET /v1/meta lists what each entity has. Cannot be combined with 'format'.

Responses

• 200: Collection_Event_. Successful Response
• 422: HTTPValidationError. Validation Error

What happened to this task, with what was said

GET /v1/tasks/{id_or_ref}/journal

Return what happened to this item, newest first, with who did it and what they said.

The same entries /v1/journal gives about this item, read from this item's history: who did each thing and through which door, what a change moved between, and how a comment on it opens. No entry carries a whole text, and /events beside this has every change whole.

Parameters

• workspace_id (string or null, in query): Which workspace, by id or slug. Needed when you can reach several.
• order (string or null, in query): '-seq' (default, newest first) or 'seq' for oldest first.
• limit (integer or null, in query): How many to return. At least 1; capped at the instance's max_page_size.
• cursor (string or null, in query): Continue after a page.
• format (string or null, in query): 'full' (default), 'compact' for one aligned line per item, or 'ids' for the addresses alone. Compact is roughly a twentieth the size of full.
• fields (string or null, in query): Comma-separated field names to return instead of the whole item, e.g. 'ref,title,due_at'. GET /v1/meta lists what each entity has. Cannot be combined with 'format'.

Responses

• 200: Collection_JournalEntry_. Successful Response
• 422: HTTPValidationError. Validation Error