Skip to content
Changelog

Report a bug

Basecamp integration: operations for AI agents

Basecamp connects to Type.com as an integration. This page lists the 292 operations documented for Claude and Codex in Type.com: 138 read, 65 write, 89 destructive.

About Basecamp

Project management and team collaboration tool by 37signals

Categories: Productivity & Project Management

How to connect Basecamp to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

292 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

292 operations listed.

Account

  • Read

    Get Account

    Get the account for the current access token

    GET /{accountId}/account.json

  • Destructive

    Update Account Name

    Rename the current account. Only account owners can use this endpoint.

    PUT /{accountId}/account/name.json

Files

  • Read

    Get Cloud File

    Get a single cloud file by id

    GET /{accountId}/cloud_files/{cloudFileId}

  • Read

    Get Document

    Get a single document by id

    GET /{accountId}/documents/{documentId}

  • Read

    Get Google Document

    Get a single Google document by id

    GET /{accountId}/google_documents/{googleDocumentId}

  • Read

    Get Upload

    Get a single upload by id

    GET /{accountId}/uploads/{uploadId}

  • Read

    List Upload Versions

    List versions of an upload Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/uploads/{uploadId}/versions.json

  • Read

    Get Vault

    Get a single vault by id

    GET /{accountId}/vaults/{vaultId}

  • Read

    List Documents

    List documents in a vault Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/vaults/{vaultId}/documents.json

  • Read

    List Uploads

    List uploads in a vault Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/vaults/{vaultId}/uploads.json

  • Read

    List Vaults

    List vaults (subfolders) in a vault Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/vaults/{vaultId}/vaults.json

  • Write

    Create Attachment

    Create an attachment (upload a file for embedding)

    POST /{accountId}/attachments.json

  • Write

    Create Cloud File

    Create a new cloud file in a vault. url is validated against the selected service's patterns, so it must be a real link for that service; use service "other" for anything that matches no recognized service. Omitting title is allowed and reads back as "Untitled".

    POST /{accountId}/buckets/{bucketId}/vaults/{vaultId}/cloud_files.json

  • Write

    Create Google Document

    Create a new Google document in a vault. An unrecognized documenttype is rejected before validation with the field-keyed 422 {"errors": {"documenttype": ["is not a valid document type"]}} — the enum would otherwise raise rather than add an error.

    POST /{accountId}/buckets/{bucketId}/vaults/{vaultId}/google_documents.json

  • Write

    Create Upload Version

    Replace an upload's file with a new version The recording keeps its id, its URL and its comments; the previous file becomes a past version. Use this instead of CreateUpload when publishing a new release of the same file, so its published link keeps working.

    POST /{accountId}/uploads/{uploadId}/versions.json

  • Write

    Create Document

    Create a new document in a vault

    POST /{accountId}/vaults/{vaultId}/documents.json

  • Write

    Create Upload

    Create a new upload in a vault

    POST /{accountId}/vaults/{vaultId}/uploads.json

  • Write

    Create Vault

    Create a new vault (subfolder) in a vault

    POST /{accountId}/vaults/{vaultId}/vaults.json

  • Destructive

    Update Cloud File

    Replace a cloud file with a new complete representation. BC3 builds a brand-new CloudFile from the permitted params and swaps the recordable wholesale, so the request body is the full writable state: omitting title clears it (and the cloud file then reads back as "Untitled"), an…

    PUT /{accountId}/cloud_files/{cloudFileId}

  • Destructive

    Replace Document

    Replace a document with a new complete representation. The request body is the document's full writable state: any writable field omitted from the request is cleared server-side.

    PUT /{accountId}/documents/{documentId}

  • Destructive

    Update Google Document

    Replace a Google document with a new complete representation.

    PUT /{accountId}/google_documents/{googleDocumentId}

  • Destructive

    Update Upload

    Update an existing upload

    PUT /{accountId}/uploads/{uploadId}

  • Destructive

    Update Vault

    Update an existing vault

    PUT /{accountId}/vaults/{vaultId}

Boosts

  • Read

    Get Boost

    Get a single boost

    GET /{accountId}/boosts/{boostId}

  • Read

    List Recording Boosts

    List boosts on a recording

    GET /{accountId}/recordings/{recordingId}/boosts.json

  • Read

    List Event Boosts

    List boosts on a specific event within a recording. Only boostable events carry boosts: those whose action is completed, adopted, columnchanged or movedin (their JSON includes boostscount and boostsurl).

    GET /{accountId}/recordings/{recordingId}/events/{eventId}/boosts.json

  • Write

    Create Recording Boost

    Create a boost on a recording

    POST /{accountId}/recordings/{recordingId}/boosts.json

  • Write

    Create Event Boost

    Create a boost on a specific event within a recording. Only boostable events accept one: those whose action is completed, adopted, columnchanged or movedin (their JSON includes boostscount and boostsurl).

    POST /{accountId}/recordings/{recordingId}/events/{eventId}/boosts.json

  • Destructive

    Update Boost

    Replace the content of a boost. Only the boost's creator may update it: an admin updating someone else's boost gets 403 Forbidden, as does any caller when comments are closed on the boosted recording. A boost on a deleted recording, or in another account, answers 404.

    PUT /{accountId}/boosts/{boostId}

  • Destructive

    Delete Boost

    Delete a boost

    DELETE /{accountId}/boosts/{boostId}

