-
Notifications
You must be signed in to change notification settings - Fork 121
Drafts API and My Tasks: new section and draft lifecycle docs #422
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| Drafts | ||
| ====== | ||
|
|
||
| Endpoint for retrieving the current user's unpublished message, document, upload, and client approval/correspondence drafts across their active projects. | ||
|
|
||
| A draft is a [message](messages.md), [document](documents.md), file [upload](uploads.md), or client [approval](client_approvals.md)/[correspondence](client_correspondences.md) that has been saved but not yet published. Messages and documents can be drafted and published through the API — see the [messages](messages.md#create-a-message) and [documents](documents.md#create-a-document) sections. Uploads have their own [create](uploads.md#create-an-upload) and [update](uploads.md#update-an-upload) endpoints, but no documented way to create or publish a *draft* upload; client approvals and correspondences are read-only over the API. Drafts of all of these types still appear here, however they were authored. | ||
|
|
||
| Endpoints: | ||
|
|
||
| - [Get my drafts](#get-my-drafts) | ||
|
|
||
|
|
||
| Get my drafts | ||
| ------------- | ||
|
|
||
| * `GET /my/drafts.json` will return a [paginated list][pagination] of the current user's drafts, most recently updated first, regardless of how they were created. Drafts whose project has been archived or trashed are excluded. | ||
|
|
||
| Five kinds of drafts are returned: | ||
|
|
||
| * [Messages](messages.md) | ||
| * [Documents](documents.md) | ||
| * [Uploads](uploads.md) | ||
| * Client [approvals](client_approvals.md) | ||
| * Client [correspondences](client_correspondences.md) | ||
|
|
||
| **Not returned:** other resources can also be saved in a drafted state, but they aren't part of this list — notably [Google documents](google_documents.md) (which default to `drafted` when `status` is omitted), [cloud files](cloud_files.md), and [schedule entries](schedule_entries.md). This endpoint is not an exhaustive feed of everything you have unpublished. | ||
|
|
||
| Each draft carries an `excerpt`: up to 300 characters of plain-text content, or an empty string when the draft has no body yet. `parent` is `null` for drafts filed directly under their bucket, and `scheduled_posting_at` is `null` unless the draft is scheduled to publish later. | ||
|
|
||
| ###### Example JSON Response | ||
| <!-- START GET /my/drafts.json --> | ||
| ```json | ||
| [ | ||
| { | ||
| "id": 1069480291, | ||
| "app_url": "https://3.basecamp.com/195539477/buckets/2085958504/messages/1069480291", | ||
| "title": "Launch announcement", | ||
| "type": "message", | ||
| "bucket": { | ||
| "id": 2085958504, | ||
| "name": "The Leto Laptop", | ||
| "app_url": "https://3.basecamp.com/195539477/buckets/2085958504" | ||
| }, | ||
| "parent": { | ||
| "id": 1069479829, | ||
| "title": "Message Board", | ||
| "app_url": "https://3.basecamp.com/195539477/buckets/2085958504/message_boards/1069479829" | ||
| }, | ||
| "excerpt": "Still polishing the wording before we post this.", | ||
| "created_at": "2026-07-22T22:11:07.611Z", | ||
| "updated_at": "2026-07-22T22:11:07.632Z", | ||
| "scheduled_posting_at": null | ||
| } | ||
| ] | ||
| ``` | ||
| <!-- END GET /my/drafts.json --> | ||
|
|
||
| ###### Copy as cURL | ||
|
|
||
| ```shell | ||
| curl -s -H "Authorization: Bearer $ACCESS_TOKEN" https://3.basecampapi.com/$ACCOUNT_ID/my/drafts.json | ||
| ``` | ||
|
|
||
| [pagination]: ../README.md#pagination |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.