Server path:Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
/basecamp-projects | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
basecamp_projects_create_project | Create a new project |
basecamp_projects_disable_out_of_office | Disable out of office for a person. Admins on Pro Pack accounts can manage others; otherwise self only. |
basecamp_projects_enable_out_of_office | Enable or replace out of office for a person. Admins on Pro Pack accounts can manage others; otherwise self only. |
basecamp_projects_get_account | Get the account for the current access token |
basecamp_projects_get_assigned_todos | Get todos assigned to a specific person |
basecamp_projects_get_client_approval | Get a single client approval by id |
basecamp_projects_get_client_correspondence | Get a single client correspondence by id |
basecamp_projects_get_client_reply | Get a single client reply by id |
basecamp_projects_get_my_assignments | Get the current user’s active assignments grouped into priorities and non_priorities. Card table steps are normalized to their parent card with steps as children. This endpoint is not paginated. |
basecamp_projects_get_my_completed_assignments | Get the current user’s completed assignments. Archived and trashed recordings are excluded. This endpoint is not paginated. |
basecamp_projects_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. |
basecamp_projects_get_my_notifications | Get the current user’s notification inbox (the “Hey!” menu). Notifications are grouped into unreads, reads, and memories. Reads are paginated (50 per page). Unreads are capped at 100. |
basecamp_projects_get_my_preferences | Get the current user’s preferences |
basecamp_projects_get_my_profile | Get the current authenticated user’s profile |
basecamp_projects_get_out_of_office | Get the out of office status for a person |
basecamp_projects_get_overdue_todos | Get overdue todos grouped by lateness |
basecamp_projects_get_person | Get a person by ID |
basecamp_projects_get_person_progress | Get a person’s activity timeline |
basecamp_projects_get_progress_report | Get account-wide activity feed (progress report) |
basecamp_projects_get_project | Get a single project by id |
basecamp_projects_get_project_timeline | Get project timeline |
basecamp_projects_get_subscription | Get subscription information for a recording |
basecamp_projects_get_upcoming_schedule | Get upcoming schedule entries within a date window |
basecamp_projects_list_assignable_people | List people who can be assigned todos |
basecamp_projects_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. |
basecamp_projects_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. |
basecamp_projects_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. |
basecamp_projects_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. |
basecamp_projects_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. |
basecamp_projects_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. |
basecamp_projects_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. |
basecamp_projects_mark_as_read | Mark specified items as read |
basecamp_projects_remove_account_logo | Remove the account logo. Only administrators and account owners can use this endpoint. |
basecamp_projects_set_client_visibility | Set client visibility for a recording |
basecamp_projects_subscribe | Subscribe the current user to a recording |
basecamp_projects_trash_project | Trash a project (returns 204 No Content) |
basecamp_projects_unsubscribe | Unsubscribe the current user from a recording |
basecamp_projects_update_account_logo | Upload or replace the account logo. Accepted formats: PNG, JPEG, GIF, WebP, AVIF, HEIC. Maximum 5 MB. Owners and admins only. |
basecamp_projects_update_account_name | Rename the current account. Only account owners can use this endpoint. |
basecamp_projects_update_my_preferences | Update the current user’s preferences |
basecamp_projects_update_my_profile | Update the current authenticated user’s profile (returns 204 No Content) |
basecamp_projects_update_project | Update an existing project |
basecamp_projects_update_project_access | Update project access (grant/revoke/create people) |
basecamp_projects_update_subscription | Update subscriptions by adding or removing specific users |
basecamp_projects_create_project
Create a new project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | The description value |
name | string | Yes | — | The name value |
basecamp_projects_disable_out_of_office
Disable out of office for a person. Admins on Pro Pack accounts can manage others; otherwise self only. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
personId | integer | Yes | — | Person Id |
basecamp_projects_enable_out_of_office
Enable or replace out of office for a person. Admins on Pro Pack accounts can manage others; otherwise self only. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
personId | integer | Yes | — | Person Id |
out_of_office | object | Yes | — | Out Of Office |
basecamp_projects_get_account
Get the account for the current access tokenbasecamp_projects_get_assigned_todos
Get todos assigned to a specific person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
personId | integer | Yes | — | Person Id |
group_by | string | No | — | Group by “bucket” or “date” |
basecamp_projects_get_client_approval
Get a single client approval by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
approvalId | integer | Yes | — | Approval Id |
basecamp_projects_get_client_correspondence
Get a single client correspondence by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
correspondenceId | integer | Yes | — | Correspondence Id |
basecamp_projects_get_client_reply
Get a single client reply by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recordingId | integer | Yes | — | Recording Id |
replyId | integer | Yes | — | Reply Id |
basecamp_projects_get_my_assignments
Get the current user’s active assignments grouped into priorities and non_priorities. Card table steps are normalized to their parent card with steps as children. This endpoint is not paginated.basecamp_projects_get_my_completed_assignments
Get the current user’s completed assignments. Archived and trashed recordings are excluded. This endpoint is not paginated.basecamp_projects_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. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
scope | string | No | — | Filter by due date range: overdue, due_today, due_tomorrow, due_later_this_week, due_next_week, due_later |
basecamp_projects_get_my_notifications
Get the current user’s notification inbox (the “Hey!” menu). Notifications are grouped into unreads, reads, and memories. Reads are paginated (50 per page). Unreads are capped at 100. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for paginating through read items. Defaults to 1. |
basecamp_projects_get_my_preferences
Get the current user’s preferencesbasecamp_projects_get_my_profile
Get the current authenticated user’s profilebasecamp_projects_get_out_of_office
Get the out of office status for a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
personId | integer | Yes | — | Person Id |
basecamp_projects_get_overdue_todos
Get overdue todos grouped by latenessbasecamp_projects_get_person
Get a person by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
personId | integer | Yes | — | Person Id |
basecamp_projects_get_person_progress
Get a person’s activity timeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
personId | integer | Yes | — | Person Id |
basecamp_projects_get_progress_report
Get account-wide activity feed (progress report)basecamp_projects_get_project
Get a single project by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | Project Id |
basecamp_projects_get_project_timeline
Get project timeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | Project Id |
basecamp_projects_get_subscription
Get subscription information for a recording Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recordingId | integer | Yes | — | Recording Id |
basecamp_projects_get_upcoming_schedule
Get upcoming schedule entries within a date window Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
window_starts_on | string | No | — | Window Starts On |
window_ends_on | string | No | — | Window Ends On |
basecamp_projects_list_assignable_people
List people who can be assigned todosbasecamp_projects_list_client_approvals
List all client approvals in a project Pagination: Uses Link header (RFC5988). Follow thenext rel URL to fetch additional pages. X-Total-Count header provides total count.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sort | string | No | — | created_at|updated_at |
direction | string | No | — | asc|desc |
basecamp_projects_list_client_correspondences
List all client correspondences in a project Pagination: Uses Link header (RFC5988). Follow thenext rel URL to fetch additional pages. X-Total-Count header provides total count.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sort | string | No | — | created_at|updated_at |
direction | string | No | — | asc|desc |
basecamp_projects_list_client_replies
List all client replies for a recording (correspondence or approval) Pagination: Uses Link header (RFC5988). Follow thenext rel URL to fetch additional pages. X-Total-Count header provides total count.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recordingId | integer | Yes | — | Recording Id |
basecamp_projects_list_people
List all people visible to the current user Pagination: Uses Link header (RFC5988). Follow thenext rel URL to fetch additional pages. X-Total-Count header provides total count.
basecamp_projects_list_pingable_people
List all account users who can be pinged Pagination: Uses Link header (RFC5988). Follow thenext rel URL to fetch additional pages. X-Total-Count header provides total count.
basecamp_projects_list_project_people
List all active people on a project Pagination: Uses Link header (RFC5988). Follow thenext rel URL to fetch additional pages. X-Total-Count header provides total count.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | Project Id |
basecamp_projects_list_projects
List projects (active by default; optionally archived/trashed) Pagination: Uses Link header (RFC5988). Follow thenext rel URL to fetch additional pages. X-Total-Count header provides total count.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | active|archived|trashed |
basecamp_projects_mark_as_read
Mark specified items as read Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
readables | string[] | Yes | — | Array of readable_sgid values identifying the items to mark as read |
basecamp_projects_remove_account_logo
Remove the account logo. Only administrators and account owners can use this endpoint.basecamp_projects_set_client_visibility
Set client visibility for a recording Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recordingId | integer | Yes | — | Recording Id |
visible_to_clients | boolean | Yes | — | Visible To Clients |
basecamp_projects_subscribe
Subscribe the current user to a recording Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recordingId | integer | Yes | — | Recording Id |
basecamp_projects_trash_project
Trash a project (returns 204 No Content) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | Project Id |
basecamp_projects_unsubscribe
Unsubscribe the current user from a recording Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recordingId | integer | Yes | — | Recording Id |
basecamp_projects_update_account_logo
Upload or replace the account logo. Accepted formats: PNG, JPEG, GIF, WebP, AVIF, HEIC. Maximum 5 MB. Owners and admins only. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
logo | string | No | — | The logo value |
basecamp_projects_update_account_name
Rename the current account. Only account owners can use this endpoint. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name value |
basecamp_projects_update_my_preferences
Update the current user’s preferences Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
person | object | Yes | — | The person value |
basecamp_projects_update_my_profile
Update the current authenticated user’s profile (returns 204 No Content) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bio | string | No | — | The bio value |
email_address | string | No | — | Email Address |
first_week_day | string | No | — | First Week Day |
location | string | No | — | The location value |
name | string | No | — | The name value |
time_format | string | No | — | Time Format |
time_zone_name | string | No | — | Time Zone Name |
title | string | No | — | The title value |
basecamp_projects_update_project
Update an existing project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | Project Id |
admissions | string | No | — | invite|employee|team |
description | string | No | — | The description value |
name | string | Yes | — | The name value |
schedule_attributes | object | No | — | Schedule Attributes |
basecamp_projects_update_project_access
Update project access (grant/revoke/create people) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | Project Id |
create | object[] | No | — | The create value |
grant | integer[] | No | — | The grant value |
revoke | integer[] | No | — | The revoke value |
basecamp_projects_update_subscription
Update subscriptions by adding or removing specific users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recordingId | integer | Yes | — | Recording Id |
subscriptions | integer[] | No | — | The subscriptions value |
unsubscriptions | integer[] | No | — | The unsubscriptions value |