Card Tables

  • Read

    Get Card

    Get a card by ID

    GET /{accountId}/card_tables/cards/{cardId}

  • Read

    Get Card Column

    Get a card column by ID

    GET /{accountId}/card_tables/columns/{columnId}

  • Read

    List Cards

    List cards in a column Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/card_tables/lists/{columnId}/cards.json

  • Read

    Get Card Step

    Get a step by ID

    GET /{accountId}/card_tables/steps/{stepId}

  • Read

    Get Card Table

    Get a card table by ID

    GET /{accountId}/card_tables/{cardTableId}

  • Write

    Enable Card Column On Hold

    Enable on-hold section in a column

    POST /{accountId}/buckets/{bucketId}/card_tables/columns/{columnId}/on_hold.json

  • Write

    Create Wormhole

    Add a wormhole to a card table: a standing shortcut that sends cards to a column on another card table, usually in another project. A wormhole's id is a valid columnid for MoveCard, teleporting the card to its destination column.

    POST /{accountId}/buckets/{bucketId}/card_tables/{cardTableId}/wormholes.json

  • Write

    Move Card

    Move a card to any column in its project, including on another card table there, or through a linked wormhole to another project (queued: the card gets a new id, and position, if sent, must still be positive but doesn't set placement).

    POST /{accountId}/card_tables/cards/{cardId}/moves.json

  • Write

    Reposition Card Step

    Reposition a step within a card

    POST /{accountId}/card_tables/cards/{cardId}/positions.json

  • Write

    Create Card Step

    Create a step on a card

    POST /{accountId}/card_tables/cards/{cardId}/steps.json

  • Write

    Create Card

    Create a card in a column

    POST /{accountId}/card_tables/lists/{columnId}/cards.json

  • Write

    Subscribe To Card Column

    Subscribe to a card column (watch for changes)

    POST /{accountId}/card_tables/lists/{columnId}/subscription.json

  • Write

    Create Card Column

    Create a column in a card table

    POST /{accountId}/card_tables/{cardTableId}/columns.json

  • Write

    Move Card Column

    Move a column to a slot within its card table. targetid is the card table's own id (the same as cardTableId), not a column; position is the 1-based slot among the columns, not counting Triage, Not Now or Done.

    POST /{accountId}/card_tables/{cardTableId}/moves.json

  • Destructive

    Set Card Column Color

    Set the color of a column

    PUT /{accountId}/buckets/{bucketId}/card_tables/columns/{columnId}/color.json

  • Destructive

    Disable Card Column On Hold

    Disable on-hold section in a column

    DELETE /{accountId}/buckets/{bucketId}/card_tables/columns/{columnId}/on_hold.json

  • Destructive

    Update Wormhole

    Point a card table's wormhole, its shortcut for sending cards to another card table, at a different destination column

    PUT /{accountId}/buckets/{bucketId}/card_tables/wormholes/{wormholeId}

  • Destructive

    Delete Wormhole

    Permanently delete a card table's wormhole, the shortcut that sends cards to another card table. It does not go to the trash and cannot be restored.

    DELETE /{accountId}/buckets/{bucketId}/card_tables/wormholes/{wormholeId}

  • Destructive

    Update Card

    Update an existing card

    PUT /{accountId}/card_tables/cards/{cardId}

  • Destructive

    Update Card Column

    Update an existing column

    PUT /{accountId}/card_tables/columns/{columnId}

  • Destructive

    Unsubscribe From Card Column

    Unsubscribe from a card column (stop watching for changes)

    DELETE /{accountId}/card_tables/lists/{columnId}/subscription.json

  • Destructive

    Update Card Step

    Update an existing step

    PUT /{accountId}/card_tables/steps/{stepId}

  • Destructive

    Set Card Step Completion

    Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete)

    PUT /{accountId}/card_tables/steps/{stepId}/completions.json

Messages

  • Read

    List Message Types

    List message types in a project Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/buckets/{bucketId}/categories.json

  • Read

    Get Message Type

    Get a single message type by id

    GET /{accountId}/buckets/{bucketId}/categories/{typeId}

  • Read

    Get Comment

    Get a single comment by id

    GET /{accountId}/comments/{commentId}

  • Read

    Get Message Board

    Get a message board

    GET /{accountId}/message_boards/{boardId}

  • Read

    List Messages

    List messages on a message board Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/message_boards/{boardId}/messages.json

  • Read

    Get Message

    Get a single message by id

    GET /{accountId}/messages/{messageId}

  • Read

    List Comments

    List comments on a recording Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/recordings/{recordingId}/comments.json

  • Write

    Create Message Type

    Create a new message type in a project

    POST /{accountId}/buckets/{bucketId}/categories.json

  • Write

    Create Message

    Create a new message on a message board

    POST /{accountId}/message_boards/{boardId}/messages.json

  • Write

    Pin Message

    Pin a message to the top of the message board

    POST /{accountId}/recordings/{messageId}/pin.json

  • Write

    Create Comment

    Create a new comment on a recording

    POST /{accountId}/recordings/{recordingId}/comments.json

  • Destructive

    Update Message Type

    Update an existing message type

    PUT /{accountId}/buckets/{bucketId}/categories/{typeId}

  • Destructive

    Delete Message Type

    Delete a message type

    DELETE /{accountId}/buckets/{bucketId}/categories/{typeId}

  • Destructive

    Update Comment

    Update an existing comment

    PUT /{accountId}/comments/{commentId}

  • Destructive

    Update Message

    Update an existing message

    PUT /{accountId}/messages/{messageId}

  • Destructive

    Unpin Message

    Unpin a message from the message board

    DELETE /{accountId}/recordings/{messageId}/pin.json

Campfire

  • Read

    List Chatbots

    List all chatbots for a campfire Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/buckets/{bucketId}/chats/{campfireId}/integrations.json

  • Read

    Get Chatbot

    Get a chatbot by ID

    GET /{accountId}/buckets/{bucketId}/chats/{campfireId}/integrations/{chatbotId}

  • Read

    List Campfires

    List all campfires across the account Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/chats.json

  • Read

    Get Campfire

    Get a campfire by ID

    GET /{accountId}/chats/{campfireId}

  • Read

    List Campfire Lines

    List all lines (messages) in a campfire Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/chats/{campfireId}/lines.json

  • Read

    Get Campfire Line

    Get a campfire line by ID

    GET /{accountId}/chats/{campfireId}/lines/{lineId}

  • Read

    List Campfire Uploads

    List uploaded files in a campfire Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/chats/{campfireId}/uploads.json

  • Write

    Create Chatbot

    Create a new chatbot for a campfire

    POST /{accountId}/buckets/{bucketId}/chats/{campfireId}/integrations.json

  • Write

    Create Campfire Line

    Create a new line (message) in a campfire

    POST /{accountId}/chats/{campfireId}/lines.json

  • Write

    Create Campfire Upload

    Upload a file to a campfire

    POST /{accountId}/chats/{campfireId}/uploads.json

  • Destructive

    Update Chatbot

    Update an existing chatbot

    PUT /{accountId}/buckets/{bucketId}/chats/{campfireId}/integrations/{chatbotId}

  • Destructive

    Delete Chatbot

    Delete a chatbot

    DELETE /{accountId}/buckets/{bucketId}/chats/{campfireId}/integrations/{chatbotId}

  • Destructive

    Update Campfire Line

    Update an existing campfire line; the content is always treated as rich text (HTML). The server coerces every edited line to rich text and ignores any content type hint. Only the line's creator may edit it, and only text and rich-text lines are editable.

    PUT /{accountId}/chats/{campfireId}/lines/{lineId}

  • Destructive

    Delete Campfire Line

    Delete a campfire line; allowed for the line's creator or an admin. The API responds 403 Forbidden otherwise.

    DELETE /{accountId}/chats/{campfireId}/lines/{lineId}

