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-automation | Type: Application | PCID required: Yes

Tools

ToolDescription
basecamp_automation_archive_recordingArchive a recording
basecamp_automation_clone_toolClone an existing tool to create a new one
basecamp_automation_create_answerCreate a new answer for a question
basecamp_automation_create_lineup_markerCreate a new lineup marker
basecamp_automation_create_project_from_templateCreate a project from a template (asynchronous)
basecamp_automation_create_questionCreate a new question in a questionnaire
basecamp_automation_create_templateCreate a new template
basecamp_automation_create_webhookCreate a new webhook for a project
basecamp_automation_delete_lineup_markerDelete a lineup marker
basecamp_automation_delete_templateDelete a template (trash it)
basecamp_automation_delete_toolDelete a tool (trash it)
basecamp_automation_delete_webhookDelete a webhook
basecamp_automation_disable_toolDisable a tool (hide it from the project dock)
basecamp_automation_enable_toolEnable a tool (show it on the project dock)
basecamp_automation_get_answerGet a single answer by id
basecamp_automation_get_answers_by_personGet all answers from a specific person for a question Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages.
basecamp_automation_get_project_constructionGet the status of a project construction
basecamp_automation_get_questionGet a single question by id
basecamp_automation_get_question_remindersGet pending check-in reminders for the current user Returns questions that are pending a response from the authenticated user. Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages.
basecamp_automation_get_questionnaireGet a questionnaire (automatic check-ins container) by id
basecamp_automation_get_recordingGet a single recording by id
basecamp_automation_get_search_metadataGet search metadata (available filter options)
basecamp_automation_get_templateGet a single template by id
basecamp_automation_get_toolGet a dock tool by id
basecamp_automation_get_webhookGet a single webhook by id
basecamp_automation_list_answersList all answers for a question Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.
basecamp_automation_list_eventsList all events for a recording Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.
basecamp_automation_list_lineup_markersList all lineup markers for the account
basecamp_automation_list_question_answerersList all people who have answered a question (answerers) Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages.
basecamp_automation_list_questionsList all questions in a questionnaire Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.
basecamp_automation_list_recordingsList recordings of a given type across projects Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.
basecamp_automation_list_templatesList all templates 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_automation_list_webhooksList all webhooks for a project Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count.
basecamp_automation_pause_questionPause a check-in question (stops sending reminders)
basecamp_automation_reposition_toolReposition a tool on the project dock
basecamp_automation_resume_questionResume a paused check-in question (resumes sending reminders)
basecamp_automation_searchSearch for content across the account
basecamp_automation_trash_recordingTrash a recording
basecamp_automation_unarchive_recordingUnarchive a recording (restore to active status)
basecamp_automation_update_answerUpdate an existing answer
basecamp_automation_update_lineup_markerUpdate an existing lineup marker
basecamp_automation_update_questionUpdate an existing question
basecamp_automation_update_question_notification_settingsUpdate notification settings for a check-in question
basecamp_automation_update_templateUpdate an existing template
basecamp_automation_update_toolUpdate (rename) an existing tool
basecamp_automation_update_webhookUpdate an existing webhook

basecamp_automation_archive_recording

Archive a recording Parameters:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id

basecamp_automation_clone_tool

Clone an existing tool to create a new one Parameters:
ParameterTypeRequiredDefaultDescription
source_recording_idintegerYesSource Recording Id
titlestringNoThe title value

basecamp_automation_create_answer

Create a new answer for a question Parameters:
ParameterTypeRequiredDefaultDescription
questionIdintegerYesQuestion Id
contentstringYesThe content value
group_onstringNoGroup On

basecamp_automation_create_lineup_marker

Create a new lineup marker Parameters:
ParameterTypeRequiredDefaultDescription
datestringYesThe date value
namestringYesThe name value

basecamp_automation_create_project_from_template

Create a project from a template (asynchronous) Parameters:
ParameterTypeRequiredDefaultDescription
templateIdintegerYesTemplate Id
descriptionstringNoThe description value
namestringYesThe name value

basecamp_automation_create_question

Create a new question in a questionnaire Parameters:
ParameterTypeRequiredDefaultDescription
questionnaireIdintegerYesQuestionnaire Id
scheduleobjectYesThe schedule value
titlestringYesThe title value

basecamp_automation_create_template

Create a new template Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoThe description value
namestringYesThe name value

basecamp_automation_create_webhook

Create a new webhook for a project Parameters:
ParameterTypeRequiredDefaultDescription
bucketIdintegerYesBucket Id
activebooleanNoThe active value
payload_urlstringYesPayload Url
typesstring[]YesThe types value

basecamp_automation_delete_lineup_marker

Delete a lineup marker Parameters:
ParameterTypeRequiredDefaultDescription
markerIdintegerYesMarker Id

basecamp_automation_delete_template

Delete a template (trash it) Parameters:
ParameterTypeRequiredDefaultDescription
templateIdintegerYesTemplate Id

basecamp_automation_delete_tool

Delete a tool (trash it) Parameters:
ParameterTypeRequiredDefaultDescription
toolIdintegerYesTool Id

basecamp_automation_delete_webhook

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdintegerYesWebhook Id

basecamp_automation_disable_tool

Disable a tool (hide it from the project dock) Parameters:
ParameterTypeRequiredDefaultDescription
toolIdintegerYesTool Id

basecamp_automation_enable_tool

