Skip to main content

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.

Server path: /basecamp-projects | Type: Application | PCID required: Yes

Tools

ToolDescription
basecamp_projects_create_projectCreate a new project
basecamp_projects_disable_out_of_officeDisable out of office for a person. Admins on Pro Pack accounts can manage others; otherwise self only.
basecamp_projects_enable_out_of_officeEnable or replace out of office for a person. Admins on Pro Pack accounts can manage others; otherwise self only.
basecamp_projects_get_accountGet the account for the current access token
basecamp_projects_get_assigned_todosGet todos assigned to a specific person
basecamp_projects_get_client_approvalGet a single client approval by id
basecamp_projects_get_client_correspondenceGet a single client correspondence by id
basecamp_projects_get_client_replyGet a single client reply by id
basecamp_projects_get_my_assignmentsGet 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_assignmentsGet the current user’s completed assignments. Archived and trashed recordings are excluded. This endpoint is not paginated.
basecamp_projects_get_my_due_assignmentsGet 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_notificationsGet 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_preferencesGet the current user’s preferences
basecamp_projects_get_my_profileGet the current authenticated user’s profile
basecamp_projects_get_out_of_officeGet the out of office status for a person
basecamp_projects_get_overdue_todosGet overdue todos grouped by lateness
basecamp_projects_get_personGet a person by ID
basecamp_projects_get_person_progressGet a person’s activity timeline
basecamp_projects_get_progress_reportGet account-wide activity feed (progress report)
basecamp_projects_get_projectGet a single project by id
basecamp_projects_get_project_timelineGet project timeline
basecamp_projects_get_subscriptionGet subscription information for a recording
basecamp_projects_get_upcoming_scheduleGet upcoming schedule entries within a date window
basecamp_projects_list_assignable_peopleList people who can be assigned todos
basecamp_projects_list_client_approvalsList 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_correspondencesList 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_repliesList 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_peopleList 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_peopleList 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_peopleList 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_projectsList 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_readMark specified items as read
basecamp_projects_remove_account_logoRemove the account logo. Only administrators and account owners can use this endpoint.
basecamp_projects_set_client_visibilitySet client visibility for a recording
basecamp_projects_subscribeSubscribe the current user to a recording
basecamp_projects_trash_projectTrash a project (returns 204 No Content)
basecamp_projects_unsubscribeUnsubscribe the current user from a recording
basecamp_projects_update_account_logoUpload or replace the account logo. Accepted formats: PNG, JPEG, GIF, WebP, AVIF, HEIC. Maximum 5 MB. Owners and admins only.
basecamp_projects_update_account_nameRename the current account. Only account owners can use this endpoint.
basecamp_projects_update_my_preferencesUpdate the current user’s preferences
basecamp_projects_update_my_profileUpdate the current authenticated user’s profile (returns 204 No Content)
basecamp_projects_update_projectUpdate an existing project
basecamp_projects_update_project_accessUpdate project access (grant/revoke/create people)
basecamp_projects_update_subscriptionUpdate subscriptions by adding or removing specific users

basecamp_projects_create_project

Create a new project Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoThe description value
namestringYesThe 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:
ParameterTypeRequiredDefaultDescription
personIdintegerYesPerson 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:
ParameterTypeRequiredDefaultDescription
personIdintegerYesPerson Id
out_of_officeobjectYesOut Of Office

basecamp_projects_get_account

Get the account for the current access token

basecamp_projects_get_assigned_todos

Get todos assigned to a specific person Parameters:
ParameterTypeRequiredDefaultDescription
personIdintegerYesPerson Id
group_bystringNoGroup by “bucket” or “date”

basecamp_projects_get_client_approval

Get a single client approval by id Parameters:
ParameterTypeRequiredDefaultDescription
approvalIdintegerYesApproval Id

basecamp_projects_get_client_correspondence

