-
Notifications
You must be signed in to change notification settings - Fork 121
Document account API endpoints #389
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| Account | ||
| ======= | ||
|
|
||
| Endpoints: | ||
|
|
||
| - [Get account](#get-account) | ||
| - [Update account name](#update-account-name) | ||
| - [Update account logo](#update-account-logo) | ||
| - [Remove account logo](#remove-account-logo) | ||
|
|
||
| Get account | ||
| ----------- | ||
|
|
||
| * `GET /account.json` will return the account for the current access token. | ||
|
|
||
| The `logo` field is only present when the account has a logo configured. It is omitted entirely when no logo exists. | ||
|
|
||
| ###### Example JSON Response | ||
| <!-- START GET /account.json --> | ||
| ```json | ||
| { | ||
| "id": 1009501286, | ||
| "name": "Honcho Design", | ||
| "owner_name": "Victor Cooper", | ||
| "active": true, | ||
| "created_at": "2026-03-16T21:42:20.134Z", | ||
| "updated_at": "2026-03-16T21:57:21.050Z", | ||
| "trial": false, | ||
| "trial_ends_on": null, | ||
| "frozen": false, | ||
| "paused": false, | ||
| "limits": { | ||
| "can_create_projects": true, | ||
| "can_pin_projects": true, | ||
| "can_create_users": true, | ||
| "can_upload_files": true | ||
| }, | ||
| "subscription": { | ||
| "short_name": "ClientsV1", | ||
| "proper_name": "Basecamp With Clients", | ||
| "project_limit": null, | ||
| "teams": true, | ||
| "clients": true, | ||
| "templates": true, | ||
| "logo": true, | ||
| "timesheet": true | ||
| }, | ||
| "settings": { | ||
| "company_hq_enabled": false, | ||
| "teams_enabled": true, | ||
| "projects_enabled": true | ||
| } | ||
| } | ||
| ``` | ||
| <!-- END GET /account.json --> | ||
|
|
||
| ###### Copy as cURL | ||
|
|
||
| ```shell | ||
| curl -s -H "Authorization: Bearer $ACCESS_TOKEN" https://3.basecampapi.com/$ACCOUNT_ID/account.json | ||
| ``` | ||
|
|
||
| Update account name | ||
| ------------------- | ||
|
|
||
| * `PUT /account/name.json` will rename the current account. Only account owners can use this endpoint — returns `403 Forbidden` for non-owners. | ||
|
|
||
| **Required parameters**: | ||
|
|
||
| * `name` - the new name for the account. Returns `400 Bad Request` when blank. | ||
jeremy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| This endpoint returns `200 OK` with the full [account](#get-account) JSON representation on success. | ||
|
|
||
| ###### Example JSON Request | ||
|
|
||
| ```json | ||
| { | ||
| "name": "Honcho Design Studio" | ||
| } | ||
| ``` | ||
|
|
||
| ###### Example JSON Response | ||
| <!-- START PUT /account/name.json --> | ||
| ```json | ||
| { | ||
| "id": 1009501286, | ||
| "name": "Honcho Design Studio", | ||
| "owner_name": "Victor Cooper", | ||
| "active": true, | ||
| "created_at": "2026-03-16T21:42:20.134Z", | ||
| "updated_at": "2026-03-16T21:57:21.979Z", | ||
| "trial": false, | ||
| "trial_ends_on": null, | ||
| "frozen": false, | ||
| "paused": false, | ||
| "limits": { | ||
| "can_create_projects": true, | ||
| "can_pin_projects": true, | ||
| "can_create_users": true, | ||
| "can_upload_files": true | ||
| }, | ||
| "subscription": { | ||
| "short_name": "ClientsV1", | ||
| "proper_name": "Basecamp With Clients", | ||
| "project_limit": null, | ||
| "teams": true, | ||
| "clients": true, | ||
| "templates": true, | ||
| "logo": true, | ||
| "timesheet": true | ||
| }, | ||
| "settings": { | ||
| "company_hq_enabled": false, | ||
| "teams_enabled": true, | ||
| "projects_enabled": true | ||
| } | ||
| } | ||
| ``` | ||
| <!-- END PUT /account/name.json --> | ||
|
|
||
| ###### Copy as cURL | ||
|
|
||
| ```shell | ||
| curl -s -H "Authorization: Bearer $ACCESS_TOKEN" \ | ||
| -H "Content-Type: application/json" \ | ||
| -X PUT \ | ||
| -d '{"name":"Honcho Design Studio"}' \ | ||
| https://3.basecampapi.com/$ACCOUNT_ID/account/name.json | ||
| ``` | ||
|
|
||
| Update account logo | ||
| ------------------- | ||
|
|
||
| * `PUT /account/logo.json` will upload or replace the account logo. Only administrators and account owners can use this endpoint — returns `403 Forbidden` for others. | ||
|
|
||
| Account logos use direct multipart file upload rather than the standard two-stage `/attachments` flow used elsewhere in the API. | ||
|
|
||
| **Required parameters**: | ||
|
|
||
| * `logo` - the logo image file, sent as a multipart form upload. Accepted formats: PNG, JPEG, GIF, WebP, AVIF, HEIC. Maximum file size: 5 MB. Returns `422 Unprocessable Entity` when the file is missing, the format is invalid, or the file exceeds 5 MB. | ||
|
|
||
| Returns `204 No Content` on success. | ||
|
|
||
| ###### Copy as cURL | ||
|
|
||
| ```shell | ||
| curl -s -H "Authorization: Bearer $ACCESS_TOKEN" \ | ||
| -X PUT \ | ||
| -F "logo=@company-logo.png" \ | ||
| https://3.basecampapi.com/$ACCOUNT_ID/account/logo.json | ||
| ``` | ||
|
|
||
| Remove account logo | ||
| ------------------- | ||
|
|
||
| * `DELETE /account/logo.json` will remove the account logo. Only administrators and account owners can use this endpoint — returns `403 Forbidden` for others. | ||
|
|
||
| Returns `204 No Content` on success. | ||
|
|
||
| ###### Copy as cURL | ||
|
|
||
| ```shell | ||
| curl -s -H "Authorization: Bearer $ACCESS_TOKEN" \ | ||
| -X DELETE \ | ||
| https://3.basecampapi.com/$ACCOUNT_ID/account/logo.json | ||
| ``` | ||
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.