Enable a tool (show it on the project dock) Parameters:
ParameterTypeRequiredDefaultDescription
toolIdintegerYesTool Id

basecamp_automation_get_answer

Get a single answer by id Parameters:
ParameterTypeRequiredDefaultDescription
answerIdintegerYesAnswer Id

basecamp_automation_get_answers_by_person

Get all answers from a specific person for a question Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. Parameters:
ParameterTypeRequiredDefaultDescription
questionIdintegerYesQuestion Id
personIdintegerYesPerson Id

basecamp_automation_get_project_construction

Get the status of a project construction Parameters:
ParameterTypeRequiredDefaultDescription
templateIdintegerYesTemplate Id
constructionIdintegerYesConstruction Id

basecamp_automation_get_question

Get a single question by id Parameters:
ParameterTypeRequiredDefaultDescription
questionIdintegerYesQuestion Id

basecamp_automation_get_question_reminders

Get pending check-in reminders for the current user Returns questions that are pending a response from the authenticated user. Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages.

basecamp_automation_get_questionnaire

Get a questionnaire (automatic check-ins container) by id Parameters:
ParameterTypeRequiredDefaultDescription
questionnaireIdintegerYesQuestionnaire Id

basecamp_automation_get_recording

Get a single recording by id Parameters:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id

basecamp_automation_get_search_metadata

Get search metadata (available filter options)

basecamp_automation_get_template

Get a single template by id Parameters:
ParameterTypeRequiredDefaultDescription
templateIdintegerYesTemplate Id

basecamp_automation_get_tool

Get a dock tool by id Parameters:
ParameterTypeRequiredDefaultDescription
toolIdintegerYesTool Id

basecamp_automation_get_webhook

Get a single webhook by id Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdintegerYesWebhook Id

basecamp_automation_list_answers

List all answers for a question Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count. Parameters:
ParameterTypeRequiredDefaultDescription
questionIdintegerYesQuestion Id

basecamp_automation_list_events

List all events for a recording 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_automation_list_lineup_markers

List all lineup markers for the account

basecamp_automation_list_question_answerers

List all people who have answered a question (answerers) Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. Parameters:
ParameterTypeRequiredDefaultDescription
questionIdintegerYesQuestion Id

basecamp_automation_list_questions

List all questions in a questionnaire Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count. Parameters:
ParameterTypeRequiredDefaultDescription
questionnaireIdintegerYesQuestionnaire Id

basecamp_automation_list_recordings

List recordings of a given type across projects Pagination: Uses Link header (RFC5988). Follow the next rel URL to fetch additional pages. X-Total-Count header provides total count. Parameters:
ParameterTypeRequiredDefaultDescription
typestringYesComment|Document|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault
bucketstringNoThe bucket value
statusstringNoactive|archived|trashed
sortstringNocreated_at|updated_at
directionstringNoasc|desc

basecamp_automation_list_templates

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

basecamp_automation_list_webhooks

List all webhooks for 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
bucketIdintegerYesBucket Id

basecamp_automation_pause_question

Pause a check-in question (stops sending reminders) Parameters:
ParameterTypeRequiredDefaultDescription
questionIdintegerYesQuestion Id

basecamp_automation_reposition_tool

Reposition a tool on the project dock Parameters:
ParameterTypeRequiredDefaultDescription
toolIdintegerYesTool Id
positionintegerYesThe position value

basecamp_automation_resume_question

Resume a paused check-in question (resumes sending reminders) Parameters:
ParameterTypeRequiredDefaultDescription
questionIdintegerYesQuestion Id

Search for content across the account Parameters:
ParameterTypeRequiredDefaultDescription
qstringYesThe q value
sortstringNobest_match|created_at

basecamp_automation_trash_recording

Trash a recording Parameters:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id

basecamp_automation_unarchive_recording

Unarchive a recording (restore to active status) Parameters:
ParameterTypeRequiredDefaultDescription
recordingIdintegerYesRecording Id

basecamp_automation_update_answer

Update an existing answer Parameters:
ParameterTypeRequiredDefaultDescription
answerIdintegerYesAnswer Id
contentstringYesThe content value
group_onstringNoGroup On

basecamp_automation_update_lineup_marker

Update an existing lineup marker Parameters:
ParameterTypeRequiredDefaultDescription
markerIdintegerYesMarker Id
datestringNoThe date value
namestringNoThe name value

basecamp_automation_update_question

Update an existing question Parameters:
ParameterTypeRequiredDefaultDescription
questionIdintegerYesQuestion Id
pausedbooleanNoThe paused value
scheduleobjectNoThe schedule value
titlestringNoThe title value

basecamp_automation_update_question_notification_settings

Update notification settings for a check-in question Parameters:
ParameterTypeRequiredDefaultDescription
questionIdintegerYesQuestion Id
digest_include_unansweredbooleanNoInclude unanswered in digest
notify_on_answerbooleanNoNotify when someone answers

basecamp_automation_update_template

Update an existing template Parameters:
ParameterTypeRequiredDefaultDescription
templateIdintegerYesTemplate Id
descriptionstringNoThe description value
namestringNoThe name value

basecamp_automation_update_tool

Update (rename) an existing tool Parameters:
ParameterTypeRequiredDefaultDescription
toolIdintegerYesTool Id
titlestringYesThe title value

basecamp_automation_update_webhook

Update an existing webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdintegerYesWebhook Id
activebooleanNoThe active value
payload_urlstringNoPayload Url
typesstring[]NoThe types value