Client Features

  • Read

    List Client Approvals

    List all client approvals in a project Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/buckets/{bucketId}/client/approvals.json

  • Read

    List Client Correspondences

    List all client correspondences in a project Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/buckets/{bucketId}/client/correspondences.json

  • Read

    List Client Replies

    List all client replies for a recording (correspondence or approval) Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/buckets/{bucketId}/client/recordings/{recordingId}/replies.json

  • Read

    Get Client Reply

    Get a single client reply by id

    GET /{accountId}/buckets/{bucketId}/client/recordings/{recordingId}/replies/{replyId}

  • Read

    Get Client Approval

    Get a single client approval by id

    GET /{accountId}/client/approvals/{approvalId}

  • Read

    Get Client Correspondence

    Get a single client correspondence by id

    GET /{accountId}/client/correspondences/{correspondenceId}

  • Destructive

    Set Client Visibility

    Set client visibility for a recording

    PUT /{accountId}/recordings/{recordingId}/client_visibility.json

Dock

  • Read

    Get Tool

    Get a dock tool by id

    GET /{accountId}/dock/tools/{toolId}

  • Write

    Create Tool

    Create a tool in a project dock

    POST /{accountId}/buckets/{bucketId}/dock/tools.json

  • Write

    Enable Tool

    Enable a tool (show it on the project dock)

    POST /{accountId}/recordings/{toolId}/position.json

  • Destructive

    Update Tool

    Update (rename) an existing tool

    PUT /{accountId}/dock/tools/{toolId}

  • Destructive

    Delete Tool

    Remove a tool from the dock: deletes an external link or an empty extra tool, and disables any other tool (returns 204 No Content either way). Deleted: an external link, or a tool that is empty while the project has another tool of the same type, enabled or disabled.

    DELETE /{accountId}/dock/tools/{toolId}

  • Destructive

    Reposition Tool

    Reposition a tool on the project dock

    PUT /{accountId}/recordings/{toolId}/position.json

  • Destructive

    Disable Tool

    Disable a tool (hide it from the project dock)

    DELETE /{accountId}/recordings/{toolId}/position.json

Templates

  • Read

    Get Templatification

    Get a templatification

    GET /{accountId}/buckets/{bucketId}/recordings/{recordingId}/templatifications/{templatificationId}

  • Read

    Get Template Library Card Tables

    Get the account's card table templates

    GET /{accountId}/template_library/card_tables.json

  • Read

    Get Template Library Copy

    Get the current status of a to-do list template copy

    GET /{accountId}/template_library/copies/{copyId}

  • Read

    Get Template Library Todolists

    Get the account's to-do list templates

    GET /{accountId}/template_library/todolists.json

  • Read

    List Templates

    List all templates visible to the current user Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/templates.json

  • Read

    Get Template

    Get a single template by id

    GET /{accountId}/templates/{templateId}

  • Read

    Get Project Construction

    Get the status of a project construction

    GET /{accountId}/templates/{templateId}/project_constructions/{constructionId}

  • Write

    Create Templatification

    Templatify a to-do list or card table

    POST /{accountId}/buckets/{bucketId}/recordings/{recordingId}/templatifications.json

  • Write

    Create Template Library Card Table

    Create a card table template with the default columns

    POST /{accountId}/template_library/card_tables.json

  • Write

    Create Template Library Copy

    Start copying a to-do list or card table template into a project

    POST /{accountId}/template_library/copies.json

  • Write

    Create Template Library Todolist

    Create an empty to-do list template

    POST /{accountId}/template_library/todolists.json

  • Write

    Create Template

    Create a new template

    POST /{accountId}/templates.json

  • Write

    Create Project From Template

    Create a project from a template (asynchronous)

    POST /{accountId}/templates/{templateId}/project_constructions.json

  • Destructive

    Update Template

    Update an existing template

    PUT /{accountId}/templates/{templateId}

  • Destructive

    Delete Template

    Delete a template (trash it)

    DELETE /{accountId}/templates/{templateId}

