-
Notifications
You must be signed in to change notification settings - Fork 119
Sync API docs from bc3: add and remove clients on a project (PUT /projects/:id/people/client_users, client_enablement) #443
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
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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,88 @@ | ||
| Backlinks | ||
| ========= | ||
|
|
||
| A backlink records that one [recording][recordings] references another in its rich text content. The backlinks endpoint lists the recordings that reference a given recording — the "references to this" shown in the Basecamp UI. | ||
|
|
||
| Only backlinks from projects and pings the current user can access are returned, so two people requesting the same recording's backlinks may see different lists. | ||
|
|
||
| Endpoints: | ||
|
|
||
| - [Get backlinks](#get-backlinks) | ||
|
|
||
| Get backlinks | ||
| ------------- | ||
|
|
||
| * `GET /recordings/2/backlinks.json` will return the most recent 20 recordings that reference the recording with an ID of `2`, newest first. | ||
|
|
||
| Each entry is a [recording][recordings] — the referencing recording, not the backlink itself. | ||
|
|
||
| ###### Example JSON Response | ||
| ```json | ||
| [ | ||
| { | ||
| "id": 1069480024, | ||
| "status": "active", | ||
| "visible_to_clients": false, | ||
| "created_at": "2026-07-19T14:22:11.000Z", | ||
| "updated_at": "2026-07-19T14:22:11.000Z", | ||
| "title": "Finalize launch checklist", | ||
| "inherits_status": true, | ||
| "type": "Todo", | ||
| "url": "https://3.basecampapi.com/195539477/buckets/2085958505/todos/1069480024.json", | ||
| "app_url": "https://3.basecamp.com/195539477/buckets/2085958505/todos/1069480024", | ||
| "bookmark_url": "https://3.basecampapi.com/195539477/my/bookmarks/BAh7BkkiC19yYWlscwY6BkVUewdJIglkYXRhBjsAVEkiLmdpZDovL2JjMy9SZWNvcmRpbmcvMTA2OTQ4MDAyND9leHBpcmVzX2luBjsAVEkiCHB1cgY7AFRJIg1yZWFkYWJsZQY7AFQ=--0000000000000000000000000000000000000000.json", | ||
| "subscription_url": "https://3.basecampapi.com/195539477/buckets/2085958505/recordings/1069480024/subscription.json", | ||
| "parent": { | ||
| "id": 1069479830, | ||
| "title": "Launch", | ||
| "type": "Todolist", | ||
| "url": "https://3.basecampapi.com/195539477/buckets/2085958505/todolists/1069479830.json", | ||
| "app_url": "https://3.basecamp.com/195539477/buckets/2085958505/todolists/1069479830" | ||
| }, | ||
| "bucket": { | ||
| "id": 2085958505, | ||
| "name": "The Leto Laptop", | ||
| "type": "Project" | ||
| }, | ||
| "creator": { | ||
| "id": 1049715929, | ||
| "attachable_sgid": "BAh7BkkiC19yYWlscwY6BkVUewdJIglkYXRhBjsAVEkiK2dpZDovL2JjMy9QZXJzb24vMTA0OTcxNTkyOT9leHBpcmVzX2luBjsAVEkiCHB1cgY7AFRJIg9hdHRhY2hhYmxlBjsAVA==--0000000000000000000000000000000000000000", | ||
| "name": "Matt Donahue", | ||
| "personable_type": "User", | ||
| "title": "Global Data Strategist", | ||
| "tagline": null, | ||
| "location": null, | ||
| "created_at": "2026-05-28T17:22:27.821Z", | ||
| "updated_at": "2026-05-28T17:22:27.821Z", | ||
| "email_address": "matt@honchodesign.com", | ||
| "bio": null, | ||
| "admin": false, | ||
| "owner": false, | ||
| "client": false, | ||
| "employee": false, | ||
| "time_zone": "America/Chicago", | ||
| "avatar_url": "https://3.basecampapi.com/195539477/people/BAhpBNlkkT4=--0000000000000000000000000000000000000000/avatar", | ||
| "can_ping": true, | ||
| "can_manage_projects": true, | ||
| "can_manage_people": true, | ||
| "can_access_timesheet": true, | ||
| "can_access_hill_charts": true | ||
| } | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| ###### Copy as cURL | ||
|
|
||
| ```shell | ||
| curl -s -H "Authorization: Bearer $ACCESS_TOKEN" https://3.basecampapi.com/$ACCOUNT_ID/recordings/2/backlinks.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. | ||
|
|
||
| * `GET /buckets/1/recordings/2/backlinks.json` → [Get backlinks](#get-backlinks) | ||
|
|
||
| [recordings]: recordings.md#recordings | ||
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.