Get a single client correspondence by id Parameters:
ParameterTypeRequiredDefaultDescription
correspondenceIdintegerYesCorrespondence Id

basecamp_projects_get_client_reply

Get a single client reply by id Parameters:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id
replyIdintegerYesReply 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:
ParameterTypeRequiredDefaultDescription
scopestringNoFilter 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:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for paginating through read items. Defaults to 1.

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 Parameters:
ParameterTypeRequiredDefaultDescription
personIdintegerYesPerson Id

basecamp_projects_get_overdue_todos

Get overdue todos grouped by lateness

basecamp_projects_get_person

Get a person by ID Parameters:
ParameterTypeRequiredDefaultDescription
personIdintegerYesPerson Id

basecamp_projects_get_person_progress

Get a person’s activity timeline Parameters:
ParameterTypeRequiredDefaultDescription
personIdintegerYesPerson Id

basecamp_projects_get_progress_report

Get account-wide activity feed (progress report)

basecamp_projects_get_project

Get a single project by id Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesProject Id

basecamp_projects_get_project_timeline

Get project timeline Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesProject Id

basecamp_projects_get_subscription

Get subscription information for a recording Parameters:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id

basecamp_projects_get_upcoming_schedule

Get upcoming schedule entries within a date window Parameters:
ParameterTypeRequiredDefaultDescription
window_starts_onstringNoWindow Starts On
window_ends_onstringNoWindow Ends On

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. Parameters:
ParameterTypeRequiredDefaultDescription
sortstringNocreated_at|updated_at
directionstringNoasc|desc

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. Parameters:
ParameterTypeRequiredDefaultDescription
sortstringNocreated_at|updated_at
directionstringNoasc|desc

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. Parameters:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id

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. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesProject Id

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. Parameters:
ParameterTypeRequiredDefaultDescription
statusstringNoactive|archived|trashed

basecamp_projects_mark_as_read

Mark specified items as read Parameters:
ParameterTypeRequiredDefaultDescription
readablesstring[]YesArray of readable_sgid values identifying the items to mark as read

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:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id
visible_to_clientsbooleanYesVisible To Clients

basecamp_projects_subscribe

Subscribe the current user to a recording Parameters:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id

basecamp_projects_trash_project

Trash a project (returns 204 No Content) Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesProject Id

basecamp_projects_unsubscribe

Unsubscribe the current user from a recording Parameters:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id

Upload or replace the account logo. Accepted formats: PNG, JPEG, GIF, WebP, AVIF, HEIC. Maximum 5 MB. Owners and admins only. Parameters:
ParameterTypeRequiredDefaultDescription
logostringNoThe logo value

basecamp_projects_update_account_name

Rename the current account. Only account owners can use this endpoint. Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name value

basecamp_projects_update_my_preferences

Update the current user’s preferences Parameters:
ParameterTypeRequiredDefaultDescription
personobjectYesThe person value

basecamp_projects_update_my_profile

Update the current authenticated user’s profile (returns 204 No Content) Parameters:
ParameterTypeRequiredDefaultDescription
biostringNoThe bio value
email_addressstringNoEmail Address
first_week_daystringNoFirst Week Day
locationstringNoThe location value
namestringNoThe name value
time_formatstringNoTime Format
time_zone_namestringNoTime Zone Name
titlestringNoThe title value

basecamp_projects_update_project

Update an existing project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesProject Id
admissionsstringNoinvite|employee|team
descriptionstringNoThe description value
namestringYesThe name value
schedule_attributesobjectNoSchedule Attributes

basecamp_projects_update_project_access

Update project access (grant/revoke/create people) Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesProject Id
createobject[]NoThe create value
grantinteger[]NoThe grant value
revokeinteger[]NoThe revoke value

basecamp_projects_update_subscription

Update subscriptions by adding or removing specific users Parameters:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id
subscriptionsinteger[]NoThe subscriptions value
unsubscriptionsinteger[]NoThe unsubscriptions value