Todos

  • Read

    Get Todolist Or Group

    Get a single todolist or todolist group by id The endpoint is polymorphic, but it answers with one shape: BC3 has no group model, so both variants come back as a flat Todolist (see the Todolist shape).

    GET /{accountId}/todolists/{id}

  • Read

    List Todolist Groups

    List groups in a todolist Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/todolists/{todolistId}/groups.json

  • Read

    List Todos

    List todos in a todolist Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/todolists/{todolistId}/todos.json

  • Read

    Get Todo

    Get a single todo by id

    GET /{accountId}/todos/{todoId}

  • Read

    Get Todoset

    Get a todoset (container for todolists in a project)

    GET /{accountId}/todosets/{todosetId}

  • Read

    Get Hill Chart

    Get the hill chart for a todoset

    GET /{accountId}/todosets/{todosetId}/hill.json

  • Read

    List Todolists

    List todolists in a todoset Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/todosets/{todosetId}/todolists.json

  • Write

    Create Todoset Todo

    Create a to-do directly under a project's to-do set, outside any to-do list. This form exists only project-scoped (no account-scoped variant); parameters and response match the to-do-list create. Find a project's to-do set id via GetTodoset.

    POST /{accountId}/buckets/{bucketId}/todosets/{todosetId}/todos.json

  • Write

    Create Todolist Group

    Create a new group in a todolist

    POST /{accountId}/todolists/{todolistId}/groups.json

  • Write

    Create Todo

    Create a new todo in a todolist

    POST /{accountId}/todolists/{todolistId}/todos.json

  • Write

    Complete Todo

    Mark a todo as complete

    POST /{accountId}/todos/{todoId}/completion.json

  • Write

    Create Todolist

    Create a new todolist in a todoset

    POST /{accountId}/todosets/{todosetId}/todolists.json

  • Destructive

    Reposition Todolist Group

    Reposition a todolist group

    PUT /{accountId}/todolists/groups/{groupId}/position.json

  • Destructive

    Update Todolist Or Group

    Replace a todolist (or todolist group) with a new complete representation. The endpoint is polymorphic - it addresses a to-do list or a group, and answers with the same flat Todolist shape either way.

    PUT /{accountId}/todolists/{id}

  • Destructive

    Replace Todo

    Replace a todo with a new complete representation. The request body is the todo's full writable state: any writable field omitted from the request is cleared server-side (empty/missing assigneeids clears assignees, missing description clears it, and so on).

    PUT /{accountId}/todos/{todoId}

  • Destructive

    Uncomplete Todo

    Mark a todo as incomplete

    DELETE /{accountId}/todos/{todoId}/completion.json

  • Destructive

    Reposition Todo

    Reposition a todo within its todolist, or move it into another list or the to-do set in the same project. parentid names a to-do list, or the project's to-do set, to move the todo into; the todo keeps its id. It must be in the same project: anything else answers 422.

    PUT /{accountId}/todos/{todoId}/position.json

  • Destructive

    Reposition Todolist

    Reposition a to-do list within its to-do set. position is the 1-based index among the to-do lists the caller can see; the server translates it relative to loose to-dos and hidden completed lists. Shifts siblings.

    PUT /{accountId}/todosets/todolists/{todolistId}/position.json

  • Destructive

    Update Hill Chart Settings

    Track or untrack todolists on a hill chart

    PUT /{accountId}/todosets/{todosetId}/hills/settings.json

Webhooks

  • Read

    List Webhooks

    List all webhooks for a project Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/buckets/{bucketId}/webhooks.json

  • Read

    Get Webhook

    Get a single webhook by id

    GET /{accountId}/webhooks/{webhookId}

  • Write

    Create Webhook

    Create a new webhook for a project

    POST /{accountId}/buckets/{bucketId}/webhooks.json

  • Destructive

    Update Webhook

    Update an existing webhook

    PUT /{accountId}/webhooks/{webhookId}

  • Destructive

    Delete Webhook

    Delete a webhook

    DELETE /{accountId}/webhooks/{webhookId}

Calendars

  • Read

    Get Calendar

    Get a calendar by its bucket id. A Calendar is a top-level BC5 bucketable (distinct from a project) exposing display metadata and a link to its underlying schedule resource. Shipped scope is show + update only.

    GET /{accountId}/calendars/{calendarId}

  • Destructive

    Update Calendar

    Update a calendar's display color. An unknown color returns 422 with a JSON errors payload keyed by field ({"errors": {"color": ["is not a valid color"]}}) — the controller rejects invalid enum values up front.

    PUT /{accountId}/calendars/{calendarId}

Everything

  • Read

    Get Everything Completed Cards

    Completed cards across all accessible projects, grouped by project (paginated).

    GET /{accountId}/cards/completed.json

  • Read

    Get Everything No Due Date Cards

    Open cards with no due date across all accessible projects, grouped by project (paginated).

    GET /{accountId}/cards/no_due_date.json

  • Read

    Get Everything Not Now Cards

    Cards parked in a project's "Not now" column across all accessible projects, grouped by project (paginated).

    GET /{accountId}/cards/not_now.json

  • Read

    Get Everything Open Cards

    Incomplete cards in active columns across all accessible projects, grouped by project (paginated). Each bucket entry carries the matching cards and their steps.

    GET /{accountId}/cards/open.json

  • Read

    Get Everything Overdue Cards

    Get every overdue card across all accessible projects, oldest-due-date-first. A complete, unpaginated array; each item embeds its bucket.

    GET /{accountId}/cards/overdue.json

  • Read

    Get Everything Unassigned Cards

    Open, unassigned cards across all accessible projects, grouped by project (paginated).

    GET /{accountId}/cards/unassigned.json

  • Read

    Get Everything Checkins

    Get every automatic check-in answer across all accessible projects, newest-first. Paginated; each item embeds its bucket.

    GET /{accountId}/checkins.json

  • Read

    Get Everything Comments

    Get every comment across all accessible projects, newest-first (paginated). Each item embeds its bucket.

    GET /{accountId}/comments.json

  • Read

    Get Everything Files

    Get every file recording across all accessible projects, newest-first (paginated). Heterogeneous: uploads and Basecamp documents carry their standard recording shapes, while rich-text attachments are wrapped in a recording envelope plus an attachablesgid and blob metadata.

    GET /{accountId}/files.json

  • Read

    Get Everything Forwards

    Get every inbox forward across all accessible projects, newest-first (paginated). Each item embeds its bucket.

    GET /{accountId}/forwards.json

  • Read

    Get Everything Messages

    Get every message across all accessible projects, newest-first (paginated). Each item embeds its bucket for project context.

    GET /{accountId}/messages.json

  • Read

    Get Everything Completed Todos

    Completed to-dos across all accessible projects, grouped by project (paginated).

    GET /{accountId}/todos/completed.json

  • Read

    Get Everything No Due Date Todos

    Open to-dos with no due date across all accessible projects, grouped by project (paginated).

    GET /{accountId}/todos/no_due_date.json

  • Read

    Get Everything Open Todos

    Active, incomplete to-dos across all accessible projects, grouped by project (paginated). Each bucket entry carries the matching to-dos and their steps.

    GET /{accountId}/todos/open.json

  • Read

    Get Everything Overdue Todos

    Get every overdue to-do across all accessible projects, oldest-due-date-first. A complete, unpaginated array; each item embeds its bucket.

    GET /{accountId}/todos/overdue.json

  • Read

    Get Everything Unassigned Todos

    Open, unassigned to-dos across all accessible projects, grouped by project (paginated).

    GET /{accountId}/todos/unassigned.json

