Skip to content

recordings.md

Latest commit

 

History

History
101 lines (64 loc) · 3.57 KB

recordings.md

File metadata and controls

101 lines (64 loc) · 3.57 KB
Raw

Recordings

Most of the data structures in the Basecamp 5 API are represented as "Recordings", with generic actions available to be performed.

Endpoints:

Get recordings

  • GET /projects/recordings.json will return a paginated list of records for the given type of recording.

Required parameters: type, which must be Comment, Document, Door, Kanban::Card, Kanban::Step, Message, Question::Answer, Schedule::Entry, Todo, Todolist, Upload, or Vault.

Optional query parameters:

  • bucket - Single or comma separated list of project IDs. Default: All active projects visible to the current user.
  • status - Options: active, archived, or trashed. Default: active
  • sort - Options: created_at or updated_at. Default: created_at.
  • direction - Options: desc or asc. Default: desc.

Examples: /projects/recordings.json?type=Todo, /projects/recordings.json?type=Message&bucket=1, /projects/recordings.json?type=Document&bucket=1,2&sort=updated_at&direction=asc

Get a recording

  • GET /recordings/2.json will return the generic JSON representation of the recording with an ID of 2.

This endpoint is useful when you have a recording ID but do not yet know its specific type. The response includes the recording's type, which can then be used to follow up with the corresponding type-specific endpoint if needed.

Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://3.basecampapi.com/$ACCOUNT_ID/recordings/2.json

Trash a recording

  • PUT /recordings/2/status/trashed.json will mark the recording with an ID of 2 as trashed.

No parameters required. Returns 204 No Content if successful.

Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" -X PUT \
  https://3.basecampapi.com/$ACCOUNT_ID/recordings/2/status/trashed.json

Archive a recording

  • PUT /recordings/2/status/archived.json will mark the recording with an ID of 2 as archived.

No parameters required. Returns 204 No Content if successful.

Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" -X PUT \
  https://3.basecampapi.com/$ACCOUNT_ID/recordings/2/status/archived.json

Unarchive a recording

  • PUT /recordings/2/status/active.json will mark the recording with an ID of 2 as active.

No parameters required. Returns 204 No Content if successful.

Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" -X PUT \
  https://3.basecampapi.com/$ACCOUNT_ID/recordings/2/status/active.json

Legacy project-scoped routes

The following project-scoped routes are still supported and will remain available, but flat routes above are the canonical form for new integrations.