Pings

  • Read

    List Pings

    Get Pings: the caller's active Pings that have a line in them, most recently updated first, in one unpaginated response. Archived Pings, and Pings no one has posted in yet, are not listed; GetPing reads either by id.

    GET /{accountId}/circles.json

  • Read

    Get Ping

    Get a Ping by its id, which is its bucket's id. Answers 403 Forbidden ({"error": "Pings have been disabled"}) when the caller cannot ping, and 404 Not Found for a bucket that is not a Ping the caller is in.

    GET /{accountId}/circles/{pingId}

  • Write

    Create Ping

    Create a Ping with people, or return the one that already holds exactly them. The caller is always included.

    POST /{accountId}/circles.json

People

  • Read

    List Pingable People

    List all account users who can be pinged Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/circles/people.json

  • Read

    Get My Preferences

    Get the current user's preferences

    GET /{accountId}/my/preferences.json

  • Read

    Get My Profile

    Get the current authenticated user's profile

    GET /{accountId}/my/profile.json

  • Read

    List People

    List all people visible to the current user Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/people.json

  • Read

    Get Person

    Get a person by ID

    GET /{accountId}/people/{personId}

  • Read

    Get Out Of Office

    Get the out of office status for a person

    GET /{accountId}/people/{personId}/out_of_office.json

  • Read

    List Project People

    List all active people on a project Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/projects/{projectId}/people.json

  • Read

    Get Subscription

    Get subscription information for a recording

    GET /{accountId}/recordings/{recordingId}/subscription.json

  • Read

    List Assignable People

    List people who can be assigned todos

    GET /{accountId}/reports/todos/assigned.json

  • Write

    Enable Out Of Office

    Enable or replace out of office for a person. Admins on Pro Pack accounts can manage others; otherwise self only.

    POST /{accountId}/people/{personId}/out_of_office.json

  • Write

    Enable Project Clients

    Enable clients on a project so client users can be added to it A deliberate step separate from adding clients: it turns on the project's client-facing surface and applies the default client visibility (the timeline and most docked tools become client-visible; the card table, Cam…

    POST /{accountId}/projects/{projectId}/client_enablement.json

  • Write

    Subscribe

    Subscribe the current user to a recording

    POST /{accountId}/recordings/{recordingId}/subscription.json

  • Destructive

    Update My Preferences

    Update the current user's preferences. Rejections arrive as a field-keyed 422 ({"errors": {"timezonename": ["is not included in the list"]}}), not the flat {error} body.

    PUT /{accountId}/my/preferences.json

  • Destructive

    Update My Profile

    Update the current authenticated user's profile (returns 204 No Content)

    PUT /{accountId}/my/profile.json

  • Destructive

    Disable Out Of Office

    Disable out of office for a person. Admins on Pro Pack accounts can manage others; otherwise self only.

    DELETE /{accountId}/people/{personId}/out_of_office.json

  • Destructive

    Disable Project Clients

    Disable clients on a project 403 while the project still has any client users — revoke them first with UpdateProjectClientAccess. Naturally idempotent: disabling a project with clients already off re-answers {"clientsenabled": false}.

    DELETE /{accountId}/projects/{projectId}/client_enablement.json

  • Destructive

    Update Project Client Access

    Update project client access (grant/revoke/create client users) The client-side counterpart to UpdateProjectAccess: grant adds existing client users by id, revoke removes client users, and create invites brand-new clients by email (name optional, defaulting to the address).

    PUT /{accountId}/projects/{projectId}/people/client_users.json

  • Destructive

    Update Project Access

    Update project access (grant/revoke/create people)

    PUT /{accountId}/projects/{projectId}/people/users.json

  • Destructive

    Update Subscription

    Update subscriptions by adding or removing specific users

    PUT /{accountId}/recordings/{recordingId}/subscription.json

  • Destructive

    Unsubscribe

    Unsubscribe the current user from a recording

    DELETE /{accountId}/recordings/{recordingId}/subscription.json

Embeds

  • Read

    Get Embed

    Get an embed by its sgid. Answers 404 Not Found for an sgid that does not name an embed.

    GET /{accountId}/embeds/{sgid}

  • Write

    Create Embed

    Create an embed for a URL, or return the one Basecamp already has for it. Answers 200 OK with the embed either way. A new embed's status is pending; get it about once a second until its status is active or notfound. Answers 422 ({"error": "Basecamp can't embed this URL.

    POST /{accountId}/embeds.json

Event Feed

  • Read

    Poll Events

    Poll the account event feed for events after a position (oldest first, strict event-id order, up to 100 per page). Entry. With neither since nor position the feed begins at the present (equivalent to since=now).

    GET /{accountId}/events.json

  • Read

    Poll Inbox

    Poll the authenticated agent's inbox for the items that addressed it (oldest first, strict item-id order); people receive 403. The inbox is the low-noise "someone addressed you" lane as its own resource rather than a filter over the account feed.

    GET /{accountId}/inbox.json

  • Write

    Create Stream Ticket

    Mint a short-lived stream ticket and the exact WebSocket URL to open a live event stream with. The ticket is signed and lives about two minutes; the response's url is the one to connect to.

    POST /{accountId}/events/stream_ticket.json

Recordings

  • Read

    Get Filing

    Get the state of a move or copy started by MoveRecording or CopyRecording. status is pending or processing while the work runs, completed when it is done, and failed if it could not be done. Poll until it leaves pending and processing.

    GET /{accountId}/filings/{filingId}

  • Read

    List Recordings

    List recordings of a given type across projects Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/projects/recordings.json

  • Read

    List Events

    List all events for a recording Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/recordings/{recordingId}/events.json

  • Write

    Copy Recording

    Start copying a recording into another project; poll GetFiling for the result. Works like MoveRecording, and takes the same destinations, except the original stays where it is.

    POST /{accountId}/recordings/{recordingId}/copies.json

  • Write

    Move Recording To Vault

    Move a document, upload or vault into another vault in its project, or reorder it in its own vault. Passing the vault it is already in changes only its position.

    POST /{accountId}/recordings/{recordingId}/filing.json

  • Write

    Move Recording

    Start moving a recording into another project; poll GetFiling for the result. The move runs in the background and this answers 201 with a filing. Poll GetFiling with its id until status leaves pending and processing.

    POST /{accountId}/recordings/{recordingId}/moves.json

  • Write

    Spotlight Recording

    Put a recording's card in the spotlight area on its project or template home page. Idempotent: spotlighting an already-spotlighted recording still returns 201.

    POST /{accountId}/recordings/{recordingId}/spotlight.json

  • Destructive

    Unspotlight Recording

    Remove a recording from the spotlight area. Idempotent: removing an absent spotlight also returns 204.

    DELETE /{accountId}/recordings/{recordingId}/spotlight.json

  • Destructive

    Unarchive Recording

    Unarchive a recording (restore to active status)

    PUT /{accountId}/recordings/{recordingId}/status/active.json

  • Destructive

    Archive Recording

    Archive a recording; bc3 answers 403 for types it never lets be archived, timesheet entries among them

    PUT /{accountId}/recordings/{recordingId}/status/archived.json

  • Destructive

    Trash Recording

    Trash a recording; bc3 answers 403 for types it never lets be trashed, timesheet entries among them (DestroyTimesheetEntry removes those, permanently)

    PUT /{accountId}/recordings/{recordingId}/status/trashed.json

Gauges

  • Read

    Get Gauge Needle

    Get a gauge needle by ID

    GET /{accountId}/gauge_needles/{needleId}

  • Read

    List Gauge Needles

    List gauge needles for a project, ordered newest first.

    GET /{accountId}/projects/{projectId}/gauge/needles.json

  • Read

    List Gauges

    List gauges across all projects the authenticated user has access to. Gauges are sorted by risk level (red, yellow, green), then alphabetically.

    GET /{accountId}/reports/gauges.json

  • Write

    Create Gauge Needle

    Create a gauge needle (progress update) for a project

    POST /{accountId}/projects/{projectId}/gauge/needles.json

  • Destructive

    Update Gauge Needle

    Update a gauge needle's description. Position and color are immutable.

    PUT /{accountId}/gauge_needles/{needleId}

  • Destructive

    Destroy Gauge Needle

    Destroy a gauge needle

    DELETE /{accountId}/gauge_needles/{needleId}

  • Destructive

    Toggle Gauge

    Enable or disable the gauge for a project. Only project admins can toggle gauges.

    PUT /{accountId}/projects/{projectId}/gauge.json

Forwards

  • Read

    Get Forward

    Get a forward by ID

    GET /{accountId}/inbox_forwards/{forwardId}

  • Read

    List Forward Replies

    List all replies to a forward Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/inbox_forwards/{forwardId}/replies.json

  • Read

    Get Forward Reply

    Get a forward reply by ID

    GET /{accountId}/inbox_forwards/{forwardId}/replies/{replyId}

  • Read

    Get Inbox

    Get an inbox by ID

    GET /{accountId}/inboxes/{inboxId}

  • Read

    List Forwards

    List all forwards in an inbox Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/inboxes/{inboxId}/inbox_forwards.json

Lineup

  • Read

    List Lineup Markers

    List all lineup markers for the account

    GET /{accountId}/lineup/markers.json

  • Write

    Create Lineup Marker

    Create a new lineup marker. Returns the created marker.

    POST /{accountId}/lineup/markers.json

  • Destructive

    Update Lineup Marker

    Update an existing lineup marker. Returns the updated marker.

    PUT /{accountId}/lineup/markers/{markerId}

  • Destructive

    Delete Lineup Marker

    Delete a lineup marker

    DELETE /{accountId}/lineup/markers/{markerId}

My Assignments

  • Read

    Get My Assignments

    Get the current user's active assignments grouped into priorities and nonpriorities. Card table steps are normalized to their parent card with steps as children. This endpoint is not paginated.

    GET /{accountId}/my/assignments.json

  • Read

    Get My Completed Assignments

    Get the current user's completed assignments. Archived and trashed recordings are excluded. This endpoint is not paginated.

    GET /{accountId}/my/assignments/completed.json

  • Read

    Get My Due Assignments

    Get the current user's assignments filtered by due date scope. Defaults to overdue when no scope is provided. This endpoint is not paginated.

    GET /{accountId}/my/assignments/due.json

  • Write

    Prioritize Assignment

    Add a recording to Up Next — the current user's ordered list of prioritized assignments (the priorities returned by GetMyAssignments).

    POST /{accountId}/my/priorities.json

  • Write

    Reorder Up Next

    Move an already-prioritized recording to a new 1-based position in Up Next (returns 204 No Content). NOT idempotent: a positional move's meaning shifts as the list changes, so a retry can land the item somewhere else — no retry gating is declared.

    POST /{accountId}/my/priority_moves.json

  • Destructive

    Deprioritize Assignment

    Remove a recording from Up Next (returns 204 No Content). Exact-target: only the priority carried by the identified recording is cleared, and deleting an absent priority is a no-op 204 — so the DELETE is idempotent and safe to retry (BC3 12483).

    DELETE /{accountId}/my/priorities/{recordingId}

Bookmarks

  • Read

    List My Bookmarks

    List the current user's bookmarks, most recently bookmarked first (paginated). A bookmark is a personal link between the current user and a single recording, visible only to its creator; each entry wraps the shared recording projection.

    GET /{accountId}/my/bookmarks.json

  • Read

    Get Bookmark

    Report whether the current user has bookmarked the recording.

    GET /{accountId}/recordings/{recordingId}/bookmark.json

  • Write

    Create Bookmark

    Bookmark a recording for the current user. Idempotent: re-bookmarking returns the existing bookmark, never a duplicate.

    POST /{accountId}/recordings/{recordingId}/bookmark.json

  • Destructive

    Delete Bookmark

    Remove the current user's bookmark from a recording (returns 204 No Content). Idempotent: deleting an absent bookmark also returns 204.

    DELETE /{accountId}/recordings/{recordingId}/bookmark.json

Drafts

  • Read

    List My Drafts

    List the current user's drafts across their active projects, most recently updated first (paginated, capped at 250 like /my/assignments). Five draft kinds are returned: messages, documents, uploads, client approvals, and client correspondences.

    GET /{accountId}/my/drafts.json

My Notes

  • Read

    Get My Note

    Get the authenticated user's note — a per-person notebook singleton at /my/notes.json. If the user has not yet written anything, the shape is the same with empty content and null id/createdat/updatedat; the record is created on first update.

    GET /{accountId}/my/notes.json

  • Destructive

    Update My Note

    Replace the note's content, recording a new revision server-side. The first update also creates the underlying notebook if the user did not have one yet. Returns the updated note.

    PUT /{accountId}/my/notes.json

Checkins

  • Read

    Get Question Reminders

    Get pending check-in reminders for the current user Returns questions that are pending a response from the authenticated user. Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages.

    GET /{accountId}/my/question_reminders.json

  • Read

    Get Answer

    Get a single answer by id

    GET /{accountId}/question_answers/{answerId}

  • Read

    Get Questionnaire

    Get a questionnaire (automatic check-ins container) by id

    GET /{accountId}/questionnaires/{questionnaireId}

  • Read

    List Questions

    List all questions in a questionnaire Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/questionnaires/{questionnaireId}/questions.json

  • Read

    Get Question

    Get a single question by id

    GET /{accountId}/questions/{questionId}

  • Read

    List Answers

    List all answers for a question Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/questions/{questionId}/answers.json

  • Read

    List Question Answerers

    List all people who have answered a question (answerers) Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages.

    GET /{accountId}/questions/{questionId}/answers/by.json

  • Read

    Get Answers By Person

    Get all answers from a specific person for a question Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages.

    GET /{accountId}/questions/{questionId}/answers/by/{personId}

  • Write

    Create Question

    Create a new question in a questionnaire

    POST /{accountId}/questionnaires/{questionnaireId}/questions.json

  • Write

    Create Answer

    Create a new answer for a question

    POST /{accountId}/questions/{questionId}/answers.json

  • Write

    Pause Question

    Pause a check-in question (stops sending reminders)

    POST /{accountId}/questions/{questionId}/pause.json

  • Destructive

    Update Answer

    Update an existing answer

    PUT /{accountId}/question_answers/{answerId}

  • Destructive

    Update Question

    Update an existing question's title, schedule or both. A schedule replaces the whole schedule, so send every part of it: one without frequency or timeofday is refused, and one without startdate re-anchors the recurrence on today.

    PUT /{accountId}/questions/{questionId}

  • Destructive

    Update Question Notification Settings

    Update notification settings for a check-in question

    PUT /{accountId}/questions/{questionId}/notification_settings.json

  • Destructive

    Resume Question

    Resume a paused check-in question (resumes sending reminders)

    DELETE /{accountId}/questions/{questionId}/pause.json

My Notifications

  • Read

    Get My Notifications

    Get the current user's notifications (the "Hey!" menu in Basecamp 4). Notifications are grouped into unreads, reads, bubble-ups, and scheduled bubble-ups (memories remains as an always-empty placeholder on BC5). Reads are paginated (50 per page). Unreads are capped at 100.

    GET /{accountId}/my/readings.json

  • Read

    Get Bubble Ups

    Get the current user's current and scheduled bubble-ups (paginated, 50 per page). Current bubble-ups are returned first, ordered by most recently bubbled up; scheduled bubble-ups follow, ordered by scheduled bubble-up time.

    GET /{accountId}/my/readings/bubble_ups.json

  • Destructive

    Mark As Read

    Mark specified items as read A batch is capped at 500 readables; a larger one is refused with 422 before any per-item work (bc3 f3437f5c732).

    PUT /{accountId}/my/unreads.json

Projects

  • Read

    List Recent Projects

    List the projects the current user has most recently visited, most recent visit first. Reads the per-user visit log — capped at the 50 most recent visits, keeping only active projects the user can still access — not the home grid's pinned-exclusion and padding.

    GET /{accountId}/my/recent_projects.json

  • Read

    List Projects

    List projects (active by default; optionally archived/trashed) Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/projects.json

  • Read

    Get Project

    Get a single project by id

    GET /{accountId}/projects/{projectId}

  • Write

    Create Project

    Create a new project

    POST /{accountId}/projects.json

  • Write

    Record Project Visit

    Record that the current user visited a project, moving it to the front of ListRecentProjects (returns 204 No Content). Idempotent: re-recording a visit refreshes the same entry.

    POST /{accountId}/projects/{projectId}/recent_visit.json

  • Destructive

    Update Project

    Update an existing project

    PUT /{accountId}/projects/{projectId}

  • Destructive

    Trash Project

    Trash a project (returns 204 No Content)

    DELETE /{accountId}/projects/{projectId}

  • Destructive

    Unarchive Project

    Restore a project to active status from trash as well as from the archive (returns 204 No Content). This is the inverse of both ArchiveProject and TrashProject. Restoring counts against the account's project limit, so it answers 507 when that limit is already reached.

    PUT /{accountId}/projects/{projectId}/status/active.json

  • Destructive

    Archive Project

    Archive a project, removing it from the active project list (returns 204 No Content). Accounts on the admin pro pack may restrict archiving to admins and the project's creator, which answers 403.

    PUT /{accountId}/projects/{projectId}/status/archived.json

  • Destructive

    Update Project Wallpaper

    Upload or replace the project's wallpaper (returns 204 No Content). Uses the project's existing image validations, including GIF, HEIC and HEIF. Maximum 10 MB. People and personal assistants follow project-edit permissions; shared agents are refused.

    PUT /{accountId}/projects/{projectId}/wallpaper.json

  • Destructive

    Remove Project Wallpaper

    Remove the project's wallpaper (returns 204 No Content). People and personal assistants follow project-edit permissions; shared agents are refused.

    DELETE /{accountId}/projects/{projectId}/wallpaper.json

Timeline

  • Read

    Get Project Timeline

    Get project timeline

    GET /{accountId}/projects/{projectId}/timeline.json

Schedule

  • Read

    Get Project Timesheet

    Get timesheet for a specific project

    GET /{accountId}/projects/{projectId}/timesheet.json

  • Read

    Get Recording Timesheet

    Get timesheet for a specific recording

    GET /{accountId}/recordings/{recordingId}/timesheet.json

  • Read

    Get Timesheet Report

    Get account-wide timesheet report

    GET /{accountId}/reports/timesheet.json

  • Read

    Get Schedule Entry

    Get a single schedule entry by id. Note: Recurring entries will redirect (302) to their recordable URL. Use GetScheduleEntryOccurrence for recurring entries instead.

    GET /{accountId}/schedule_entries/{entryId}

  • Read

    Get Schedule Entry Occurrence

    Get a specific occurrence of a recurring schedule entry

    GET /{accountId}/schedule_entries/{entryId}/occurrences/{date}

  • Read

    Get Schedule

    Get a schedule

    GET /{accountId}/schedules/{scheduleId}

  • Read

    List Schedule Entries

    List entries on a schedule Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/schedules/{scheduleId}/entries.json

  • Read

    Get Timesheet Entry

    Get a single timesheet entry

    GET /{accountId}/timesheet_entries/{entryId}

  • Write

    Create Timesheet Entry

    Create a timesheet entry on a recording

    POST /{accountId}/recordings/{recordingId}/timesheet/entries.json

  • Write

    Create Schedule Entry

    Create a new schedule entry

    POST /{accountId}/schedules/{scheduleId}/entries.json

  • Destructive

    Replace Schedule Entry

    Replace a schedule entry with a new complete representation. The request body is the entry's full writable state: a writable field omitted from the request is cleared server-side, because BC3 builds a brand-new Schedule::Entry from the permitted params and swaps the recordable w…

    PUT /{accountId}/schedule_entries/{entryId}

  • Destructive

    Update Schedule Settings

    Update schedule settings

    PUT /{accountId}/schedules/{scheduleId}

  • Destructive

    Update Timesheet Entry

    Update a timesheet entry

    PUT /{accountId}/timesheet_entries/{entryId}

  • Destructive

    Destroy Timesheet Entry

    Permanently delete a timesheet entry, which never appears in the trash and cannot be restored; this is the only way to remove one, since bc3 answers 403 to TrashRecording and ArchiveRecording for every timesheet entry, and it answers 403 when the caller may not remove the entry.

    DELETE /{accountId}/timesheet_entries/{entryId}

Bubble Ups

  • Write

    Create Bubble Up

    Bubble up a recording for the current user, resurfacing it in the current user's readings (the BC5 successor to "save"). Returns 204 No Content with no body. The at field controls timing.

    POST /{accountId}/recordings/{recordingId}/bubble_up.json

  • Destructive

    Delete Bubble Up

    Remove the current user's bubble-up from a recording (returns 204 No Content). Idempotent: popping an absent bubble-up also returns 204.

    DELETE /{accountId}/recordings/{recordingId}/bubble_up.json

Subtasks

  • Read

    List Subtasks

    List a recording's subtasks, in position order Only to-dos and cards hold subtasks; check for subtaskscount and subtasksurl on the parent's JSON. Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.

    GET /{accountId}/recordings/{recordingId}/subtasks.json

  • Read

    Get Subtask

    Get a subtask by ID

    GET /{accountId}/subtasks/{subtaskId}

  • Write

    Create Subtask

    Create a subtask under a to-do or a card Any other recording answers 403 Forbidden.

    POST /{accountId}/recordings/{recordingId}/subtasks.json

  • Write

    Complete Subtask

    Mark a subtask as completed

    POST /{accountId}/subtasks/{subtaskId}/completion.json

  • Destructive

    Update Subtask

    Update a subtask A partial update: every omitted parameter is left unchanged.

    PUT /{accountId}/subtasks/{subtaskId}

  • Destructive

    Delete Subtask

    Delete a subtask On accounts where deleting is limited to admins and the creator, everyone else gets 403 Forbidden.

    DELETE /{accountId}/subtasks/{subtaskId}

  • Destructive

    Uncomplete Subtask

    Mark a subtask as not completed

    DELETE /{accountId}/subtasks/{subtaskId}/completion.json

  • Destructive

    Reposition Subtask

    Move a subtask to a new position among its siblings

    PUT /{accountId}/subtasks/{subtaskId}/position.json

Reports

  • Read

    Get Progress Report

    Get account-wide activity feed (progress report)

    GET /{accountId}/reports/progress.json

  • Read

    Get Upcoming Schedule

    Get upcoming schedule entries and assignable items within a date window. This endpoint is preserved as the canonical API path on BC5; the BC5 /calendar web view is HTML-only.

    GET /{accountId}/reports/schedules/upcoming.json

  • Read

    Get Assigned Todos

    Get todos assigned to a specific person

    GET /{accountId}/reports/todos/assigned/{personId}

  • Read

    Get Overdue Todos

    Get overdue todos grouped by lateness

    GET /{accountId}/reports/todos/overdue.json

  • Read

    Get Person Progress

    Get a person's activity timeline

    GET /{accountId}/reports/users/progress/{personId}.json

Search

  • Read

    Get Search Metadata

    Get search metadata (available filter options)

    GET /{accountId}/searches/metadata.json

Folders

  • Read

    List Folders

    List the authenticated user's folders in home-screen order. Returns a bare array with no pagination envelope. Items are the base folder shape: they carry bucketids but not the expanded projects, which only the single-folder operations return.

    GET /{accountId}/stacks.json

  • Read

    Get Folder

    Get one folder, with the projects grouped inside it expanded under projects.

    GET /{accountId}/stacks/{folderId}

  • Write

    Create Folder

    Create a folder for the authenticated user and file the given projects into it. Returns 201 with the new folder and its expanded projects, placed at the top of the home screen. Filing an all-access project the user has not joined grants them access to it.

    POST /{accountId}/stacks.json

  • Destructive

    Update Folder

    Rename a folder. name is the only writable attribute; a folder's projects, ordering, and image are managed elsewhere and an image parameter sent here is ignored.

    PUT /{accountId}/stacks/{folderId}

  • Destructive

    Delete Folder

    Delete a folder and unpin its projects from the home screen (returns 204 No Content). The projects themselves are not deleted and are not moved back out onto the home screen; they simply stop appearing there until pinned again.

    DELETE /{accountId}/stacks/{folderId}

See How connections work for access and permissions, or browse all integrations.