# Workflow Actions Menu Source: https://docs.pinkfish.ai/agentic-editor/actions-menu Share, duplicate, tag, rename, delete, describe, and configure resources for a workflow — all from the header actions dropdown. Beyond the core editing surface, every workflow has a set of **admin actions** — sharing permissions, duplication, tagging, and resource configuration. These live in the actions dropdown at the top of the editor, triggered by the chevron button next to the workflow title. Workflow actions dropdown open from the chevron next to the workflow title — Description, Tag, Share, Duplicate, Delete, Rename, and Setup Integrations and Resources entries visible. ## Opening the menu Click the chevron (⌄) next to the workflow title in the header. A dropdown opens with every action you have permission to perform. If you don't have edit permissions, the menu is hidden entirely. ## Actions ### Description Set a free-form description for the workflow — what it does, who it's for, how to run it. The description appears: * As a preview in the actions dropdown (first 3 lines). * In the workflow library card. * When sharing the workflow with teammates. * In published templates for context. Click **Description** in the dropdown to open the edit modal. Supports multi-line text. ### Tag Assign tags to the workflow for filtering and organization in the library. One tag can be marked as the **primary tag**, which displays prominently on the library card. Click **Tag** to open the Tags modal. Add new tags, remove existing ones, and set the primary. Tags are shared across your organization — consistent tagging makes the library browsable. ### Share Open the Share modal to grant other users (or other orgs) access to this workflow. Access levels: * **Read** — can view the workflow but not edit or run it with their credentials. * **Run** — can execute the workflow. * **Edit** — can modify the workflow. * **Admin** — full control including sharing permissions. See [Sharing](/organization/sharing) for the broader sharing model. ### Duplicate Clone the workflow into a new automation. You can duplicate to: * **The current workspace** — a copy appears in your library with `(Copy)` appended to the name. * **Another workspace** (if you have permission) — pick the destination from a dropdown. After duplicating to the current workspace, Pinkfish navigates you to the new workflow and prompts you to **Set up integrations and resources** so you can reconfigure any connections that need workspace-specific credentials. ### Rename Rename the workflow. The name is editable inline in the header, or via the **Rename** action for a focused input field. ### Delete Permanently remove the workflow. Pinkfish shows a confirmation dialog: > **Delete Workflow** > Are you sure you want to delete this automation? Confirming deletes the workflow, all its release history, and any in-flight runs. **This is irreversible.** Triggered runs in progress may still complete; future invocations fail. Deletion also cascades to public template URLs and scheduled runs. If the workflow is shared or public, communicate with affected users before deleting. ### Setup Integrations and Resources Opens the **Workflow Resources Modal** — a panel that lists every [connection](/tools/connections), data collection, file, and secret the workflow depends on. Use it to: * **Reauthorize** expired connections. * **Swap** one connection for another of the same type. * **Configure resource sharing** so teammates running the workflow have the access they need. * **See resource-sharing issues** — the entry has an amber warning dot when Pinkfish detects that referenced resources aren't properly shared with intended collaborators. The entry also surfaces automatically on workflow load when resource sharing needs attention — the coding agent flags issues rather than letting them blow up at runtime. ## Running the dropdown vs. editor modes The dropdown's contents are subtly different depending on what you're doing: * **Editor mode** — shows every action. * **Monitor mode** — shows the actions but disables editing ones. * **Read-only preview of an older release** — only read-friendly actions are available. ## What's next The permission model that governs the Share action. How to authorize the integrations the resources modal manages. Public template publishing (related but separate from the Share action). Annotate and theme the workflow's appearance. # Adding Nodes Source: https://docs.pinkfish.ai/agentic-editor/adding-nodes Browse the node palette to add actions, triggers, and interfaces to your canvas — by category, by search, or by drilling into a specific app. You can let the [coding agent](/agentic-editor/chat) build the workflow for you, but often you want to add a specific node yourself. The **Add Node panel** opens a browsable catalog of everything you can drop onto the canvas — tool calls, code blocks, triggers, flow-control nodes, and the interface form. Add Node panel open on the Nodes tab showing categories: Setup Triggers, Flow Control, Media, Document, App Building, Resources, and more. ## Opening the panel Click the **Add Node** button in the top-right of the editor header. A side-panel slides in from the right with three tabs: **Nodes**, **Triggers**, and **Interface**. ## The three tabs Executable nodes — MCP tools, code blocks, agents, sub-workflows, flow-control. Entry points — manual, API, schedule, email, app triggers, events. The single user-facing form/results page for your workflow. ### Nodes tab The **Nodes** tab (titled **Elements** inside the panel — "Elements are the building blocks of your workflow") presents a two-column grid of categories. Click a category to drill into its contents; click the back arrow in the header to pop up. Top-level categories you'll see: | Category | What's in it | | - | - | | **Media** | Audio, video, and image-processing MCPs | | **Document** | PDF, Office, and general document tooling | | **App Building** | Artifact and web-application tools | | **Resources** | Vault, Filestore, Knowledge Base, Datastore | | **Agents & Workflows** | Call another Pinkfish agent or sub-workflow | | **Browser & Web** | Browser automation, scraping, HTTP utilities | | **Embedded LLMs** | Direct LLM calls — Anthropic, OpenAI, Gemini, Groq, Perplexity | | **Bring your own LLM** | Use your own LLM credentials | | **Database** | Structured and unstructured datastore MCPs | | **Others** | Email, weather, charting, miscellaneous tooling | | **Custom Integrations** | Pink-Connect integrations you or your org built | | **Integrations** | First-class third-party apps via MCP servers | Below the categories are two entry tiles: * **Setup Triggers** — a shortcut to the Triggers tab. * **Flow Control** — opens the flow-control picker (If-Else, Router, Merge, For Each, Delay, Loop, While, Parallel, Approval). And at the very bottom, **Custom Code Block** — "Add custom JavaScript code to your workflow". Drilled into the Integrations category showing a list of available third-party app integrations. ### Triggers tab The **Triggers** tab ("Triggers are the events that trigger your workflow") lists every way a workflow can start — Manual, API, Email, Schedule, App triggers, Events. See the [Triggers reference](/agentic-editor/triggers) for a full breakdown of each type. Triggers tab of the Add Node panel showing the available trigger types. ### Interface tab The **Interface** tab ("Configure user-facing interfaces for your workflow") holds a single card: **Add Interface**. Clicking it creates the Interface node and opens the [Interface builder](/agentic-editor/interface) in the right pane. You can only set up one interface per workflow. Delete the interface node to create a new one. Interface tab of the Add Node panel with a single Add Interface card. ## Searching The search field at the top of the panel filters across all categories and tabs. Type `slack` and you'll see Slack triggers, Slack tools, and Slack-referring skills all collapsed into one list. ## Drilling into a category Categories nest a few levels deep: 1. **Click a category** — e.g. **Integrations**. 2. **Pick an app** — e.g. **Salesforce**. 3. **Pick an action** — e.g. **Create Lead** or **Search Contacts**. The header at the top of the side-panel tracks your location with the app logo and a **← back** arrow, so you never lose your place. The close (✕) button always returns you to the editor regardless of how deep you've drilled. ## Placing the node When you select a leaf entry (an app action, flow-control node, or code block), the panel closes and the node is dropped onto the canvas — typically to the right of your most recently selected node. Drag it wherever you want; connect its input handle to an existing node's output to wire it in. For flow-control nodes, the agent often adds them with sensible defaults — an If-Else comes pre-wired to the currently selected node. You can always adjust the wiring by dragging the edges. ## What's next Deep dive on every node type and its settings. Start your workflow with a trigger. Build user-facing forms and result pages. Arrange and connect the nodes you've added. # Canvas Source: https://docs.pinkfish.ai/agentic-editor/canvas Arrange, connect, and execute nodes on the infinite canvas that sits at the heart of every Agent Mode workflow. The canvas is the visual workspace where your workflow lives. Every node — triggers, tool calls, code blocks, control flow, interfaces — appears as a tile that you can drag, connect, and inspect. The Agentic Editor uses an infinite pan-and-zoom canvas so even very large workflows stay navigable. Agent Mode canvas with a connected four-node workflow — a trigger connected to weather, formatting, and email-sending nodes. ## Navigating the canvas Click and drag on empty canvas, or hold Space and drag from anywhere. Scroll with the mouse wheel or pinch on a trackpad. Use the **+** / **−** controls in the bottom-left to zoom in fixed steps. Click the fit-to-view button in the canvas controls to frame all nodes in the current viewport. The minimap in the corner shows your full workflow and highlights the current viewport. Click anywhere in the minimap to jump there. ## Working with nodes ### Selecting nodes * **Single-select** — click a node. * **Multi-select** — hold `Shift` and click each node, or click on empty canvas and drag a selection box around them. * **Deselect** — click any empty area. Selected nodes get a highlighted ring and become the target of keyboard shortcuts like `Backspace` / `Delete`. ### Moving nodes Click and drag any node to reposition it. When you release, the new position is saved to the workflow automatically — there's no "save" button for layout. Multi-select and drag to move several nodes together. Pinkfish remembers your layout, so workflows always look the way you left them across sessions. ### Connecting nodes Each node has **handles** on its sides — input handles on the left, output handles on the right. Drag from an output handle to another node's input handle to create an edge between them. Release outside any handle to cancel. * Nodes with multiple outputs (like **If-Else** or **Router**) expose labeled handles — you'll see `true` / `false` for If-Else, and your custom labels for Router. * **Merge** nodes accept multiple incoming edges so you can fan several branches back into one path. ### Editing edges Click any edge to open the **Edge settings** panel on the right. For edges coming out of If-Else, Router, or other conditional nodes, this panel exposes the condition that gates whether execution follows the edge — including the full mention-based expression editor. Regular edges have minimal configuration (mostly a label). ### Deleting nodes and edges Select any node or edge and press `Backspace` or `Delete`. The **Manual** trigger cannot be deleted — every workflow needs at least one entry point. ## Canvas controls The bottom-left of the canvas hosts a small toolbar with four controls: | Button | Action | | - | - | | 🧹 Auto-layout | Re-flows all nodes into a clean, left-to-right layout. Safe to click — you can always undo. | | ↶ Undo | Step back through diagram edits: node adds, moves, deletes, edge changes. Disabled when there's nothing to undo. | | ↷ Redo | Step forward after an undo. Disabled when there's nothing to redo. | | ➕ Zoom / fit | ReactFlow's standard zoom and fit-to-view controls. | Undo and redo operate on **canvas structure** only — node positions, edges, sticky notes, node additions and deletions. They do not undo content changes inside a node's settings panel; those persist as you type. ## The right-click menu Right-clicking a selected node opens a context menu with quick actions: * **Run until this node** — runs the workflow from its trigger up to (and including) this node, then stops. Useful for iterating on a specific step. * **Run entire workflow** (on trigger nodes) — fires the workflow from this trigger. * **Add node to the chat context** — piles the node into the Coding Agent Chat's context so your next prompt references it directly. * **View node details** — opens the node's settings side-panel, same as a double-click. * **Delete** — removes the node. Disabled for the Manual trigger. Right-click context menu open on the Manual Trigger node showing Run entire workflow and View node details. ## Node status indicators While a workflow runs, every node displays its live status via color and iconography: * **Pending** — gray outline, waiting to run. * **Running** — animated pulse on the node border. * **Success** — green checkmark badge in the top-right corner. * **Error** — red exclamation badge; click to open the error in the Log tab. * **Skipped** — dimmed with a slash badge when the node was bypassed (for example, the "false" branch of an If-Else). Canvas after a completed run with green checkmark status badges on the executed nodes. ## Hover actions Hovering over a node reveals a small menu with shortcut buttons — typically **Run**, **Open settings**, and **Delete**. The hover menu is a faster path for the most common actions without needing the right-click menu. ## Collaborating on the canvas When two or more teammates open the same agentic workflow, the canvas automatically switches into collaborative mode. No setting to toggle — if anyone else is in the editor, you see them. ### Avatars A group of avatars appears in the editor header showing who else is in the workflow right now. Up to four avatars are visible at once; any additional collaborators are grouped behind a **+N** pill you can hover to see the full list. Each avatar is color-coded per user, and the same color is used for that person's cursor on the canvas. When a collaborator becomes idle (no mouse or keyboard activity for about two minutes) their avatar fades to half opacity. ### Live cursors Every other collaborator's cursor is rendered live on the canvas, labelled with their name and tinted with their avatar color. Cursor updates are throttled to stay smooth even with many collaborators in the same workflow. ### Real-time node dragging When another user picks up and drags a node, the node's position updates in real time on your canvas. This makes it easy to follow along while a teammate rearranges the graph during a pairing session. ### What is and isn't shared * **Shared in real time:** cursor position, node positions while being dragged, idle/active status, and each collaborator's name, avatar, and color. * **Not shared in real time:** selections, node edits, settings panel content, sticky-note edits, canvas pan/zoom, and chat messages. Each user has their own view of these. Edits still persist to the workflow as normal — if your teammate adds a new node, it appears in your canvas the next time the workflow data refreshes (typically within a second or two), not as a live stream. Treat collaboration as **presence awareness plus cursor sharing**, not simultaneous editing. If two collaborators edit the same node's settings at once, last-save-wins applies. ### Requirements * The feature is **agentic editor only** — the guided editor does not surface presence. * Collaborators must be authenticated members of the organization that owns the workflow. * Read-only viewers count — people who can open the workflow appear on the canvas even if they cannot edit it. ## What's next Open the Add Node panel and pick from Nodes, Triggers, and Interface tabs. The full catalog of executable and control-flow nodes you can place. Annotate the canvas and customize its background. Kick off a run from the canvas or chat, with inputs, batch mode, or a trigger. # Coding Agent Chat Source: https://docs.pinkfish.ai/agentic-editor/chat Describe the workflow you want in plain English — the coding agent researches, writes, and wires nodes onto the canvas for you. The chat panel on the left of the Agentic Editor hosts your **coding agent** — an AI built specifically to design and modify workflows. Unlike Coworker, it understands the canvas: it can add and configure nodes, propose edges, inspect errors, and iterate on your design based on conversational feedback. Chat panel showing a user prompt asking for a weather-email workflow and the coding agent's response with a todo list tracking build steps. ## Key capabilities Describe what you want the workflow to do. The agent adds, connects, and configures nodes. Point the agent at specific nodes — right-click a node and add it to the chat context, or select it and ask. Attach files to a message for the agent to reason over. Ask the agent to reshape the graph — "run these in parallel", "add error handling", "replace this with a code block". It edits in place. Responses stream live. You see the agent's reasoning, tool calls, and edits as they happen. ## The input Type in the chat input, press `Enter` to send, `Shift+Enter` for a new line. Attachments and the prompt-context controls surface around the text field. ### Attachments Click the paperclip to attach a file directly to the message. Files appear as chips next to the input and travel with the prompt into the conversation. The agent can open and reason over most common formats — images, PDFs, CSVs, text, JSON, spreadsheets, docs. ### Examples button New to Agent Mode? Click the **Examples** button to open a library of starter prompts — "scrape a page and email me a summary", "watch a Gmail label and post to Slack", and so on. Select one to prefill the input and tweak before sending. ## The conversation ### Message types The agent uses multiple message formats depending on what it's doing: * **Assistant messages** — markdown with code fences, headings, and lists. Rendered inline in the chat. * **Intro message** — the welcome message on a fresh workflow with suggested next steps. * **Step / automation summary** — after the agent finishes a chunk of work, it posts a summary of what changed on the canvas. * **Skill reference blocks** — a clickable card when a skill is invoked. * **Todo list** — a running checklist the agent maintains for multi-step tasks, with items marked done as it completes them. * **Browser session** — a mini-viewer showing the agent's live browser actions when browser automation is in play. * **Inactive connection reference** — a warning badge when a connection used in the workflow is no longer valid. ### Prompt context Above the input, small context chips accumulate as you use the chat or select nodes on the canvas. These are things the next message will include by default — referenced nodes, added files, skill callouts. Click the **×** on a chip to remove it before sending. When you right-click a node on the canvas and choose **Add node to the chat context**, the node appears here as a chip — great for "explain what this node does" or "replace this with X". ### Sending nodes to chat Two ways to include a canvas node in your next message: 1. **Right-click the node** → **Add node to the chat context** — adds it as a chip. 2. **Select the node** and type your question — the selection travels with your prompt automatically. ## Collapsing the chat To give the canvas more room, click the collapse arrow at the top of the chat panel. The panel shrinks to a narrow strip with an open-chat button. Click it to restore the chat to its previous width. ## Tips for effective prompts Rather than "process the data", say "take a CSV of leads, score each with Clearbit, and write the top 10 to a Google Sheet". The agent picks better nodes when it knows the contract. If you want Slack, say Slack. The agent will use Pinkfish's MCP server catalog — naming the app shortens the reasoning loop. "Add a retry with 3 attempts" or "route errors to Slack" gets you a more robust workflow than default generation. Build the happy path first, then ask the agent to layer on branches, approvals, and edge cases. ## Coding agent vs. Coworker Both are AI chats inside Pinkfish, but they're different products: | | Coding Agent (here) | [Coworker](/coworker/overview) | | - | - | - | | Primary job | Build and edit workflows | Answer questions, run tasks | | Operates on | The canvas you're looking at | Your whole workspace | | Lives in | The Agentic Editor | The main sidebar | | Best for | "Add a node that…", "connect X to Y" | "Summarize my inbox", "run the quarterly report" | ## What's next Once the agent adds nodes, rearrange and connect them visually. Test what the agent built — with inputs, mock mode, or a live trigger. # Editor Tabs Source: https://docs.pinkfish.ai/agentic-editor/editor-tabs The right pane in Agent Mode hosts five tabs — Workflow, Result, Interface, Code, and Log — that you can pin, reorder, and switch between. The right pane of the Agentic Editor is a tabbed workspace. The **Workflow** tab (the canvas itself) is always there; four more tabs — **Result**, **Interface**, **Code**, and **Log** — can be pinned, reordered, or tucked away. The tab bar at the top of the right pane showing Workflow, Result, Interface, the pin menu, and Split toggle. ## The five tabs The node canvas — always pinned. Your primary working surface. The output of the currently selected node — JSON, table, markdown, HTML, and more. The [interface builder](/agentic-editor/interface) for your user-facing form and results view. The read-only source of the workflow, with a version selector to browse history. Live execution logs streamed during a run. ### Workflow (permanent) The canvas where you arrange and connect nodes. See [Canvas](/agentic-editor/canvas) for the full mechanics. This tab cannot be unpinned or closed — it's the heart of the editor. ### Result Shows the **currently selected node's most recent output**. Click a node on the canvas, open the Result tab, and you see exactly what that node produced on the last run. The Result tab includes a view-mode switcher so you can render the same data different ways: * **JSON** — collapsible tree, default for structured objects. * **Table** — for arrays of objects, one row per item. * **Markdown** — rendered prose for LLM outputs. * **HTML** — rendered web content, e.g. the output of a code block that returns HTML. * **Plain text** — raw, unformatted. Result tab showing a Run Summary list of completed nodes on the left and a populated JSON output on the right with id, name, and email fields. You can also **pin a result** with the pin button on the Result tab itself. This keeps the result visible even when you click away to other nodes — useful for comparing outputs across runs. See [Mock mode & pinning](/agentic-editor/mock-mode-and-pinning) for the full pinning story. ### Interface The [interface builder](/agentic-editor/interface) for configuring your workflow's user-facing form, confirmation screen, and results page. ### Code A read-only view of the underlying source code of your workflow — typically a JavaScript/TypeScript module the runtime executes. Useful for: * Understanding what the coding agent actually wrote. * Copy-pasting into external AI tools for debugging. * Sanity-checking that the generated code matches your mental model. A **version selector** at the top of the Code tab lets you browse previous versions — compare the current draft against a past release without leaving the editor. Code tab showing the generated TypeScript source of the workflow in a Monaco editor, with the Run Summary list on the left. ### Log The real-time execution log for whatever the workflow is doing — stdout from Code Block nodes, MCP tool call results, runtime warnings, and any errors. Logs stream live during a run and remain viewable afterwards. Entries are timestamped and prefixed by log level (`info`, `warn`, `error`). Click an error to jump to the node that produced it on the Workflow tab. ## Pinning and unpinning tabs By default, pinned tabs vary depending on what you've been doing. To pin or unpin a tab: 1. Click the **+** button to the right of the tab bar. 2. Pick a tab from the popover to pin it. 3. Click a tab that's already pinned in the popover to unpin. Unpinned tabs still exist — you just access them via the **+** menu rather than the top bar. The **Workflow** tab is always pinned and can't be toggled. Pin menu popover open from the + button on the tab bar, showing the pinnable tabs. ## Reordering tabs Drag any tab left or right to reorder. The order is saved per-workflow. ## Switching tabs quickly * Click a tab to jump to it. * Use keyboard shortcuts (browser-dependent — typically `Cmd/Ctrl+Opt+ArrowKey`). * From the [Add Node](/agentic-editor/adding-nodes) flow on the Interface tab, clicking the card automatically jumps you to the Interface tab. ## Tab behavior during runs While a workflow is running: * **Workflow** tab shows live node status (running / success / error). * **Log** tab fills with streaming entries. * **Result** tab updates as each selected node completes. * **Code** and **Interface** tabs are unchanged — they're authoring views, not execution views. ## What's next Show two tabs side-by-side for faster iteration. The Interface tab's authoring experience in depth. See how the Log and Result tabs behave during an execution. Result pinning explained. # Interface Builder Source: https://docs.pinkfish.ai/agentic-editor/interface Give your workflow a user-facing form — inputs, confirmation, and results — without writing a line of frontend code. An **interface** turns your workflow into a tiny web app: a form users fill out, a confirmation screen while the workflow runs, and a results page that shows the output when it's done. Each workflow can have **at most one** interface node — the editor enforces this. The interface is authored inside the **Interface tab** of the right pane. You see a live preview of exactly what users will see. Interface tab open in the right pane on a new workflow, prompting 'First add a node to the workflow to enable adding an Interface.' Before adding an Interface, your workflow needs at least one executable node. A brand-new workflow with only the Manual trigger shows the "First add a node" prompt above — add an MCP tool or Code Block first, then the Interface tab becomes editable. ## Adding an interface 1. Open the **Add Node** panel (top-right of the editor). 2. Switch to the **Interface** tab. 3. Click the **Add Interface** card. An **Interface** node appears on the canvas, wired as a trigger. The **Interface** tab in the right pane becomes active so you can start building the form. You can only set up one interface. Delete the interface node to create a new one. ## The three views An interface is a mini funnel with three pages. The control bar at the top of the Interface tab lets you switch between them while authoring: What the user fills out to start the workflow. Shown after submit while the workflow runs (or forever, for fire-and-forget). Renders the workflow's designated output when the run completes. ### Form view The form is where users provide input. Fields you add here become the trigger's input schema, so downstream nodes can reference `{{trigger.}}` anywhere. Field types include: * **Text** (single and multi-line) * **Number** / **Integer** * **Email** / **URL** * **Boolean** (checkbox or toggle) * **Date** / **Datetime** * **Select** (single) and **Multi-select** from an enum * **File upload** * **Object** and **Array** for nested structures Each field supports labels, help text, placeholders, required flags, and validation (min/max, regex patterns, file-type restrictions). #### Starting from a template Click **Choose a template** to see a library of common form shapes — lead capture, feedback survey, bug report, document intake. Pick one as a starting point and edit from there. ### Confirmation view After submit, the user lands on a confirmation/thank-you page while the workflow runs in the background. Customize the heading, body text, and optional "next steps" or call-to-action buttons. Useful for long-running workflows where you don't want to block the user. ### Results view The results view renders the workflow's **designated output** — a specific node whose output becomes what users see. **Designated output picker:** Below the Interface tab is a control that asks *"Which node's output do users see?"* Pick one of your workflow nodes — typically the last one, but it can be any node with a meaningful output. Results can render as: * **Plain text / Markdown** — for simple text answers. * **JSON** — for structured data, collapsible tree view. * **Table** — for arrays of objects. * **HTML** — for custom-rendered output from a code block. * **Download link** — for files produced by the workflow. ## What users experience When you release the workflow and make it [publicly accessible](/agentic-editor/releases#public-templates), users get a URL that serves the interface: 1. They land on the **Form** page. 2. They fill in the fields and submit. 3. They see the **Confirmation** page while the workflow runs. 4. When complete, they see the **Results** page rendering the designated output. The interface also works internally — any Pinkfish user with access to the workflow can run it via its interface URL without editor permissions. ## Editing the interface node Clicking the **Interface node** on the canvas selects it and brings the Interface tab to the foreground. You can't edit fields from the canvas itself — all authoring happens in the tab — but the node visualizes the connection between the interface trigger and the rest of your workflow. ## Removing an interface Select the Interface node and press `Backspace` or use the right-click **Delete**. The node disappears along with its configuration, freeing you to add a new interface with different fields or a different designated output. ## What's next The Interface tab is one of five tabs in the right pane — meet the others. Other ways to start a workflow if a form isn't the right fit. Publish the interface as a public-facing URL. Test the interface end-to-end. # Mock Mode & Node Pinning Source: https://docs.pinkfish.ai/agentic-editor/mock-mode-and-pinning Iterate on workflows without burning real tool calls, and freeze specific outputs so re-runs reuse cached results. Two features help you iterate on workflows quickly and safely: * **Mock Mode** — a per-node toggle that makes a node return synthetic data instead of hitting the real world. * **Node Pinning** — freezes a node's output so subsequent runs skip it and reuse the cached value. They look similar at a glance but solve different problems, and the editor shows them in separate canvas toolbar indicators. Both are essential for productive development inside Agent Mode. ## Mock Mode ### What it does When a node is in mock mode, running the workflow never actually calls its tool. Instead, the runtime returns synthetic data that matches the node's expected output schema. This is perfect for: * Building the graph without spamming a downstream Slack channel. * Iterating on a Code Block that consumes an expensive API response. * Drafting a new workflow where some upstream tools aren't configured yet. ### Turning it on Two ways to toggle mock mode for a specific node: 1. **In the node settings panel**, toggle **Mock mode**. 2. **Right-click the node** → **Toggle Mock Mode** from the context menu. Mocked nodes display a small flask indicator on the node itself, so you can tell at a glance which nodes are synthetic. ### The Mock Mode indicator On the canvas toolbar (top-left), a flask icon with a numeric badge shows how many nodes are currently in mock mode. Click it to open a popover listing each mocked node — click a node to jump to it on the canvas, or click **Clear all** to return every node to live mode at once. ### Release-gate rule A workflow cannot be released until it has at least one successful **live** run — a run where **no nodes** were in mock mode. This prevents a mocked workflow from going to production by accident. See [Releases](/agentic-editor/releases). If you try to release a workflow that's only ever run in mock mode, the **Release** button is disabled with a tooltip explaining why. Unmock every node and trigger at least one live run to unblock the release. ### Customizing mock output By default, mock output matches the node's declared output schema with sample values. You can override with custom JSON by expanding the **Mock response** section in the node's settings panel. ## Node Pinning ### What it does Pinning freezes the current output of a node. On the next run, the workflow skips the pinned node entirely and reuses its last output. Use pinning for: * **Caching expensive upstream calls** — pin a node whose output you know is correct, then iterate on downstream nodes without re-hitting the expensive call. * **Reproducing a bug** — pin all upstream nodes to their current outputs and tweak the failing node in isolation. * **Speeding up debug loops** — a 5-minute workflow becomes 5 seconds when all upstream nodes are pinned. ### Turning it on Run the workflow at least once (so there's an output to freeze), then: 1. **Right-click the node** → **Pin output**, or 2. Click the **pin** button in the node's hover menu or settings panel. Pinned nodes display a pin indicator and don't re-execute on subsequent runs — they just forward their cached output to downstream nodes. ### How a pinned node looks in a run When a run replays a pinned node, its status badge shows a **blue pin** instead of the usual green check — both live while the run streams and afterward in the run's Monitor view, including after a page refresh. Hovering the badge shows "Replayed from pinned data." Nodes that actually executed keep the green check, so you can tell replayed results from fresh ones at a glance. The run log's per-node view notes the replay the same way. ### The Pinned Nodes indicator The canvas toolbar also shows a pin icon with a count of currently pinned nodes. Its popover lists pinned nodes and offers **Unpin** per item plus a **Clear all** button. ### When pins invalidate Pinned outputs are tied to the node's configuration. If you change a pinned node's settings (arguments, connection, code, etc.), the pin is automatically cleared — the cached output no longer matches what the node would produce. You'll see a warning toast when this happens. Pins also clear when the workflow is released — released workflows always run fresh. ### Result pin (different thing) Inside the **Result tab** there's also a pin button. That pin keeps a specific node's output visible in the Result tab even when you click away to other nodes — it doesn't affect execution. It's a UI convenience, not a caching mechanism. ## Mock vs. Pin at a glance | | Mock Mode | Node Pinning | | - | - | - | | Effect on execution | Skips the tool call, returns synthetic data | Skips the node entirely, reuses cached output | | Requires a prior run? | No | Yes | | Cleared when settings change? | No (explicit toggle) | Yes (auto-invalidated) | | Canvas indicator | Flask icon | Pin icon | | Blocks release? | Yes, must have a live run | No | | Best for | Building before the real tool is configured | Speeding up iteration on downstream nodes | ## What's next The execution flow that mock and pin interact with. The live-run gate explained in depth. Which nodes support mock mode and pinning. # Monitor Tab Source: https://docs.pinkfish.ai/agentic-editor/monitor Inspect every past run of an Agent Mode workflow — execution timing, node-level inputs and outputs, streaming logs, and agent reasoning traces. The **Monitor tab** is where you audit and debug runs after the fact. It's the second of the two view modes in the Agentic Editor (alongside **Editor**), and switching into it replaces the chat panel with a list of runs and the right pane with a read-only execution view. ## Switching to Monitor At the top of the editor, use the **Editor / Monitor** toggle. Flipping to **Monitor**: * Replaces the chat panel with a **Runs Panel** (list of past executions). * Swaps the Workflow tab for a read-only **Monitor canvas** with execution-state overlays. * Opens a **Node side-panel** on demand with inputs/outputs/logs/timing for any node you click. The Workflow canvas here is a **viewer**, not an editor — you can't drag nodes or change wiring while in Monitor mode. Flip back to **Editor** to make changes. ## The runs list The left panel shows every run of this workflow, most-recent first. Each row displays: * **Status** — success (green), error (red), running (pulsing yellow), paused (purple), cancelled (gray). A **paused** run is suspended at a durable wait — a delay, a timer, or an approval — and resumes on its own. * **Trigger** — what kicked it off (Manual, API, Schedule, Email, App, Event). * **Timestamp** — relative ("3 minutes ago") and absolute on hover. * **Duration** — total elapsed wall-clock time. ### Filtering Controls at the top of the runs list let you narrow down: * **Date range** — restrict to runs from a specific time window. * **Status** — show only successes, only errors, etc. * **Trigger type** — restrict to runs from a specific kind of trigger. ### Exporting Click the **Download CSV** button to export the currently-filtered run list as a CSV file. Useful for post-mortem analysis in external tools or reporting. ## The Monitor canvas Selecting a run loads its execution state onto the main canvas. Every node is colored and badged to reflect what happened to it during that specific run: * **Gray** — not executed (typically because it was on a skipped branch). * **Yellow pulse** — running (for an in-progress run). * **Green check** — completed successfully. * **Red X** — failed. * **Dimmed slash** — skipped explicitly. ## Node side-panel Click any node on the Monitor canvas to open the **Node side-panel** with four sub-tabs: The exact arguments the node received, rendered as JSON. The node's return value. The same view modes as the Result tab (JSON, table, markdown, HTML). Streaming output from this specific node — stdout, tool-call traces, errors. Duration, started-at, ended-at, and any retries. ## Agent Debugger Panel For runs that involve an Agent node or any LLM-driven step, the **Agent Debugger Panel** exposes a detailed trace of the agent's reasoning: * **Messages** — the full conversation history the agent saw. * **Tool calls** — every tool the agent invoked, with arguments and results. * **Thoughts / reasoning** — the agent's internal monologue, where exposed by the model. This view is essential when an agent-driven workflow produces an unexpected result — you can see exactly why the agent made the decisions it did. ## Bottom detail panel Below the main panel, the **Monitor Bottom Panel** aggregates additional detail about the selected run — metadata, batch-run siblings (if this is part of a batch), triggering event payload, and any run-level artifacts. ## Streaming live runs Runs that are currently in progress stream their state into the Monitor view in real-time: * Node statuses update as each node completes. * Log entries append live. * The **Streaming** badge in the run list row indicates a live run. You can kick off a run from the Editor, switch to Monitor, and watch the execution progress without refreshing. ## Run artifacts If the workflow produced files (a generated report, a scraped dataset, a rendered image), they surface as **run state files** — downloadable artifacts attached to the run. Access them from the run's detail view. ## Related: global Monitor The Monitor tab documented here is **per-workflow**. Pinkfish also has a **global Monitor** — a dashboard of runs across every workflow in your org. See [Monitor](/orchestration/monitor) for the org-wide view. The [Agent Monitor](/orchestration/agent-monitor) and [Guardian Agent](/orchestration/guardian-agent) offer AI-driven observability on top. ## What's next The execution flow whose runs end up in Monitor. The Editor counterpart to the Monitor canvas. Org-wide run observability. AI-driven analysis of runs and failures. # Node Types Source: https://docs.pinkfish.ai/agentic-editor/node-types The complete catalog of nodes you can place on a Agent Mode canvas — executable, control-flow, and special nodes. Every workflow is built out of nodes. This reference walks through every node type the editor exposes, what it does, where its settings live, and how it wires up. For the UI of **adding** a node, see [Adding Nodes](/agentic-editor/adding-nodes). For the **canvas mechanics**, see [Canvas](/agentic-editor/canvas). ## Executable nodes These nodes actually run — they call tools, execute code, or delegate to other agents. ### MCP Tool Call The workhorse of Agent Mode. An MCP tool node invokes a single tool exposed by one of Pinkfish's MCP servers — anything from `slack.sendMessage` to `gmail.search` to `anthropic.createMessage`. The catalog is large and growing; see [Embedded MCP Servers](/api-reference/mcp-servers/embedded/overview) and [Application MCP Servers](/api-reference/mcp-servers/application/overview) for the full list. **Settings:** * **Connection** — for third-party apps, pick which of your connections to authenticate with. * **Arguments** — a dynamic form generated from the tool's JSON schema. Fields accept literal values, `{{mentions}}` of previous-node outputs, or a mix. * **Retries** — toggle automatic retries with a dead-letter path. * **Mock mode** — return synthetic data without calling the real tool. See [Mock mode & pinning](/agentic-editor/mock-mode-and-pinning). ### Code Block Add custom JavaScript code to your workflow. The node embeds a Monaco editor for the code body; inputs flow in as named variables based on the incoming edges, and whatever your code `return`s becomes the node's output. **Settings:** * **Code editor** — Monaco with JavaScript syntax highlighting. * **Input schema** — optional typed inputs that get injected as variables. * **Output schema** — declare the shape of your return value so downstream nodes can reference fields. Code Block node settings panel with Name, Prompt, Summary, and a Retry on Error toggle — the hover menu above the node showing edit, play, mock, and pin icons. ### Agent Call another Pinkfish agent from inside your workflow. Useful for delegating a specialized task — "ask the Research Agent to summarize this URL and come back with the answer" — without duplicating its instructions and tools. **Settings:** * **Agent** — picker of agents you have access to. * **Release** — pin to a specific release of the agent, or track the latest. * **Prompt** — the message to send, typically with mentions of upstream outputs. ### Workflow (Sub-workflow) Call another workflow as a function. Inputs mapped in; outputs come back. Composes complex pipelines out of reusable pieces. **Settings:** * **Workflow** — picker of workflows you have access to. * **Release** — specific release, or draft. * **Inputs** — one field per input declared by the sub-workflow's trigger. ### Custom Integration A special kind of tool-call node for Pink-Connect integrations built in your workspace. Behaves like an MCP tool but points at your custom service. See [API Connections](/tools/connections) for how to author one. ### Legacy You may encounter **Legacy** nodes in older workflows migrated from Guided Mode. They're read-only shims that preserve behavior but aren't authorable from the palette anymore. Ask the coding agent to replace them with modern equivalents. ## Control-flow nodes Flow-control nodes don't call tools — they shape execution. Add them from the **Flow Control** entry on the Nodes tab. ### If-Else > Branch execution based on a condition. True path continues, false path can skip, stop, or goto another node. The core boolean branch. Configure: * **Condition** — an expression built in the mention-based editor (`{{trigger.email.subject}} contains "invoice"`). * **On true** — the node on the `true` branch continues. * **On false** — skip downstream, stop the run, or goto another node. ### Router > Route execution to different targets based on evaluating an expression. Like If-Else with many branches. Define N routes, each with its own condition and destination. Conditions can be exact-match or regex (prefix with `regex_`). ### Merge > Fan-in node that waits for one or more inputs before continuing. Use Merge to bring multiple parallel branches back into a single path. Configure how many incoming edges must fire — all, any, or a specific count — before downstream nodes run. ### For Each > Iterate over an array and execute body nodes for each item. Pick an array from an upstream output; the nested "body" nodes run once per item. Outputs are collected into an array in the order items completed. ### Delay > Pause workflow execution for a specified duration in milliseconds. A simple wait. Configure the duration. Typically used for polling loops or rate-limit backoff. ### Loop > Execute body nodes a fixed number of times. Runs the body N times unconditionally. Each iteration sees the loop index; outputs accumulate. ### While > Execute body nodes while a condition is true. Runs the body repeatedly until the condition evaluates false. Be careful with termination — the editor enforces a max-iteration safeguard to prevent infinite loops. ### Parallel > Execute multiple branches concurrently, wait for all. Fan out into multiple independent branches that all run at the same time. Downstream execution waits until every branch finishes. Useful for independent API calls that don't depend on each other. ### Approval (Human-in-the-Loop) > Pause workflow for human approval. Sends notification, waits for approve or deny. Blocks the run until a human responds. Configure: * **Preamble** — the message shown to the approver (up to 5,000 characters). * **Expiration** — how long to wait before auto-denying (minimum 1 minute). * **Notification channel** — Slack, Teams, email, or in-app. See [Human in the Loop](/orchestration/human-in-the-loop) for the full approval experience, including how approvers interact with it. Flow Control category open in the Add Node panel showing If-Else, Router, Merge, For Each, Delay, Loop, While, Parallel, and Approval. ## Special nodes These don't execute, but they live on the canvas. ### Trigger Every workflow starts with at least one trigger node — the Manual trigger is always present, and you can add others (API, schedule, email, app triggers). See [Triggers](/agentic-editor/triggers). ### Interface A special node that represents your workflow's user-facing form and result page. There can be only one. See [Interface builder](/agentic-editor/interface). ### Sticky Note Non-executable annotations for documenting the canvas. Colored rectangles with free-form text. See [Sticky notes & canvas](/agentic-editor/sticky-notes-and-canvas). ## Node settings panel Clicking any node (other than Trigger, Interface, and Sticky Note, which have their own experiences) opens a settings side-panel on the right. The panel has: * A **header** with the node name (editable) and close button. * A **Settings** tab with the node's configuration form. * A **Retries** toggle (on applicable nodes). * A **Mock** toggle (on applicable nodes — see [Mock mode](/agentic-editor/mock-mode-and-pinning)). * A **Delete** action at the bottom. Close the panel by clicking outside it, clicking the ✕, or pressing `Esc`. ## What's next The palette UI for dropping these onto the canvas. Every way a workflow can start. The user-facing form and results view. Execute what you've built. # Agent Mode Source: https://docs.pinkfish.ai/agentic-editor/overview Design, test, and ship workflows on an infinite canvas — with an AI coding agent that builds alongside you and live execution visible at every step. **Agent Mode** is Pinkfish's node-based workflow editor. Describe what you want in natural language and the coding agent builds it, or drop nodes onto the canvas yourself. Either way, you get a visual representation of every trigger, tool call, branch, and loop — plus real-time execution feedback, per-node outputs, version history, and a monitor for every past run. Agent Mode is the successor to [Guided Mode](/guided-editor/overview). Guided Mode walks you through a step-by-step workflow form; Agent Mode hands you an infinite canvas and an AI collaborator. Use Agent Mode for anything beyond the simplest single-step automation — it's strictly more expressive. Agent Mode editor showing a four-node weather-email workflow the coding agent built from a natural-language prompt — Start → Get SF Weather → Format Email Body → Send Weather Email. ## The three panels Every workflow in Agent Mode has the same layout: The coding agent that builds, edits, and explains your workflow on demand. The infinite node-graph where your workflow lives. Drag, connect, inspect. Workflow, Result, Interface, Code, and Log — pin and rearrange the tabs you care about. The right pane can be [split](/agentic-editor/split-view) to show two tabs side-by-side — great for keeping the canvas and the output in view while you iterate. ## Editor vs. Monitor Agent Mode has two view modes, switched from the top of the editor: * **Editor** — the authoring experience described above. * **Monitor** — the run-history view. Replaces the chat panel with a list of past runs and the canvas with a read-only execution view. See [Monitor tab](/agentic-editor/monitor). You'll spend most of your time in Editor while building, and flip to Monitor to audit, debug, or watch live runs. ## Build a workflow in 30 seconds From the Workflows library, click **New Agentic Workflow**. An empty canvas opens with a single Manual trigger and the coding agent chat ready on the left. Type a prompt like *"When a Gmail email arrives with 'invoice' in the subject, extract the amount and add a row to my Google Sheet"*. Press Enter. The agent adds a Gmail trigger, a parsing node, and a Google Sheets node, wired together. It explains what it did in the chat. Click **Run Workflow** in the tab bar. The canvas lights up with live node status. Check the Result tab for the final output. Once a run succeeds in live mode, click **Release** to promote the draft into a versioned snapshot that the live Gmail trigger now uses. ## The full feature set ### Canvas & nodes Pan, zoom, connect, undo — the mechanics of the infinite workspace. The palette browser with Nodes, Triggers, and Interface tabs. Every executable, control-flow, and special node you can place. Manual, API, schedule, email, app triggers, and events. Give your workflow a user-facing form and results page. Annotate and personalize the canvas. ### Working with the right pane Workflow, Result, Interface, Code, and Log. Show two tabs side-by-side for faster debugging. ### Running, iterating, shipping Manual runs, input dialogs, batch runs, auto-heal. Iterate without burning real tool calls or re-running expensive steps. Promote drafts to live, compare versions, restore history, publish as a template. Inspect every past run — inputs, outputs, logs, agent reasoning. ### Workflow administration Share, duplicate, tag, describe, and configure resources. The AI-powered authoring surface. ## Real-time collaboration Multiple editors can be in the same workflow simultaneously. You'll see other users' avatars in the header and their live cursors on the canvas as they work. Edits sync in real-time — no "someone else is editing" errors, no merge conflicts. See [Canvas — Collaborating on the canvas](/agentic-editor/canvas#collaborating-on-the-canvas) for what's shared in real time (cursors, node dragging, presence) versus what stays local (selections, edits, zoom). ## Agent Mode vs. Guided Mode | | Agent Mode | [Guided Mode](/guided-editor/overview) | | - | - | - | | Editor | Infinite node canvas | Sequential step form | | Authoring | Natural-language chat + visual | Fill-in-the-blank | | Control flow | Full (if/else, loops, parallel, approvals) | Linear steps | | Sub-workflows | Yes | No | | Best for | Anything beyond a single-step automation | Very simple linear flows | | Expressiveness | Strictly more expressive | Simpler to scan at a glance | Most new workflows should use Agent Mode. Guided Mode remains supported for existing workflows and for the simplest use cases. ## Where to start Open the chat and describe what you want. The visual mechanics: dragging, connecting, zooming. The full catalog of what you can place. Executions, mock mode, monitor. # Releases & Version History Source: https://docs.pinkfish.ai/agentic-editor/releases Promote a draft workflow to a versioned release, compare changes, restore previous versions, and publish as a public template. A **release** is a versioned snapshot of your workflow. Until you release, your workflow exists only as a **draft** that you're iterating on — live API triggers, scheduled runs, and public interfaces all point at whichever version you most recently released. The **Release** dropdown in the tab bar is your hub for promoting drafts, inspecting what changed, restoring old versions, and publishing templates. ## Draft vs. released Every Agent Mode workflow has two states: * **Draft** — the live editor state you're working on. Every edit is auto-saved. Draft API trigger URLs exist so you can test without affecting production. * **Released versions** — numbered snapshots (0, 1, 2, ...). Live trigger URLs, scheduled runs, and public interface URLs always point at the most recent release. Until you release once, the workflow has no "live" URLs at all — only the draft. After the first release, both exist independently. ## The release gate You cannot release a workflow until it has at least one successful run in **live** mode — that is, a run where no nodes were in [mock mode](/agentic-editor/mock-mode-and-pinning). The Release button is disabled until this condition is met. The rule protects against a mocked-only workflow being promoted to production by accident. If the Release button is disabled, hover for a tooltip explaining what's missing. Typically the fix is: 1. Toggle off any nodes still in mock mode (use the Mock Mode indicator's **Clear all**). 2. Click **Run Workflow** to fire a live run. 3. Wait for success. 4. Retry the release. ## Creating a release 1. Click the **Release** dropdown on the tab bar. 2. Pick **Release this draft** (or the highlighted primary action). 3. Optionally add release notes describing what changed. 4. Confirm. Pinkfish snapshots the workflow, bumps the version number, and points all live URLs at the new release. Release dropdown open with the Publish a Release panel and a Publish CTA. ### Test data warning If the system detects that your recent runs used test-like inputs, you may see a **Test Data Warning Dialog** before the release completes. It's a reminder to sanity-check against realistic data. Dismiss and proceed, or cancel and run with real inputs first. ## Comparing releases Before (or after) releasing, click **View diff** or **Compare** in the Release dropdown to open the **Release Diff Modal**. It shows exactly what changed between your draft and the last release: * Added / removed / modified nodes. * Changed connections. * Changed node configurations. Useful for double-checking what you're about to push live, and for writing better release notes. ## Restoring a previous version Made a change you want to undo? The **Restore Version** dropdown (accessible from the canvas toolbar or the Release area) lists every past release with timestamp and version number. 1. Open the dropdown. 2. Pick a past release. 3. Preview what restoring would change in the **Restore Preview**. 4. Click **Restore** to revert the draft to that version's contents. Your current draft is preserved in the restore process — you're not destroying progress, you're setting the draft to match an older snapshot so you can continue from there. Restore Version dropdown open with V2 (current) marked and a V1 entry with a Restore button, each labeled with a timestamp. While viewing an older release in preview mode, a **Version Preview Badge** appears on the canvas indicating you're looking at historical state, not the current draft. ## Publishing as a public template **Availability** (August 2026): the **Make Available as Public Template** toggle is shown only on select deployments; most users no longer see it. Templates that are already public stay public, and their URLs keep working. You can promote a released workflow into a **public template** that anyone on the internet can use via a public URL. This is useful for: * Sharing a workflow with customers for lead capture or onboarding. * Publishing reusable automations to your org's library. * Marketing use cases — "fill this form, get an AI-generated report". To publish: 1. Open the **Release** dropdown. 2. Toggle **Make Available as Public Template**. 3. The **Publish Template Dialog** opens to collect the template's metadata — name, description, icon, category. 4. Save. Pinkfish generates a public URL. Copy the public URL with the **Copy** button next to it. Anyone with the URL hits your workflow's [interface](/agentic-editor/interface) (if you defined one) or the API endpoint. Release dropdown open showing the Release History entry with the Make Available as Public Template toggle switched on, the generated public URL, and a Copy button. Public templates require an Interface or an API trigger — the public URL only makes sense if there's a way for external users to invoke the workflow. See [Templates](/workflows/templates) for template discovery. ### Unpublishing Toggle **Make Available as Public Template** off to remove the public URL immediately. Existing released versions remain; only the public entry point is removed. ## Promoting across environments If your Pinkfish workspace has multiple environments (dev, staging, prod), the **Promote** section of the Release dropdown lets you push a release from one environment to another without re-running the full setup. See [Publishing](/agents/releases) for environment promotion details. ## Release history Every release is preserved. You can: * Restore any past release as the new draft. * View the diff between any two past releases. * See which release is currently live (marked in the dropdown). Releases are never deleted — they're your audit trail for what production was running at any point in time. ## What's next Trigger the live run that unlocks the release gate. Why mocked runs don't count toward the release gate. Define the interface before going public. How public templates surface in Pinkfish. # Running a Workflow Source: https://docs.pinkfish.ai/agentic-editor/running Execute your workflow from the editor — with inputs, stop control, batch variations, and auto-heal on failure. Once you have nodes on the canvas, you'll want to run them. Agent Mode gives you several ways to kick off an execution — the Run button, a trigger invocation, a simulated API call, or a batch of variations — each with live feedback on the canvas and in the Log tab. Workflow after a successful run showing green checkmark badges on both the Start trigger and the Get Current Timestamp code-block node, with the agent confirming success in the chat. ## The Run Workflow button The green **Run Workflow** button sits in the tab bar at the top-right of the editor. Clicking it: 1. Resolves which trigger to use (the selected trigger node, or the Manual trigger by default). 2. If the trigger has an input schema, opens an **Input Dialog** to collect values. 3. Fires the workflow and streams status back to the canvas and Log tab. While the workflow runs, the button transforms into a **Stop** button (square icon). Click it to cancel the run — in-flight tool calls finish, but no further nodes execute. ## The Input Dialog When the selected trigger has fields (an input schema), clicking **Run Workflow** opens a dialog pre-populated with their types. Fill in your test values and click **Run** to fire. You can reopen the dialog without re-running via the **Show Inputs** button that appears next to Run on the canvas when inputs are present — handy for editing values and re-running with tweaks. ## Calling an API trigger For API triggers, open the **Call API Trigger** modal (accessible from the trigger's context menu or via the run control). It generates a ready-to-send `curl` command with: * The trigger's draft or live URL. * The correct auth header. * A pretty-printed JSON body editor. You can execute the curl in a terminal, or click **Send** inside the modal to fire it from the editor directly. ## Running from the canvas Right-click a node and choose: * **Run entire workflow** (on a trigger) — fires the full workflow from that trigger. * **Run until this node** (on a non-trigger) — runs the workflow from its trigger up to and including the right-clicked node, then stops. Invaluable for iterating on a specific step. ## Triggered runs When an external event (an API call, an email, a schedule, an app trigger) fires the workflow while the editor is open, Pinkfish shows a **Triggered Run Notice** — a small toast/badge in the header. Click it to open the triggered run in the editor and watch its state live. The **Triggered Runs** button next to the Run button shows a popover of recent triggered executions, so you can jump to any of them without switching to the full [Monitor](/agentic-editor/monitor) view. ## Live execution feedback As the workflow runs, you'll see feedback in multiple places: * **Canvas** — each node lights up with its status: pending → running → success/error/skipped. See [Canvas: Node status indicators](/agentic-editor/canvas#node-status-indicators). * **Log tab** — streaming log entries from every node (tool calls, code block stdout, errors). * **Result tab** — the selected node's output updates as soon as that node completes. * **Runtime error banner** — if the workflow fails, a banner appears at the top of the canvas linking to the failing node. ## Batch runs Need to run the workflow with a bunch of different inputs at once? Open the **Batch Options** modal from the chat input's batch icon. Configure: * **Parameter set** — a CSV-like table of inputs, one row per run. * **Concurrency** — how many runs execute in parallel. * **Fail-fast** — stop the batch as soon as one run fails (vs. continue). Click **Run** to kick off the batch. Each row becomes a separate run in the Monitor tab, all tagged with a shared batch ID so you can review them together. ## Mock vs. live execution By default, every node hits the real world — real API calls, real files written, real emails sent. For safer iteration, toggle specific nodes into **Mock mode** to return synthetic data instead. See [Mock mode & pinning](/agentic-editor/mock-mode-and-pinning) for the full feature, including the release-gate caveat. ## Auto-heal When a node fails, the coding agent can often propose a fix automatically. Pinkfish surfaces an **Auto-heal** suggestion on failed runs — click it and the agent revises the offending node's configuration or code and reruns from that point. Useful for flaky tool calls, schema mismatches, and similar self-correctable errors. ## Test data warning Before you [release](/agentic-editor/releases) the workflow, Pinkfish may prompt you with a **Test Data Warning Dialog** if it detects you've only run with test inputs. The warning is a gentle nudge to validate against realistic data before promoting to live. ## Browser sessions during runs If your workflow uses browser automation, you'll see a live browser view embedded in the Browser Session panel of the chat. The agent's clicks and typing stream in real-time so you can debug selector issues without re-running. See [Browser Logins](/tools/browser-login) for managing browser connections. ## What's next Iterate faster by mocking expensive nodes and pinning outputs. Review past runs, debug errors, and inspect execution traces. Promote a successful live run into a versioned release. Configure the triggers you're calling. # Split View Source: https://docs.pinkfish.ai/agentic-editor/split-view Show two editor tabs side-by-side to debug, compare, and iterate faster. Split View lets you display two of the right-pane tabs simultaneously — for example, the **Workflow** canvas on the left and the **Result** of the selected node on the right. It's especially useful for debugging, where you want to see a node's output without losing sight of the graph. Editor in Split mode with two side-by-side panels and a divider between them. ## Turning Split View on Click the **Split** button on the tab bar (the columns icon, labeled **Split**). The right pane divides in two — each half gets its own tab bar. The currently active tab stays on the left; the right side defaults to the first available tab. When Split is on, the button flips to **Single** (panel icon) — click it to collapse back into the standard single-pane view. ## Choosing which tab appears on each side Each half has its own tab bar at the top. Click any tab label within that bar to switch what's shown on that side. Every combination is valid — including putting **Workflow** on the right and **Log** on the left. ## Resizing the split Drag the vertical divider between the two panels to resize. The split defaults to 50/50 but saves whatever ratio you leave it at. ## Common use cases **Workflow** left, **Result** right — click nodes on the canvas and watch their outputs appear instantly. **Workflow** left, **Code** right — see what node maps to what function as you browse. **Code** left, **Log** right — jump from a log error to the line that produced it. **Workflow** left, **Interface** right — tweak which node is designated output and see the preview update. ## Keyboard behavior When both sides show a different tab, click inside whichever side you want to interact with — its controls (zoom, view mode, version selector) become active. Only one side has focus at a time. ## Monitor mode Split View is specific to the **Editor** view mode. When you switch to [Monitor mode](/agentic-editor/monitor), the right pane takes over entirely and Split is not available. ## What's next The five tabs that can appear on either side of the split. The Workflow tab in depth. # Sticky Notes & Canvas Customization Source: https://docs.pinkfish.ai/agentic-editor/sticky-notes-and-canvas Annotate the canvas with colored sticky notes and personalize the background style. Two small touches make the canvas more expressive: **sticky notes** for leaving context and rationale alongside your workflow, and a **canvas style selector** for personalizing the background. ## Sticky notes ### Adding a note 1. Click the **sticky note** button in the canvas toolbar. 2. A color picker opens — pick from **yellow**, **blue**, **green**, **pink**, or **purple**. 3. A sticky note appears at the center of the visible canvas. Click inside the note to enter edit mode and start typing. Click outside (or press `Esc`) to commit the text. Sticky note color picker open showing Yellow, Blue, Green, Pink, and Purple options. ### Editing a note Double-click any sticky note to edit its text. Notes support plain text — no markdown, no embedded images — just prose for quick annotations. ### Moving, resizing, deleting * **Move** — drag the note like any other canvas element. * **Resize** — drag any corner handle. * **Delete** — select the note and press `Backspace` or `Delete`. Notes are excluded from workflow execution and from the Code tab — they're purely visual overlays. Deleting or moving a note never affects how the workflow runs. ### When to use them Document the reasoning behind a non-obvious flow-control decision — "this retries 5x because the upstream API is flaky". Leave a note next to a complex section so future editors understand the intent. Use a bright color (yellow) to flag sections that need work before release. Place a large note *behind* a cluster of related nodes to visually group them. ### Note color conventions The five colors have no enforced meaning, but teams often adopt conventions: | Color | Common use | | - | - | | **Yellow** | TODOs, work-in-progress | | **Blue** | Informational context | | **Green** | Confirmed / tested sections | | **Pink** | Warnings, gotchas | | **Purple** | Architectural notes, handoffs | Pick whatever works for your team — just be consistent. ## Canvas style ### Switching backgrounds The canvas has a picker for changing its background style. Hover over (or click) the canvas-style toggle in the controls to reveal a popover of options: * **Dotted** — the default subtle dot grid. * Several **gradient** options — soft color blends that personalize the canvas without overpowering the nodes. Each option shows a tiny preview tile; the currently active one gets a checkmark. Click another to switch — the change is instant. ### Why change the style * **Personalization** — different canvas per project so you instantly recognize which workflow you're in. * **Contrast** — certain node colors read better against certain backgrounds. * **Focus** — a softer gradient can be easier on the eyes during long authoring sessions. The canvas style is saved with the workflow, so everyone viewing the workflow sees the same background. ## Dark mode Pinkfish follows your OS's dark/light preference automatically. Sticky-note colors and gradients have dark-mode variants that shift into darker, muted hues when dark mode is active. You don't configure this — it just works. ## What's next The core canvas mechanics that sticky notes and colors live on top of. Describe, tag, and share the workflow from the header. # Triggers Source: https://docs.pinkfish.ai/agentic-editor/triggers Every way an Agent Mode workflow can start — manual, API, schedule, email, and third-party app events. A **trigger** is the entry point of your workflow. Each workflow has at least one — the built-in Manual trigger — and you can add more to make the workflow react to events: an HTTP request, a cron schedule, an inbound email, or an event in a connected app like Slack or Gmail. ## Trigger types Run manually from the builder. Start via an HTTP endpoint. Run on a schedule. Start when an email is received. Start from an external app event (Slack, Gmail, GitHub, etc.). Start from a user-facing form. See [Interface](/agentic-editor/interface). ### Manual Trigger The simplest trigger — always present on every workflow and cannot be deleted. Fires when you click **Run Workflow** in the editor header or when you call the workflow programmatically without a specific trigger. Useful for authoring and testing. ### API Trigger Exposes the workflow as an HTTP endpoint. Each API trigger has two URLs: * **Draft URL** — hits the current draft of the workflow. Useful while iterating. * **Live URL** — hits the most recent [release](/agentic-editor/releases) of the workflow. Settings include: * **Authentication** — an auth header Pinkfish auto-provisions for the trigger. * **Input schema** — declare the expected request body shape so the coding agent (and downstream nodes) know what fields to expect. Pinkfish provides a helper to test an API trigger without leaving the editor — click **Call API trigger** in the run area to open a modal that generates a sample `curl` command with your auth token and a pretty-printed JSON body editor. For programmatic invocation details, see [Triggers API](/api-reference/introduction). #### Genesys Data Actions (Genesys deployments) On Pinkfish for Genesys Cloud (genesys.pinkfish.ai), the API trigger panel adds a **Create Data Action** button that exposes the workflow as a Genesys Cloud **Data Action**. A Data Action is a modular building block you can use anywhere Genesys Cloud accepts one: call the workflow from an Architect flow, fetch information for human agents, register it as a tool for an Agentic Virtual Agent (AVA), or let Agent Copilot invoke it to pull data dynamically during a conversation. **Create Data Action** generates a *Custom* Data Action dedicated to this workflow, so whoever wires it up in Genesys Cloud never fills in the workflow's automation ID or builds an inputs JSON by hand. It uses your organization's connected Genesys connection (if none is connected, the modal points you to the Connections page). Click **Create**: * The workflow's automation ID is built into the action — callers never pass it. * Each primitive workflow input (string, number, integer, boolean, and string-like types such as enum, date, or email) becomes a typed field on the action's input contract, with required flags preserved. Object, array, file, and CSV inputs are skipped — pass those through the Static action instead. Input names must be letters, digits, and underscores, starting with a letter; the modal tells you which inputs to rename otherwise. * The action is created in the Genesys org of your organization's Genesys connection, alongside the other Pinkfish Data Actions, and published automatically. Three outcomes are possible: **Published** (ready to use anywhere in Genesys Cloud), **Draft** (created but publishing failed — publish it from Genesys Admin > Integrations > Actions), or **Already exists** (an action for this workflow was created earlier; it is reused, never overwritten). A name conflict with an action that belongs to a *different* workflow is reported as an error — rename the workflow and try again. Before invoking the Data Action: **Release** the workflow, enable the trigger's **Live** toggle, and **Share** the workflow with your organization — Pinkfish Data Actions connect with an organization credential. ### Schedule Trigger Runs the workflow on a cron schedule. Configure with: * **Cron expression** — an AWS EventBridge 6-field cron (`minute hour day-of-month month day-of-week year`). Exactly one of day-of-month / day-of-week must be `?` — e.g. `0 9 * * ? *` (9 AM daily) or `0 0 ? * 2 *` (Mondays at midnight). Expressions that AWS would reject (such as `0 * * * * *`, with `*` in both day fields) are refused when you save. * **Timezone** — the timezone the cron runs in. * A **next-run preview** that shows when the trigger will fire next, in a human-readable form ("Tomorrow at 08:00 UTC"). Schedule Trigger settings panel with Timezone, Run every, and time-of-day fields filled in, plus an Input Payload editor. ### Email Trigger Gives the workflow an inbound email address — `trigger-@pinkfish.email` — and fires whenever a message arrives at that address. The email body, subject, sender, and attachments are exposed as inputs to downstream nodes. ### Integration App Trigger Start the workflow from an event inside a connected app. Pick the app (Slack, Gmail, GitHub, HubSpot, Linear, Notion, and many more), then pick the event (`New Email`, `New Slack Message`, `Issue Created`, etc.). Pinkfish subscribes to the app's webhook or polls its API and fires your workflow when the event occurs. Authentication flows through your existing [connections](/tools/connections). If the app isn't connected yet, the trigger editor walks you through adding the connection inline. ### Event Trigger For internal Pinkfish events — another workflow completing, a data collection updating, a specific agent finishing a run. See [Event triggers](/triggers/event-triggers) for the full reference. ## Trigger input schema Every trigger can declare an **input schema** — a JSON-schema-like definition of the data shape the workflow expects to receive. Inputs appear as named fields the coding agent and downstream nodes can reference (`{{trigger.customerName}}`), and they're validated before the workflow runs. Click **Edit input schema** on any trigger settings panel to open the schema editor. Fields support types: `string`, `number`, `boolean`, `object`, `array`, `file`, `enum`, `date`, and more. Declaring an input schema makes your workflow much easier for others to call correctly — both via API and via the in-editor Run button. ## Draft vs live triggers Agentic workflows maintain separate **draft** and **live** versions of each trigger. Iterating on the draft doesn't affect production callers; when you release the workflow, the live trigger URL starts pointing at the new version. You'll see a small **Draft** or **Live** badge in the trigger settings panel indicating which version's configuration you're editing. ## Testing a trigger * **Manual** — click **Run Workflow** in the header. * **API** — open **Call API trigger** and send the generated curl. * **Schedule** — click **Run now** (fires as if the scheduled time had arrived). * **Email** — send a real email to the trigger's address. * **App trigger** — perform the event in the source app (post a message, open an issue). See [Running a Workflow](/agentic-editor/running) for the full run flow. ## Adding a trigger Open the **Add Node** panel, switch to the **Triggers** tab, and pick a trigger type. The trigger node appears on the canvas at the left edge and its settings panel opens automatically so you can configure it immediately. App triggers require a live connection to the source app. If the connection expires or is revoked, the trigger shows an **Inactive connection** badge in the editor and pauses firing. Re-authenticate from [Connections](/tools/connections). ## What's next Test your trigger with real or simulated invocations. Configure the user-facing form that the Interface trigger serves. Pinkfish's internal event system. Program against trigger endpoints from outside Pinkfish. # Advanced tab Source: https://docs.pinkfish.ai/agents/advanced Output Schema — force structured JSON responses for API callers The **Advanced** tab houses configuration that isn't in the common path. Today it has one setting: **Output Schema**. Advanced tab showing the Output Schema section with a description, a Builder / JSON Editor toggle, a Schema Type dropdown set to Object, and a Properties table with a single row named 'result' of type String with a Required toggle, and an Add Property button ## Output Schema > *"Optional JSON schema that defines the structure of agent responses when called via API. This ensures consistent, structured outputs that are easier to parse and integrate with other systems."* When set, every API response from this agent conforms to the schema you defined. No more hand-rolling regexes against free-text replies — the agent returns a validated JSON object you can hand straight to your downstream code. ### Who this is for Output Schema matters almost exclusively for **programmatic callers** of the [Agent Management API](/api-reference/platform/agent-management). If you only ever chat with the agent in Coworker, Slack, or Teams, leave it blank — those surfaces display the free-form reply the model produced. ### How to configure The editor has two modes — switch via the **Builder / JSON Editor** toggle at the top. #### Builder mode A visual builder: * **Schema Type** — pick the top-level shape. Usually `Object`, but primitives are supported too. * **Properties** — a table of fields, each with a name, a type (`String`, `Number`, `Boolean`, `Object`, `Array`, etc.), and a **Required** toggle (shown as a green switch when on). * **Add Property** — append a new row. For complex shapes, drill into a property to set nested properties, descriptions, and enum values. #### JSON Editor mode Paste or hand-write a standard JSON Schema. Handy when you already have a schema defined elsewhere and want to copy it over. ```json theme={null} { "type": "object", "properties": { "summary": { "type": "string", "description": "One-sentence summary of the user's question" }, "action_items": { "type": "array", "items": { "type": "string" } }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": ["summary", "confidence"] } ``` ### What it does at runtime * **API callers** — responses are returned as JSON matching the schema. The agent retries internally if the model's first attempt is malformed. * **Coworker / Slack / Teams** — the platform extracts the message field from the response and renders it as normal prose. The schema is still enforced on the underlying object, but users see a regular chat reply. ### When *not* to set an output schema * You want the agent to reply conversationally — `Output Schema` trades naturalness for predictability. * Your responses need to be long-form essays or creative writing. Narrow the schema only to fields you genuinely need downstream. * You're still iterating on behavior. Nail the agent's content first, then add a schema once the shape is stable. ## What's *not* on the Advanced tab Things people sometimes look for here but won't find: * **Model selection** — lives on [Instructions](/agents/instructions). * **Temperature, max tokens, reasoning effort** — controlled via the model choice on Instructions (e.g. `Opus Low / Med / High` as discrete thinking-effort levels). * **Rate limits / concurrency** — managed at the subscription and org level, not per agent. * **Delete agent** — use the chevron-menu next to the agent name in the top bar, or the row action on the [My Agents](/agents/my-agents) list. * **Share / ACL controls** — use the **Share** action on the top-bar name chevron. ## Related * [Agent Management API](/api-reference/platform/agent-management) — where structured output actually matters. * [Instructions tab](/agents/instructions) — where the model is chosen. # Agent Builder Source: https://docs.pinkfish.ai/agents/agent-builder Anatomy of the builder — full-width tab bar at the top, editor panel on the left, live preview on the right The **Agent Builder** is where you configure every aspect of an agent. You open it by clicking an agent in the [My Agents list](/agents/my-agents) or by clicking **Create new agent** (which goes to `/agents/builder/new`). Agent Builder for the Sales Assistant agent — all six tabs (Instructions, Tools, Resources, Channel, Monitor, Advanced) pinned on the left, Instructions tab active with the agent name and system prompt, and the right-hand Preview pane showing an active chat where the user asked 'Summarize this week's pipeline changes and highlight anything at risk' and the agent is replying The builder is a three-part layout: 1. **Top bar** — a full-width header spanning both panes: back arrow, agent name (with quick actions), tab strip, **Builder** toggle, **Save** and **Release** buttons. 2. **Editor panel** (left) — the configuration surface for the active tab. You can have up to six tabs pinned at once. 3. **Preview pane** (right) — a live chat against your draft, or an Information view of the agent's current config. ## The top bar From left to right: * **← Back arrow** — returns you to `/agents`. * **Agent name** — click the chevron next to the name to open a small menu with **Tag**, **Share**, and **Delete** actions. Edit the name itself from the **Instructions** tab. Agent name dropdown open showing Tag, Share, and Delete (in red) options * **Tabs** — a horizontal strip of the sections you've pinned. See below. * **Builder** *(only on agents you can edit)* — toggles the **Agent Builder** chat panel open alongside the editor. Use it to describe changes in natural language and let the AI apply them for you. * **Save** — writes the current form values as a new draft version. Disabled when nothing has changed and on brand-new agents until required fields are filled. * **Release** — opens the Publish dropdown. See [Save & Release](/agents/releases). Some buttons fire **"Please save the agent before \[action]"** toasts when you try to Tag, Share, or Delete a brand-new agent that hasn't been saved yet. ## The six tabs Builder tabs strip with all six tabs pinned — Instructions, Tools, Resources, Channel, Monitor, Advanced — plus a trailing + button for un/re-pinning Every agent has up to six configuration tabs, listed here in their canonical order: Name, icon, description, system prompt, model, prompt bubbles. **Always pinned** — you can't remove it. MCP connections, embedded services, agents-as-tools, workflows-as-tools. Datastores, filestores, knowledge bases with Read / Write / Admin permissions. Slack, Microsoft Teams, Email, API, A2A. Replay this agent's chats from inside the builder. Output Schema — structured JSON responses for API callers. ### Pinning tabs Only **Instructions** and **Tools** are pinned by default. Click the **+** at the end of the tab strip to pin **Resources**, **Channels**, **Monitor**, or **Advanced**. Pinned tabs persist across sessions. If a tab has validation errors, its label turns red. The **Channels** and **Advanced** tabs are hidden for Pinkfish's built-in system agents. ## The preview pane The right side of the builder is a live sandbox against your current draft. It has two tabs: ### Test The default view — a chat interface connected to the draft you're editing. Type a message, watch the agent respond with the current instructions, model, and tools. This is where you validate changes before releasing. Preview pane showing an active chat with the Sales Assistant agent — user prompt 'Summarize this week's pipeline changes and highlight anything at risk.' and the agent replying with a 'Working... 5s' indicator For brand-new agents you'll see: > *"Save the agent first, then start a conversation to test it here."* Click **+ New Chat** to clear the preview and start fresh — useful when you've changed instructions and want to see behavior from a clean starting point. ### Information The **Information** tab is a read-only summary of what the agent will actually do when invoked. Information pane showing Selected Model (Sonnet 4.5), Selected Tools (1) — Knowledge Base expanded showing four tools (Ask, Create/Rewrite, Search, Update/Delete), Auto-selected Tools (5) — Write Artifact, Read Artifact, List Artifacts, Write Artifact from URL, Code Execution — and Selected Resources (2) — two Blueberries Chat Collection entries with Read/Write/Admin summaries It shows: * **Selected Model** — the model label (e.g. `Sonnet 4.5`). * **Selected Tools (N)** — tools you picked, grouped by server. Shows `All X tools` when you've selected a server wholesale, or the exact tool names when you picked a subset. Expand rows with more than five tools via **+N more**. * **Auto-selected Tools** — built-in tools that every agent gets automatically (e.g. Write Artifact, Read Artifact, Run Code). These can't be turned off. * **Selected Resources (N)** — attached datastores/filestores/KBs with a Read / Write / Admin summary. The Information view is especially handy when debugging — if the agent isn't using a tool you expected, this pane tells you whether it's in scope. ## The full workflow Click a row in [My Agents](/agents/my-agents), or click **Create new agent** to land on `/agents/builder/new`. Name, instructions, icon, description, model. These are the minimum to save. Click **Save** to persist a draft. You can test it in the Preview pane now. Click **+** to add Resources, Channels, Monitor, or Advanced. Configure each. Chat with the draft. Check the **Information** tab to confirm model, tools, and resources look right. Open the **Release** dropdown and publish. The released version becomes available in Coworker and on enabled channels. ## Related * [Save & Release](/agents/releases) — what Save vs Release actually does. * [Instructions](/agents/instructions) — the first tab in detail. * [Monitor](/agents/monitor) — the in-builder monitor, not the org-wide one. # Channels tab Source: https://docs.pinkfish.ai/agents/channels Choose where users and other systems can reach your agent — then click through for setup details on each channel The **Channels** tab controls where your agent can be reached. By default every agent is usable from Coworker inside Pinkfish; channels extend that reach to other surfaces. Each channel is a toggle on this tab — turn one on, and the deep-dive page below covers its setup, behavior, and limits. Channels tab showing channel cards — each with an icon, a short description, and a toggle on the right ## Available channels `@`-mention or DM the agent from Slack on desktop, web, or mobile. Enable per agent or org-wide. Message the agent from the Teams chat surface. Conversations sync back to Coworker. Call the agent over plain HTTP — POST a message with an `X-API-Key` header, get the reply back. Expose the agent over the open agent-to-agent (A2A) protocol so external agents can discover and call it. Every agent is also reachable from [Coworker](/coworker/overview), the default web channel — it's always on and isn't a toggle on this tab. ## Before you enable a channel * **Save first.** New agents must be saved at least once before a channel can be enabled. Toggling a channel on an unsaved agent pops a **Save agent first** modal. ## Channel behavior at runtime When a channel is enabled, Pinkfish maps each conversation there back to an agent chat. Thread context is preserved: a Slack thread, a Teams reply chain, and a Coworker chat each become their own conversation record the agent sees in sequence. The programmatic channels carry the conversation handle explicitly — the [API channel](/api-reference/platform/agent-api-channel) via `chatId` and [A2A](/api-reference/platform/a2a) via `contextId` — which you pass back on each call to continue a conversation. Org admins can opt individual agents out of org-wide channel enablement via the [Agent Management API](/api-reference/platform/agent-management). For most users, the per-agent toggles on this tab are all you need. ## Related * [Save & Release](/agents/releases) — what **Save** does; an agent must be saved once before a channel can be enabled. * [Coworker](/coworker/overview) — the default web channel, always on. * [Agent Management API](/api-reference/platform/agent-management) — create, manage, and invoke agents programmatically. # Instructions tab Source: https://docs.pinkfish.ai/agents/instructions Name, icon, description, system prompt, model, and prompt bubbles The **Instructions** tab is the first tab in the Agent Builder. It's always pinned and is the minimum viable configuration — every other tab is optional. Instructions tab for the Sales Assistant agent showing Agent Name (Sales Assistant), Agent Instructions expanded with a filled system prompt, and collapsed Agent Icon / Agent Description / Model / Prompt Bubbles sections. All six builder tabs are pinned at the top (Instructions, Tools, Resources, Channel, Monitor, Advanced). Each field is a collapsible section. Click a section header to expand or collapse it. ## Agent Name Required. The display name users see in Coworker, in the `@`-mention picker, and in every chat transcript. * Placeholder: *My Agent* * Keep it short and human — "Sales Assistant", not "Sales\_Assistant\_v2\_final". The name is also used by the builder to compute the small two-letter avatar circle in the preview pane (e.g. **SA** for Sales Assistant). ## Agent Instructions Required. The system prompt that defines how the agent behaves — role, scope, rules, tone, tools it should prefer, and any do-not-do guardrails. The placeholder offers a starter template along the lines of: > *Role / What You Do / Rules — You are an AI assistant specialized in \[insert domain or function, e.g. IT service management, HR onboarding, customer support]…* Tips that tend to produce better agents: * **Lead with role and scope.** One clear sentence that tells the model who it is and what problem it owns. * **List rules as bullet points.** Models follow crisp constraints better than paragraph prose. * **Describe the tools it has.** If you've attached Slack, Gmail, and a knowledge base, name them — the model decides which one to reach for faster. * **Say what to refuse.** Explicit "when asked about X, politely redirect" rules stop off-scope conversations. There is no hard character limit, but extremely long prompts consume context on every turn, which can slow responses and raise token usage. ## Agent Icon Optional. A single-character / emoji / image icon shown next to the agent in lists and preview avatars. Click the section to open the icon picker. ## Agent Description Optional but recommended. A short, user-facing summary of the agent. * Placeholder: *Describe what this agent does and its main purpose* * Shown in the [My Agents list](/agents/my-agents) and in the preview pane header. Users discover agents in Coworker by reading descriptions, so write for that audience — "Helps with CRM updates, pipeline reviews, and drafting outreach emails" is more useful than "Sales agent". ## Model Required — but defaulted. The model that runs every turn of this agent's conversations. Model dropdown expanded showing a list of models grouped by provider — Claude (Haiku 4.5, Sonnet 4.5 selected as default, Opus Low / Med / High), Inception (Mercury 2), and OpenAI (GPT-5.4, GPT-5 Mini, ...) Models are grouped by provider. The exact labels available depend on what your organization has enabled, but typically you'll see: * **Claude** — Haiku 4.5 (fast, low-friction), Sonnet 4.5 (balanced, the default), Opus Low / Med / High (most intelligent; Low / Med / High controls thinking effort). * **Inception** — Mercury 2 (ultra-fast diffusion model; good for narrow code tasks). * **OpenAI** — GPT-5.4, GPT-5 Mini, GPT-5 Nano. * **Groq** — hosted open-weights models (e.g. GPT-OSS-120B, GPT-OSS-20B). * **Fireworks** — hosted open-weights models (e.g. Kimi-K2p5). Each row in the dropdown shows a short description next to the label ("fast, low-cost", "balanced speed and intelligence (default)", etc.). Changing the model **does not auto-tune the system prompt**. A prompt that works great on Sonnet may behave differently on Haiku or a non-Claude model. Always re-test in the preview after switching. ## Prompt Bubbles Optional. One-click conversation starters shown in the preview pane and in Coworker when your agent is selected. * Placeholder: *Example 1 / Example 2 / Example 3* * One starter per line in the textarea. * Keep them short — they render as small rounded buttons. A good set has three to six varied starters that cover common first-asks. For a sales agent, that might be: ``` Summarize this week's pipeline changes Draft a follow-up email for the Acme meeting What deals are stalled for more than 14 days? ``` Up to six buttons are shown on channels that display them. ## Required vs optional | Field | Required | Used for | | - | - | - | | Agent Name | Yes | Display everywhere | | Agent Instructions | Yes | System prompt on every turn | | Model | Yes (defaulted) | Which LLM runs the agent | | Agent Icon | No | Visual identity | | Agent Description | No | Discovery copy in lists / Coworker | | Prompt Bubbles | No | Quick-start buttons | You can save and release an agent with only Name + Instructions filled, but for anything user-facing, fill Description and Prompt Bubbles too. ## Related * [Tools tab](/agents/tools) — pick which tools the agent can call. * [Agent Memory](/agents/introduction#agent-memory) — long-lived memory across sessions. * [Save & Release](/agents/releases) — what happens when you click **Save**. # AI Agents Source: https://docs.pinkfish.ai/agents/introduction Configurable AI assistants with custom instructions, tools, resources, and channels An **agent** in Pinkfish is a configurable AI assistant. You define how it behaves with instructions, choose which model it runs on, pick the tools it can call (via MCP servers, attached workflows, or other agents), grant it access to resources (datastores, filestores, knowledge bases), and expose it through one or more channels (web chat, Slack, Microsoft Teams, a public URL). You **save** drafts while iterating and **release** published versions that become usable from Coworker. The /agents page showing a list of published agents with status badges, filters, search, and a Create new agent button ## What's in this section The `/agents` page — list, filter, search, and monitor all agents in your workspace. Anatomy of the builder: tabs on the left, live preview on the right, save and release controls on top. Name, icon, description, system prompt, model choice, and prompt bubbles. MCP connections, embedded services, agents-as-tools, and workflows-as-tools. Attach datastores, filestores, and knowledge bases with Read / Write / Admin permissions. Publish your agent to Slack, Microsoft Teams, or a public External URL. Replay an agent's chats, inspect tool calls, and debug behavior from inside the builder. Output Schema — force structured JSON responses when calling the agent via API. The draft-vs-release model, how releases reach Coworker, and how to roll back. How agents discover and invoke MCP tools from your integrations. ## Agent types Pinkfish supports two agent types: * **Chat** — A conversational agent that responds to messages. Use for assistants, researchers, and copilots. * **Workflow** — An agent bound to a specific workflow. Use when you want a workflow run to be triggered conversationally. Both types use the same builder. ## Where agents run An agent can answer messages from any of these places once you release it: * **Coworker** — The chat tab inside Pinkfish. `@`-mention the agent in a Coworker chat. * **Slack** — Connect a Slack workspace in the Channels tab. * **Microsoft Teams** — Connect a Teams tenant in the Channels tab. * **API** — Programmatic access with an agent API key. See [Agent Management API](/api-reference/platform/agent-management). ## How the pieces fit together On the **Instructions** tab, give the agent a name, an icon, a description users will see, a system prompt that defines its behavior, and a model. Optionally add prompt bubbles — one-click conversation starters. On the **Tools** tab, select MCP servers (integrations), Embedded Services, other agents you want this agent to be able to delegate to, and workflows it can trigger. Pinkfish adds a few Auto-selected Tools for every agent. On the **Resources** tab, grant read/write/admin access to specific datastores, filestores, and knowledge bases. Required tools are added to the Tools tab automatically. On the **Channels** tab, enable Slack, Microsoft Teams, or make the agent public via External. A published release is required before External works. The right-hand **Preview** pane is a live chat against your current draft. Click **Information** in the preview to double-check the selected model, tools, and resources. **Save** commits a draft. **Release** publishes an immutable snapshot that becomes available in everyone's Coworker tab (subject to sharing). ## Agent Memory Store and recall user preferences and context across conversations and sessions. ## Sharing agents Agents can be shared with other people in your org via the agent's **Share** action. Recipients get access to chat with the agent, but they must connect their own integrations — Pinkfish does not share your OAuth tokens. See the [API reference](/api-reference/platform/agent-management) for programmatic sharing. ## Related features * **[Coworker](/coworker/overview)** — Where released agents appear for `@`-mention and chat. * **[Agent Monitor](/orchestration/agent-monitor)** — Org-wide view of every agent chat across all users. * **[Datastores](/resources/database)**, **[Filestores](/resources/file-store)**, **[Knowledge Bases](/resources/knowledge-base)** — The three resource types you can attach. * **[API connections](/tools/connections)** — The integrations that feed the Tools tab. # MCPs (Model Context Protocol) Source: https://docs.pinkfish.ai/agents/mcps How agents use MCP servers and tools to extend their capabilities ## How Agents Use MCPs **Model Context Protocol (MCP)** is an open standard that lets AI agents discover and call external tools. In Pinkfish, agents use MCP servers as their toolbox: each server hosts multiple tools (e.g., "read file", "search email", "query database") that the agent can invoke during a conversation. When you configure an agent, you select which MCP servers it can use. The agent then discovers the available tools and calls them as needed to complete tasks. All MCP servers on Pinkfish are hosted and verified by Pinkfish — we do not use third-party MCP servers. ## Authenticated Integrations For MCP servers that connect to external services (Google Drive, Slack, Salesforce, etc.), you must first authenticate in [Integrations](/tools/connections). After you add a connection, your agents can use the tools provided by that integration. For example, connecting to Google Drive enables tools like list files and write files. ## Sharing and Permissions The agent acts as your proxy — it only has access to integrations you have permission to use. When you share a custom agent, integrations do **not** share with it (similar to workflows). If you share a "Google Drive Agent," recipients must connect their own Google Drive; they cannot use yours unless you also share your connection. When building custom agents, you can suggest in your instructions that users connect specific services (e.g., Google Drive) to get the most from the agent. In the product, use the "Examples and Tools" menu from the agent prompt box to see tools per server. ## Full Reference For the complete list of MCP servers, tool schemas, and API details, see the API reference: * [Embedded MCP Servers](/api-reference/mcp-servers/embedded/overview) — Built-in servers (code execution, AI models, data storage, search, etc.) * [Application MCP Servers](/api-reference/mcp-servers/application/overview) — Integration servers (Google Workspace, Microsoft 365, Slack, Salesforce, and 100+ more) * [MCP Protocol](/api-reference/platform/making-requests) — JSON-RPC format, authentication, and calling patterns # Monitor tab Source: https://docs.pinkfish.ai/agents/monitor Replay this agent's chats and inspect tool calls from inside the builder The **Monitor** tab inside the Agent Builder is a focused debugger for *this* agent. Where the [org-wide Agent Monitor](/orchestration/agent-monitor) gives you every chat across every agent, the in-builder Monitor only shows chats for the agent you're editing. Monitor tab inside the builder with a real chat selected. Left pane shows the chat list with 'Summarize weekly pipeline changes…' at 4/14/2026 11:34 PM. Right pane shows the full message thread: a user prompt, three 'Tool Call: knowledge_base_search' entries paired with three 'Tool Result: knowledge_base_search' responses, and the agent's reply — each entry timestamped. Use it when you want to answer one of these questions: * *"Why did the agent pick that tool?"* * *"What parameters did it actually pass?"* * *"Did a tool call return an error that the user didn't see in the surfaced reply?"* ## Layout The tab has two panes. ### Left — chat list Every chat this agent has been part of, newest first by default. * **Search here…** — filter the list by chat title. * **Sort order arrow** — flip between newest-first and oldest-first. * Empty state: **"No chats found."** when the search doesn't match, or the agent simply has no chats yet. Click a chat to load it on the right. ### Right — message viewer The full message thread for the selected chat. * **Search messages…** — filter the thread for a keyword. * **Expand all** — expand every tool-call block at once. * Message actions (top-right icons) — copy / download controls for the selected thread. Empty state before you've clicked a chat: > **No Chat Selected** > > *Select a chat from the list to view monitor activity.* If the selected chat has no content yet: > **No Messages Found** > > *This chat doesn't have any messages yet. Start a conversation in the preview panel to see monitor information.* ## Parsed message details The viewer parses each message to surface the agent's internal work, not just the final reply. Expect to see, per message: * The **tool name** the agent called. * The **parameters** it passed. * The **result** (or the error, if the call failed). * The **model's reasoning text** when the model supports it. This is the same content you'd see if you turned on verbose logging, just rendered as a chat replay instead of a log stream. ## When to use this vs the org-wide Monitor | Use the in-builder **Monitor** tab when… | Use the [org-wide **Agent Monitor**](/orchestration/agent-monitor) when… | | - | - | | You're iterating on a single agent | You're doing analytics or capacity planning across many agents | | You want to drill from "this run failed" to "this parameter was wrong" | You want to see usage trends or who is chatting with what | | You need to see ephemeral tool errors the user didn't surface | You want to customize columns, date ranges, and export data | Both views are reading the same underlying chat store — switching between them doesn't change any data, just the filter. ## Tips * Pin the Monitor tab before you start iterating. Clicking **+** on the tab strip lets you pin it so you can pivot between Instructions → Tools → Monitor quickly. * While debugging, run the same prompt twice in the Preview pane: once before a change, once after. The two runs sit side-by-side in Monitor, making regressions easy to spot. * If you've published a release, you can see Coworker / Slack / Teams conversations the same way — they're all just chats tied to the agent. ## Related * [Agent Monitor](/orchestration/agent-monitor) — the org-wide version. * [Tools tab](/agents/tools) — where you change what the agent can call once the Monitor tells you it's calling the wrong thing. * [Advanced tab](/agents/advanced) — force structured responses if you're hitting free-text parsing issues. # My Agents Source: https://docs.pinkfish.ai/agents/my-agents The /agents page — list, filter, search, and monitor every agent in your workspace The **Agents** tab in Pinkfish's top navigation opens `/agents` — the home for every agent in your workspace. The page has two sub-tabs: * **My Agents** — the inventory of every agent you can see or edit. * **Monitor** — an org-wide feed of agent chats, for debugging and analytics. The My Agents list showing several published agents with status badges, filters for Status and Tag, a search box, a view toggle, and a Create new agent button ## My Agents list The list shows every agent you have permission to view. Each row gives you the essentials at a glance. ### Columns | Column | What it shows | | - | - | | **Agent Name** | The agent's name and up to \~80 characters of description. A small "shared" icon appears on agents shared with other accounts. A globe icon appears on agents published as public. | | **Status** | `Published` / `Draft` / `Unpublished Changes`. See [Save & Release](/agents/releases) for the full model. | | **Tags** | Up to one tag per row. A dash (`—`) means no tags. Click the tag filter to narrow the list. | | **Created By** | Either `Created by me`, `Created by anyone`, or `Not created by me`. | | **Last Modified** | When the agent was last saved. | | **Actions** | The `⋯` menu described below. | ### Filters, search, and views * **Search here…** — free-text search over agent name, description, and creator name. * **Status** — filter by Published, Draft, or Unpublished Changes. * **Tag** — filter by any tag applied to agents. * **Recent / alphabetical** — sort order (grid view only). * **Grid ↔ List** — toggle the view in the top-right. Grid shows cards; list shows the table with a row-action `⋯` menu. ### Creating a new agent The pink **Create new agent** button in the top-right of the page takes you to `/agents/builder/new`. See [Agent Builder](/agents/agent-builder) for what happens next. Close-up of the pink Create new agent button with a plus icon ### Status badges The **Status** column uses three colored badges. They roll up the draft-vs-release state from the builder. Published status badge close-up | Badge | Meaning | | - | - | | **Published** | The agent has at least one release and no un-saved changes beyond it. Available in Coworker. | | **Unpublished Changes** | The agent has a release, but the latest draft differs from it. The release is still live; the draft will overtake it only after you click **Release** again. | | **Draft** | The agent has never been released. Only you can use it from the builder preview. | ### Row actions In list view, click the `⋯` icon on any row to open a dropdown with: Agent row with actions dropdown open showing Edit, Share, Add Tag, and Delete (in red) * **Edit** — open the agent in the builder. * **Share** — open the **Share Agent** modal and pick the people, or your whole organization, who can use this agent. **Chat** lets them use it; **Manage** also lets them configure and share it. Sharing gives access to the agent; it does not share your OAuth connections. * **Add Tag** — open the tag editor to add or remove tags. * **Delete** — permanently delete the agent. A confirmation dialog asks *"Are you sure you want to delete this agent?"* before anything is removed. For public agents, an additional **Remove Public Agent** entry appears — it takes the agent off the public catalog without deleting it. You can't rename an agent from this menu. Rename from the **Instructions** tab inside the builder. ### Empty state Before you've created any agent, the list is replaced with a welcome card: > *"Create your first expert agent that you can interact with to get work done."* It has a **Create new agent** button and a **Watch: How to create an agent** link. ## Monitor tab The **Monitor** tab at the top of `/agents` is the org-wide agent chat feed. It's identical to the standalone [Agent Monitor](/orchestration/agent-monitor) page — the same data, opened through a different entry point. Monitor tab showing a table of agent chats with columns Agent Name, Chat Title, Last Chat, By, and Actions, plus a Last 7 Days date picker, Refresh button, and Columns selector Use it to: * See every chat across every agent in your org for the last 7 days (customizable). * Search by agent name, chat title, or user. * Click a row to drill into the full conversation. * Toggle which columns to show. For an agent-scoped version that only shows the current agent's chats, use the **Monitor** tab *inside the builder* — see [Monitor](/agents/monitor). ## Keyboard tips * `/` focuses the **Search here…** input on the list page. * Pressing **Esc** closes any open filter dropdown or confirmation. ## Related * [Agent Builder](/agents/agent-builder) — what happens when you click into a row. * [Save & Release](/agents/releases) — what the status badges mean under the hood. * [Agent Monitor](/orchestration/agent-monitor) — the org-wide monitoring page. # Save & Release Source: https://docs.pinkfish.ai/agents/releases Draft versions, releases, and how published agents reach Coworker Agents have two kinds of version: **drafts** (what you're editing) and **releases** (immutable snapshots that users actually chat with). Understanding the split is the key to confident iteration — you can break the draft freely without affecting anyone on the released version. ## Save Clicking **Save** in the top-right of the builder writes the current form as a new draft. The draft number increments with each save. **Save** is disabled when: * there are no unsaved changes, or * the form has validation errors, or * the agent is new and required fields (Name, Instructions) are missing, or * a dashboard / long-running action is already processing. Save is safe. It never affects existing Coworker users or published channels — only the draft you see in the builder's preview reflects the change. ## Release Clicking **Release** (the pink button next to **Save**) opens the Publish dropdown. Release dropdown open over the Tools tab showing a 'Publish a Release' header, copy that says 'Make your agent available in your Coworker tab to get permission to use.', a pink Publish button, and a Release History section listing Latest Release v1 with a date and 'Made available via Public Template' badge From here you can: 1. **Publish** a new release — snapshots the current draft as an immutable version that becomes available in Coworker (subject to who the agent is shared with). 2. **See release history** — every prior release with its version number and date. 3. **Roll back** — pick an older release to mark it as the latest. (Release artifacts are immutable, so rolling back is really re-pointing at an earlier one.) ### Success and no-change feedback * Toast on success: **"Release created successfully"**. * Toast when nothing has changed since the last release: *"No new release was published since the agent didn't change. Make changes to your agent and try publishing again."* ### What a release does > *"A release makes your agent available in your **Coworker** tab for everyone with the right permission to use."* When you release an agent: * **Coworker** users who have permission see the latest release in the agent picker. * **Slack** / **Teams** / **External** channels start routing messages to the new release. * **API callers** using the agent's API key get the new release. Until you release, only you (in the builder preview) are hitting the draft. ## Drafts vs releases at a glance | Concept | Where you see it | Who can use it | | - | - | - | | **Draft** | Preview pane of the builder | Only the person editing | | **Latest release** | Coworker, Slack, Teams, External URL, API | Everyone the agent is shared with | | **Previous releases** | Release dropdown > Release History | Nobody, unless you roll back | ## Status badges on the list page The [My Agents](/agents/my-agents) list summarizes this state as a badge on each row: | Badge | Meaning | | - | - | | **Published** | Has at least one release; draft matches it. | | **Unpublished Changes** | Has a release, but the current draft differs. The release is still live. | | **Draft** | Never been released. Only usable from the builder. | The builder itself shows a small indicator on the Release button when the current draft has unpublished changes relative to the latest release. ## Typical lifecycle Fill out Instructions, click **Save**. Status on the list: **Draft**. Chat with the draft in the right-hand preview pane until the behavior looks right. Click **Release** → **Publish**. Status: **Published**. The agent is now visible in Coworker. Edit instructions, tools, or resources. Save. Status: **Unpublished Changes** — Coworker users are still on v1. When happy, click **Release** → **Publish** again. Coworker flips to v2. If v2 introduces a regression, use **Release History** to roll back to v1 while you fix things in the draft. ## Things that need a release Some features won't work until you've published at least once: * **API access** for external callers — the API routes hit the latest release, not the draft. The [Channels tab](/agents/channels) pops a save-first warning for related toggles. ## API surface If you prefer programmatic control, the same operations are available: | Method | Endpoint | Purpose | | - | - | - | | `POST` | `/api/useragents/{id}/releases` | Publish the current draft as a release | | `DELETE` | `/api/useragents/{id}/releases` | Delete a release | See the [Agent Management API](/api-reference/platform/agent-management) for details. ## Related * [Agent Builder](/agents/agent-builder) — where Save and Release live. * [Channels](/agents/channels) — who can reach published releases. * [My Agents](/agents/my-agents) — status badges summarize this state. # Resources tab Source: https://docs.pinkfish.ai/agents/resources Attach datastores, filestores, and knowledge bases with Read / Write / Admin permissions The **Resources** tab grants the agent access to data that lives in your Pinkfish workspace. It's how you turn a general-purpose assistant into one that knows your CRM, your PDFs, and your team's documentation. Resources tab for the Sales Assistant agent with Show Selected (2) active — the Knowledge Bases section is expanded and shows two attached 'Blueberries Chat Collection' entries in a table with columns Name, Read, Write, Admin. The first row has Read + Write checked; the second has Read only. Resources are **data**. Unlike [Tools](/agents/tools), which are actions the agent can take, resources define what the agent can read, write to, or administer. ## The four resource types ### Structured Databases Pinkfish **datastores** with a schema — tables with typed columns. Think customer records, opportunities, tickets. > *"Give your agent permission to use your structured databases (tables)"* Attach a structured datastore and the agent can query it, filter rows, add new rows (if you grant Write), or delete rows (if you grant Admin). See [Datastore](/resources/database) for how to create one. ### Unstructured Databases Datastores that store freeform documents or JSON blobs without a fixed schema. Useful for rolling logs, notes, and anything that doesn't fit a table. ### Files Pinkfish **filestores** — a place to store PDFs, images, spreadsheets, and any binary content. Attach a filestore and the agent can upload new files, read existing ones, or — with Admin — delete them. See [Filestore](/resources/file-store) for details. ### Knowledge Bases Semantic search over your documents. Attach a KB collection and the agent can perform natural-language queries against its contents and get back ranked snippets. See [Knowledge Base](/resources/knowledge-base) for ingestion details. ## Permissions Every attached resource requires at least one permission to be checked. The three permissions: | Permission | What the agent can do | | - | - | | **Read** | Query / list / search the resource. | | **Write** | Create new entries or update existing ones. | | **Admin** | Delete entries and perform administrative actions. | Grant the minimum permission the agent genuinely needs. A customer-support agent probably needs `Read` on product docs but nothing more; a data-entry agent needs `Write` but not `Admin`. Resources without any permission checked are invalid — the agent won't save until you pick at least one. There is no "implicit Read" default. ## Search and filter * **Search resources…** — free-text filter over collection names and descriptions. * **Show Selected (N)** — collapse the view to just the resources you've attached. `N` reflects the current count. ## Automatic tool injection When you attach a resource and grant permissions, Pinkfish **automatically adds the matching tools** to your agent under **Tools → Auto-selected Tools**. You don't need to also go to the Tools tab and pick the datastore-query tool — the platform does it for you based on the permissions you picked. Example: attach a structured datastore with Read permission, and the internal datastore-query tool lights up. Grant Write, and the insert tool is added too. Remove the resource, and the tools are removed. This means the Resources tab is the only place you configure *what data the agent can reach*. The Tools tab stays focused on *actions*. ## Sharing resources vs sharing agents Sharing an agent with a colleague gives them **chat access** to the agent — they can talk to it. It does **not** give them access to the attached resources. * For structured/unstructured datastores and filestores, each user still needs to have their own access to the underlying collection (or the collection must be org-wide). * For knowledge bases, the same rule applies. If a user doesn't have permission to a resource the agent depends on, the agent will report a permission error for that tool when it tries to use it. ## Related * [Tools tab](/agents/tools) — actions (not data). * [Datastore](/resources/database) — how to create and populate structured/unstructured datastores. * [Filestore](/resources/file-store) — binary-file storage. * [Knowledge Base](/resources/knowledge-base) — semantic search over documents. # Tools tab Source: https://docs.pinkfish.ai/agents/tools MCP connections, embedded services, agents-as-tools, and workflows-as-tools The **Tools** tab is where you decide what the agent can actually *do*. Every tool you pick here becomes callable by the agent at runtime. Tools tab for the Sales Assistant agent with nine tools selected (Show Selected (9)) across the four categories — Connections, Embedded Services, Workflows, and Auto-selected Tools. The right-hand Preview pane shows a live chat where the agent has detected it doesn't have the CRM data it needs and is asking the user to pick a path via a dropdown ('Choose an option') — a runtime interactive decision. ## The four categories Tools are grouped into expandable sections. Click a section header to expand or collapse it. ### Connections MCP servers for third-party integrations that authenticate via OAuth or API keys — Slack, Gmail, Google Drive, Salesforce, HubSpot, Jira, Notion, and many more. These draw from the **Integrations** you've connected in your workspace. For each server, you can: * **Check the whole server** — the agent gets every tool the server exposes. * **Click to expand** — pick a subset of tools. Useful when a server exposes 50 tools but you only need three. ### Embedded Services Pinkfish's built-in MCP servers that don't require an OAuth connection — things like code execution, artifact management, and agent-memory helpers. These are always available to any user in the org. ### Agents *(Only visible when other agents exist.)* Other agents in your workspace that this agent is allowed to delegate to. When selected, the target agent shows up as a callable "tool" — the current agent can invoke it the same way it would invoke any other tool. This is how you build teams of specialized agents instead of one monolithic one. ### Workflows Pinkfish workflows that the agent can trigger. > *"Select workflows this agent can invoke"* A workflow attached here appears to the agent as a tool: the agent decides when to call it, passes input, and receives the workflow output as a structured response. Great for multi-step procedures that you've already encoded as a workflow (e.g. "run the customer onboarding flow"). **Workflows attach here, not under Resources.** A common confusion — "resources" in Pinkfish means data (datastores, filestores, KBs), while workflows are *actions* and live under Tools. ### Auto-selected Tools Tools that every agent gets automatically. Checkboxes are shown but locked — you can see what's included, not toggle it. Examples (subject to platform evolution): * **Write Artifact / Read Artifact / List Artifacts** — lets the agent produce files, spreadsheets, and documents inside a chat. * **Write Artifact from URL** — ingest content from a URL as an artifact. * **Run Code** — execute Python snippets. ## Finding tools * **Search servers…** — filter the entire list by server name or description (case-insensitive, 200 ms debounce). * **Show Selected (N)** — toggle the view to just the tools you've checked. The `N` always reflects the current selection count. * **Select all / Deselect all** — per-section bulk toggles. ## Discovery Tools (tool overflow) Selecting more than 25 tools triggers a banner: > *"You've added more than 25 tools. To keep agents effective at scale, **Discovery Tools** are automatically enabled so the agent can dynamically find the right tool among the ones selected. This may add a few seconds to execution but improves accuracy."* With Discovery on, the agent first searches its tool library for candidates before calling any of them — slightly slower per turn but dramatically more accurate when the toolset is broad. You don't need to enable Discovery Tools manually. Pinkfish decides based on how many tools you selected. ## Tool approvals and interactive UI (human-in-the-loop) Some tools are configured to pause for explicit user approval before running, and agents can also ask users for input mid-conversation. Unlike fixed "always allow / ask / never" policies, Pinkfish interaction is **runtime-driven**: the agent either drafts a call and waits for **Approve** / **Reject**, or asks the user to pick from options before it proceeds. In the screenshot above, the Sales Assistant agent discovered it didn't have pipeline data and asked the user *"How would you like to proceed?"* with a **Choose an option** dropdown. The agent wrote the question, Pinkfish rendered it as an interactive control, and execution paused until the user picked. Approvals have four states: | State | Meaning | | - | - | | `PENDING` | Waiting for a human to decide. | | `APPROVED` | The user clicked Approve — execution resumes. | | `REJECTED` | The user clicked Reject — the tool call is cancelled; the agent gets the rejection as context. | | `EXPIRED` | 24-hour TTL elapsed without a decision. The call is treated as a rejection. | Approvals are surfaced in chat where the conversation is happening — a Coworker chat, a Slack thread, or a Teams thread. They can also be granted without a Pinkfish login when the approval is configured to `allowPublicAccess`. Approvals are most useful for destructive or sensitive actions — paid calls to external APIs, production writes, outbound email. Approvals are configured per-tool at the platform level (and on workflow nodes, for workflows that are attached as tools). The Tools tab lets you *pick* the tools; the approval behavior is inherited from each tool's settings. ## Connections — how the agent picks one If your organization has multiple accounts connected for the same integration (e.g. a personal Gmail and a team Gmail), the agent needs to know which one to use. * For integrations that belong to *a single user*, the agent uses **your** connection when you're the one chatting with it. When another user chats with the same agent, it uses theirs. Integrations are **not** shared across accounts — this is why sharing an agent doesn't hand out your OAuth tokens. * For integrations that belong to *an org-level account*, everyone who has access to the agent uses the same connection. Missing a connection? The agent will report that the tool isn't authenticated; you'll be prompted to connect the integration before continuing. ## Related * [MCPs](/agents/mcps) — how agents discover and call MCP tools. * [Resources tab](/agents/resources) — data the agent can read and write (separate from Tools). * [API connections](/tools/connections) — the integrations that feed the Connections section. * [Agent Management API](/api-reference/platform/agent-management) — programmatic tool configuration. # Async Polling Source: https://docs.pinkfish.ai/api-reference/async-polling How to trigger a workflow asynchronously and poll for results ## Async Polling When your workflow takes more than a few seconds to complete, use the async pattern: fire the trigger, then poll for status and retrieve results when done. This is the recommended approach for integrations that need to programmatically retrieve workflow results. ## How It Works Call the trigger endpoint with `x-api-wait: false` (or omit the header entirely). The API returns immediately with an empty body. Two response headers contain the IDs you need for polling: * `X-Pf-Run-Id`: The unique identifier for this workflow run * `X-Pf-Automation-Id`: The automation/workflow ID ```bash theme={null} curl -s -i --location 'https://triggers.app.pinkfish.ai/ext/triggers/YOUR_TRIGGER_ID' \ --header 'Content-Type: application/json' \ --header 'X-API-KEY: YOUR_API_KEY' \ --header 'x-api-wait: false' \ --data '{"user_request": "process this data"}' ``` **Response headers:** ``` X-Pf-Run-Id: 1778786207851669420 X-Pf-Automation-Id: d831ue4rccbc73knbi80 ``` Check the status endpoint until the workflow completes. Poll every 2-5 seconds for typical workflows. Polling endpoints always use the webhook-style URL format (`/ext/webhook/{apiKey}/...`) — even if you triggered the workflow using the API endpoint with `X-API-KEY` header authentication. ```bash theme={null} curl -s 'https://triggers.app.pinkfish.ai/ext/webhook/YOUR_API_KEY/runs/AUTOMATION_ID/RUN_ID/status' ``` **Response:** ```json theme={null} { "automationId": "d831ue4rccbc73knbi80", "runId": "1778786207851669420", "status": "COMPLETE", "stepStatus": { "1": "COMPLETE" }, "stepInfo": { "1": { "status": "COMPLETE", "name": "Step 1", "executionOrder": 1 } } } ``` **Status values:** | Status | Meaning | | - | - | | `PENDING` | Workflow is queued but not yet started | | `RUNNING` | Workflow is currently executing | | `PAUSED` | Workflow is suspended at a durable wait (a delay, a timer, or an approval) and will resume on its own — this is **not** a terminal status, so keep polling | | `COMPLETE` | Workflow completed successfully | | `FAILED` | Workflow failed with an error | | `TIMEOUT` | Workflow exceeded execution time limit | Once the status is `COMPLETE`, retrieve the full results: ```bash theme={null} curl -s 'https://triggers.app.pinkfish.ai/ext/webhook/YOUR_API_KEY/runs/AUTOMATION_ID/RUN_ID/results' ``` **Response:** ```json theme={null} { "automationId": "d831ue4rccbc73knbi80", "automationVersion": 3, "automationName": "Hello World", "id": "1778786207851669420", "type": "TRIGGER", "results": [ { "stepIndex": 1, "stepVersion": 3, "resultUrls": { "output.txt": { "url": "https://run-files.app.pinkfish.ai/...", "mimeType": "text/plain", "size": 13 }, "stdout.txt": { "url": "https://run-files.app.pinkfish.ai/...", "mimeType": "text/plain", "size": 419 } }, "exitCode": 0, "duration": 2264 } ], "started": "2026-05-14T19:16:47Z", "status": "COMPLETE" } ``` ## Complete Examples ### Bash ```bash theme={null} #!/bin/bash API_KEY="YOUR_API_KEY" TRIGGER_ID="YOUR_TRIGGER_ID" # Step 1: Fire the trigger RESPONSE=$(curl -s -i --location "https://triggers.app.pinkfish.ai/ext/triggers/$TRIGGER_ID" \ --header 'Content-Type: application/json' \ --header "X-API-KEY: $API_KEY" \ --header 'x-api-wait: false' \ --data '{"user_request": "process this data"}') # Step 2: Extract IDs from response headers RUN_ID=$(echo "$RESPONSE" | grep -i "X-Pf-Run-Id" | cut -d' ' -f2 | tr -d '\r') AUTOMATION_ID=$(echo "$RESPONSE" | grep -i "X-Pf-Automation-Id" | cut -d' ' -f2 | tr -d '\r') echo "Run ID: $RUN_ID" echo "Automation ID: $AUTOMATION_ID" # Step 3: Poll for status while true; do STATUS_RESPONSE=$(curl -s "https://triggers.app.pinkfish.ai/ext/webhook/$API_KEY/runs/$AUTOMATION_ID/$RUN_ID/status") STATUS=$(echo "$STATUS_RESPONSE" | jq -r '.status') if [ "$STATUS" = "COMPLETE" ]; then echo "Workflow completed!" break elif [ "$STATUS" = "FAILED" ] || [ "$STATUS" = "TIMEOUT" ]; then echo "Workflow ended with status: $STATUS" exit 1 fi echo "Status: $STATUS, waiting..." sleep 3 done # Step 4: Fetch results RESULTS=$(curl -s "https://triggers.app.pinkfish.ai/ext/webhook/$API_KEY/runs/$AUTOMATION_ID/$RUN_ID/results") echo "$RESULTS" | jq '.' ``` ### JavaScript / TypeScript ```javascript theme={null} const API_KEY = "YOUR_API_KEY"; const TRIGGER_ID = "YOUR_TRIGGER_ID"; const BASE = "https://triggers.app.pinkfish.ai"; async function triggerAndPoll(payload) { // Step 1: Fire the trigger const res = await fetch(`${BASE}/ext/triggers/${TRIGGER_ID}`, { method: "POST", headers: { "Content-Type": "application/json", "X-API-KEY": API_KEY, "x-api-wait": "false", }, body: JSON.stringify(payload), }); const runId = res.headers.get("X-Pf-Run-Id"); const automationId = res.headers.get("X-Pf-Automation-Id"); // Step 2: Poll for status while (true) { const statusRes = await fetch( `${BASE}/ext/webhook/${API_KEY}/runs/${automationId}/${runId}/status` ); const { status } = await statusRes.json(); if (status === "COMPLETE") break; if (status === "FAILED" || status === "TIMEOUT") { throw new Error(`Workflow ended with status: ${status}`); } await new Promise((r) => setTimeout(r, 3000)); } // Step 3: Fetch results const resultsRes = await fetch( `${BASE}/ext/webhook/${API_KEY}/runs/${automationId}/${runId}/results` ); return resultsRes.json(); } const results = await triggerAndPoll({ user_request: "process this data" }); console.log(results); ``` ### Python ```python theme={null} import requests import time API_KEY = "YOUR_API_KEY" TRIGGER_ID = "YOUR_TRIGGER_ID" BASE = "https://triggers.app.pinkfish.ai" def trigger_and_poll(payload): # Step 1: Fire the trigger res = requests.post( f"{BASE}/ext/triggers/{TRIGGER_ID}", headers={ "Content-Type": "application/json", "X-API-KEY": API_KEY, "x-api-wait": "false", }, json=payload, ) run_id = res.headers["X-Pf-Run-Id"] automation_id = res.headers["X-Pf-Automation-Id"] # Step 2: Poll for status while True: status_res = requests.get( f"{BASE}/ext/webhook/{API_KEY}/runs/{automation_id}/{run_id}/status" ) status = status_res.json()["status"] if status == "COMPLETE": break if status in ("FAILED", "TIMEOUT"): raise Exception(f"Workflow ended with status: {status}") time.sleep(3) # Step 3: Fetch results results_res = requests.get( f"{BASE}/ext/webhook/{API_KEY}/runs/{automation_id}/{run_id}/results" ) return results_res.json() results = trigger_and_poll({"user_request": "process this data"}) print(results) ``` ## Designated Output If your trigger has a designated output configured, the results response includes a top-level `designatedOutput` field with a direct link to the output file: ```json theme={null} { "id": "1773184744204578408", "status": "COMPLETE", "results": [ ... ], "designatedOutput": { "url": "https://run-files.app.pinkfish.ai/...", "fileName": "retrieved-poem.txt", "mimeType": "text/plain", "size": 117 } } ``` To download just the designated output: ```bash theme={null} RESULTS=$(curl -s "https://triggers.app.pinkfish.ai/ext/webhook/YOUR_API_KEY/runs/$AUTOMATION_ID/$RUN_ID/results") DESIGNATED_URL=$(echo "$RESULTS" | jq -r '.designatedOutput.url // empty') if [ -n "$DESIGNATED_URL" ]; then curl -s "$DESIGNATED_URL" fi ``` ## Best Practices * **Poll interval**: Every 2-5 seconds for most workflows. For long-running workflows, poll every 10-30 seconds. * **Set a timeout**: Add a maximum polling duration to avoid infinite loops in production. * **Handle errors**: Always check for `FAILED` and `TIMEOUT` statuses in your polling loop. * **Use step status**: The `stepStatus` field in the status response lets you track progress of multi-step workflows while they run. # File Attachments Source: https://docs.pinkfish.ai/api-reference/attachments How to send file attachments with API triggers ## File Attachments API triggers support file attachments using `multipart/form-data`. Attachments are stored in S3 and made available to your workflow via signed URLs in the inputs. ## Supported Content Types API triggers support the following content types: * **application/json**: JSON payload with structured data * **application/x-www-form-urlencoded**: Form-encoded data (key-value pairs) * **multipart/form-data**: Form data with file attachments (API triggers only) **Note**: Webhook triggers support JSON and form-encoded data only. File attachments are not supported for webhook triggers. ## Limits * Maximum 25MB per file * Maximum 100MB total across all attachments * Maximum 20 files per request * Executable files and scripts are blocked for security ## Example Requests ### Single File Attachment ``` curl --location 'https://triggers.app.pinkfish.ai/ext/triggers/YOUR_WORKFLOW_ID' \ --header 'X-API-KEY: YOUR_API_KEY' \ --form 'description="Process this document"' \ --form 'file=@"/path/to/document.pdf"' ``` ### Multiple File Attachments ``` curl --location 'https://triggers.app.pinkfish.ai/ext/triggers/YOUR_WORKFLOW_ID' \ --header 'X-API-KEY: YOUR_API_KEY' \ --form 'action="process"' \ --form 'files=@"/path/to/file1.pdf"' \ --form 'files=@"/path/to/file2.jpg"' \ --form 'metadata="{\"priority\": \"high\"}"' ``` ### Using JavaScript/Node.js ```javascript theme={null} const FormData = require('form-data'); const fs = require('fs'); const form = new FormData(); form.append('description', 'Process this document'); form.append('file', fs.createReadStream('/path/to/document.pdf')); const response = await fetch('https://triggers.app.pinkfish.ai/ext/triggers/YOUR_WORKFLOW_ID', { method: 'POST', headers: { 'X-API-KEY': 'YOUR_API_KEY', ...form.getHeaders() }, body: form }); ``` ### Using Python ```python theme={null} import requests url = 'https://triggers.app.pinkfish.ai/ext/triggers/YOUR_WORKFLOW_ID' headers = {'X-API-KEY': 'YOUR_API_KEY'} files = [ ('file', ('document.pdf', open('/path/to/document.pdf', 'rb'), 'application/pdf')) ] data = {'description': 'Process this document'} response = requests.post(url, headers=headers, files=files, data=data) ``` ## Accessing Attachments in Your Workflow Attachments are available in your workflow inputs as an array. Each attachment includes: * `filename`: The sanitized filename (path components removed, special characters sanitized) * `contentType`: The MIME type of the file * `size`: File size in bytes * `url`: A signed URL to download the file from S3 (valid for 24 hours) ### Example Inputs Structure ```json theme={null} { "description": "Process this document", "attachments": [ { "filename": "document.pdf", "contentType": "application/pdf", "size": 245678, "url": "https://s3.amazonaws.com/..." } ] } ``` ### Using Attachments in Code Steps You can access attachments in your workflow code: ```javascript theme={null} // Get the first attachment URL const attachmentUrl = @workflow.inputs.attachments[0].url; // Download the file const response = await fetch(attachmentUrl); const fileData = await response.arrayBuffer(); // Process the file // ... ``` ### Using Attachments with Tools You can pass attachment URLs directly to any tool that accepts a file URL: ```javascript theme={null} // Pass attachment URL to PDF processing const pdfUrl = @workflow.inputs.attachments[0].url; // Hand the URL to a document-processing tool ``` ## Security Considerations * Executable files (`.exe`, `.sh`, `.bat`, etc.) are automatically blocked * Filenames are sanitized to prevent path traversal attacks * Files are stored in isolated S3 buckets per run * Signed URLs expire after 24 hours * File size limits prevent abuse ## Troubleshooting ### "Too many attachments" Error You've exceeded the 20 file limit. Split your request into multiple API calls. ### "File too large" Error Individual files cannot exceed 25MB. Compress or split large files before uploading. ### "Total attachment size exceeds limit" Error The combined size of all attachments exceeds 100MB. Reduce the number or size of files. ### "Blocked file type" Error The file type you're trying to upload is blocked for security reasons. Executable files and scripts are not allowed. ### Attachments Not Appearing in Workflow * Ensure you're using `multipart/form-data` content type * Check that you're using an API trigger (not a webhook trigger) * Verify the files were uploaded successfully (check the run inputs in the Runs Monitor) # Trigger a workflow Source: https://docs.pinkfish.ai/api-reference/endpoint/trigger-an-automation post /ext/triggers/{triggerId} Executes a workflow using its associated trigger. Supports two execution modes: - **Asynchronous** (default): Set `x-api-wait: false` or omit the header. Returns immediately with an empty (`null`) response body. The workflow run ID is returned in the `X-Pf-Run-Id` response header — use it to [poll for results](/api-reference/async-polling). - **Synchronous**: Set `x-api-wait: true`. Waits up to 60 seconds for the workflow to complete. If it finishes in time, the response body contains the full results. If it times out, returns a timeout message with the run ID. # Trigger a workflow via webhook Source: https://docs.pinkfish.ai/api-reference/endpoint/webhook-trigger post /ext/webhook/{apiKey}/triggers/{triggerId} Executes a workflow using a webhook URL with the API key embedded in the path. Designed for third-party services that cannot set custom headers (Slack, Discord, Linear, Zoom, etc.). Supports the same two execution modes as the API trigger: - **Asynchronous** (default): Returns immediately with an empty (`null`) response body. Use `X-Pf-Run-Id` and `X-Pf-Automation-Id` response headers to [poll for results](/api-reference/async-polling). - **Synchronous**: Set `x-api-wait: true`. Waits up to 60 seconds for results. **Note**: Webhook triggers support JSON and form-encoded data only. File attachments are not supported. # Triggers API Source: https://docs.pinkfish.ai/api-reference/introduction API reference for Pinkfish Triggers ## Triggers API This API enables you to execute Pinkfish workflows that you've created and published. With these "trigger" endpoints, you can integrate automated workflows into your applications and systems. You can also trigger one workflow from another workflow - thereby chaining workflows together. ## Key Concepts * **Workflow**: A series of steps that perform a specific task or workflow. * **Trigger**: A mechanism to initiate a workflow via API call. You must set up a trigger in order to call your workflow by API. * **Run**: An instance of a workflow being executed. ## Execution Models You can also run workflows and poll for results via the **Pinkfish Sidekick MCP server** using the [`workflow_run`](/api-reference/mcp-servers/embedded/pinkfish-sidekick#workflow_run), [`workflow_run_status`](/api-reference/mcp-servers/embedded/pinkfish-sidekick#workflow_run_status), and [`workflow_results`](/api-reference/mcp-servers/embedded/pinkfish-sidekick#workflow_results) tools. The MCP tools handle polling automatically. Our API supports two execution models: ### Asynchronous (Fire and Forget) When you create a trigger for your workflow, you get two options: 1. **API Trigger Endpoint**: Use this with the API key in the header (`X-API-KEY`) * Format: `https://triggers.app.pinkfish.ai/ext/triggers/{triggerId}` * Requires API key in request headers * Best for server-to-server integrations 2. **Webhook URL**: Use this for 3rd party services that can't set custom headers * Format: `https://triggers.app.pinkfish.ai/ext/webhook/{apiKey}/triggers/{triggerId}` * API key is embedded in the URL path for authentication * Best for services like Slack, Discord, Linear, Zoom, and other webhook-based integrations Both options: * Return immediately with a runId in the response header * Run the workflow asynchronously in the background * Don't return results directly via the API call * Are best for long-running workflows or when immediate response isn't required ### Synchronous (Wait for Result) * When you call a workflow trigger with `x-api-wait: true`, the API waits for up to 60 seconds for completion * If the workflow completes within this window, the response body contains the results * If the workflow is still running when the window closes, the call returns **`202 Accepted`** with a `Retry-After` header and a handle (`runId`, `statusUrl`, `resultsUrl`) — the run keeps going, and you poll those URLs for the answer * Best for quick workflows where you need immediate results To view the outcome of a workflow run (especially for async calls or timeouts), you have several options: 1. **Poll for results programmatically** (recommended for integrations). See the [Async Polling](/api-reference/async-polling) guide for complete examples in Bash, JavaScript, and Python. 2. Check the effects of the workflow (e.g., a created Google Doc or message to Slack). This is entirely up to you to devise. 3. Load the workflow in the platform UI (you will see results from the last run). Warning: if you have edited your workflow since your last publish, you won't see results here. 4. Use the Runs Monitor in the platform to view execution status and results. This is the most reliable and simple method. ## Authentication All trigger API endpoints are authenticated using API keys. * **API trigger endpoint** (`/ext/triggers/{triggerId}`): include the API key in the `X-API-KEY` header * **Webhook endpoint and polling endpoints** (`/ext/webhook/{apiKey}/...`): API key is embedded in the URL path For header-based authentication: ``` X-API-KEY: YOUR_API_KEY_HERE ``` You can generate API keys in two ways: 1. In the Library section of the platform interface. 2. While setting up a trigger for a workflow. ## Triggering Workflows Workflows are executed by calling their associated triggers. Each trigger has a unique endpoint and may accept parameters either as query parameters (for GET requests), as form-encoded data, as a json payload, or as multipart/form-data (with file attachments). Set up your trigger(s) in the Workflow editor (requires first publishing a version of your workflow) ### Supported Content Types API triggers support the following content types: * **application/json**: JSON payload with structured data * **application/x-www-form-urlencoded**: Form-encoded data (key-value pairs) * **multipart/form-data**: Form data with file attachments (API triggers only) **Note**: Webhook triggers support JSON and form-encoded data only. File attachments are not supported for webhook triggers. ## Example Requests ### Asynchronous Request (Form-encoded) ``` curl --location 'https://triggers.app.pinkfish.ai/ext/triggers/YOUR_TRIGGER_ID' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'X-API-KEY: YOUR_API_KEY' \ --header 'x-api-wait: false' \ --data-urlencode 'Hello=World' ``` ### Synchronous Request (JSON) ``` curl --location 'https://triggers.app.pinkfish.ai/ext/triggers/YOUR_TRIGGER_ID' \ --header 'Content-Type: application/json' \ --header 'X-API-KEY: YOUR_API_KEY' \ --header 'x-api-wait: true' \ --data '{ "user_request": "what is the capital of France" }' ``` ### Request with File Attachments (Multipart) API triggers support file attachments using `multipart/form-data`. Attachments are stored in S3 and made available to your workflow via signed URLs in the inputs. **Limits:** * Maximum 25MB per file * Maximum 100MB total across all attachments * Maximum 20 files per request * Executable files and scripts are blocked for security **Example with single file:** ``` curl --location 'https://triggers.app.pinkfish.ai/ext/triggers/YOUR_TRIGGER_ID' \ --header 'X-API-KEY: YOUR_API_KEY' \ --form 'description="Process this document"' \ --form 'file=@"/path/to/document.pdf"' ``` **Example with multiple files:** ``` curl --location 'https://triggers.app.pinkfish.ai/ext/triggers/YOUR_TRIGGER_ID' \ --header 'X-API-KEY: YOUR_API_KEY' \ --form 'action="process"' \ --form 'files=@"/path/to/file1.pdf"' \ --form 'files=@"/path/to/file2.jpg"' \ --form 'metadata="{\"priority\": \"high\"}"' ``` **Accessing attachments in your workflow:** Attachments are available in your workflow inputs as an array. Each attachment includes: * `filename`: The sanitized filename (path components removed, special characters sanitized) * `contentType`: The MIME type of the file * `size`: File size in bytes * `url`: A signed URL to download the file from S3 (valid for 24 hours) Example inputs structure: ```json theme={null} { "description": "Process this document", "attachments": [ { "filename": "document.pdf", "contentType": "application/pdf", "size": 245678, "url": "https://s3.amazonaws.com/..." } ] } ``` **Note**: File attachments are only supported for API triggers (not webhook triggers). Webhook triggers continue to support JSON and form-encoded data only. ## Example Responses ### Asynchronous Response The response body will be null. You can find your runId in the header as `X-Pf-Run-Id`. ``` Response Headers Date: Wed, 18 Sep 2024 02:12:39 GMT Content-Type: application/json Content-Length: 0 Connection: keep-alive x-amzn-RequestId: eea7315a-f8c2-4c55-88df-50f8332bf25e Access-Control-Allow-Origin: * Access-Control-Allow-Headers: Content-Type, Authorization X-Pf-Automation-Id: crkbpb5b9nas7163a4kg x-amz-apigw-id: eR2LpEkBPHcEK9w= Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS X-Amzn-Trace-Id: Root=1-66ea3717-03397efa60d2632525a8fe5f X-Pf-Run-Id: 1726625559774364090 Response Body null ``` ### Synchronous Response (Successful) If the workflow completes within 60 seconds, you'll receive the results in the response body: ``` { "automationId": "csrtvshm36rc711dhoqg", "automationVersion": 1, "automationName": "Hello Triggers", "id": "1731715310692281375", "type": "TRIGGER", "stepMap": { "1": 2, "2": 2 }, "inputs": "", "triggerId": "csru0bg3tgfs71020ssg", "results": [ { "stepIndex": 1, "stepVersion": 2, "result": { "stepIndex": 1, "resultType": "markdown", "result": "# Hello from step 1! 👋" }, "exitCode": 0, "duration": 790 }, { "stepIndex": 2, "stepVersion": 2, "result": { "stepIndex": 2, "resultType": "plaintext", "result": "Hello from step 2!" }, "exitCode": 0, "duration": 707 } ], "started": "2024-11-16T00:01:50Z", "startedBy": "588233679836" } ``` ### Synchronous Response (Still Running) If the workflow hasn't finished when the wait window closes, the run is **not** cancelled. You get a `202 Accepted` with a handle you can poll: ``` Response Status 202 Accepted Response Headers Retry-After: 5 Response Body { "runId": "run_abc123", "automationId": "auto_xyz789", "status": "RUNNING", "statusUrl": "/ext/webhook/{apiKey}/runs/{automationId}/{runId}/status", "resultsUrl": "/ext/webhook/{apiKey}/runs/{automationId}/{runId}/results", "retryAfterSeconds": 5 } ``` Wait `retryAfterSeconds`, then poll `statusUrl` until the run reaches a terminal status, and fetch `resultsUrl`. See [Async Polling](/api-reference/async-polling). ## Webhook Triggers Webhook triggers provide an alternative way to execute workflows when working with third-party services that cannot set custom headers (like Slack, Discord, Linear, Zoom, etc.). **Note**: Webhook triggers support JSON and form-encoded data only. File attachments (multipart/form-data) are not supported for webhook triggers. Use API triggers if you need to send file attachments. ### Webhook URL Format ``` https://triggers.app.pinkfish.ai/ext/webhook/{apiKey}/triggers/{triggerId} ``` ### Key Differences from API Triggers | Feature | API Trigger | Webhook Trigger | | - | - | - | | Authentication | API key in `X-API-KEY` header | API key embedded in URL path | | URL Format | `/ext/triggers/{triggerId}` | `/ext/webhook/{apiKey}/triggers/{triggerId}` | | Content Types | JSON, form-encoded, multipart | JSON, form-encoded only | | File Attachments | ✅ Supported (multipart) | ❌ Not supported | | Use Case | Server-to-server integrations | Third-party services with webhook support | | Security | More secure (key in headers) | Less secure (key visible in URL) | ### Example Webhook Request ``` POST https://triggers.app.pinkfish.ai/ext/webhook/L2wOL4e7yr6G3Us5LKqHa1BLuhMIW5iR1vAqwFga/triggers/d1a49cl8hlvc714q38e0 Content-Type: application/json { "event": "issue_created", "issue_id": "12345", "title": "New feature request" } ``` ### Security Considerations Since the API key is embedded in the webhook URL: * Treat webhook URLs as sensitive credentials * Only share with trusted third-party services * Consider rotating API keys periodically * Monitor webhook usage in the Runs Monitor ### Common Webhook Integrations * **Slack**: Use in Slack workflows or slash commands * **Discord**: Set up bot commands or server events * **Linear**: Trigger workflows on issue updates * **Zoom**: Execute workflows from Zoom apps * **GitHub**: Run workflows on repository events * **Stripe**: Process payment events ## Getting Started To begin using the AI Workflow API, you'll need to: 1. Create and publish a workflow using our platform. 2. Set up a trigger for your workflow. 3. Generate an API key from either the Library section or during trigger setup. 4. Choose your execution model (sync or async) based on your workflow's expected runtime and your application's needs. 5. Use the provided trigger endpoint to execute your workflow, including your API key and preferred wait setting in the request headers. # 2chat Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/2chat 2Chat Messaging **Server path:** `/2chat` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`2chat_check_whatsapp_number`](#2chat_check_whatsapp_number) | Check if a number is on WhatsApp | | [`2chat_create_contact`](#2chat_create_contact) | Create a contact | | [`2chat_delete_contact`](#2chat_delete_contact) | Delete a contact | | [`2chat_execute_whatsapp_channel_command`](#2chat_execute_whatsapp_channel_command) | Execute command on a WhatsApp channel | | [`2chat_get_account_info`](#2chat_get_account_info) | Get account information | | [`2chat_get_call_details`](#2chat_get_call_details) | Get call details | | [`2chat_get_call_history`](#2chat_get_call_history) | Get call history | | [`2chat_get_contact`](#2chat_get_contact) | Get a contact | | [`2chat_get_estimated_call_price`](#2chat_get_estimated_call_price) | Get estimated call price | | [`2chat_get_waba_number`](#2chat_get_waba_number) | Get WABA number details | | [`2chat_get_waba_templates`](#2chat_get_waba_templates) | Get WABA message templates | | [`2chat_get_whatsapp_conversation_messages`](#2chat_get_whatsapp_conversation_messages) | Get messages for a specific conversation | | [`2chat_get_whatsapp_group_messages`](#2chat_get_whatsapp_group_messages) | Get group messages | | [`2chat_get_whatsapp_group_participants`](#2chat_get_whatsapp_group_participants) | List group participants | | [`2chat_get_whatsapp_messages`](#2chat_get_whatsapp_messages) | Get WhatsApp messages for a number | | [`2chat_get_whatsapp_number`](#2chat_get_whatsapp_number) | Get WhatsApp number details | | [`2chat_list_account_users`](#2chat_list_account_users) | List account users | | [`2chat_list_contacts`](#2chat_list_contacts) | List contacts | | [`2chat_list_virtual_numbers`](#2chat_list_virtual_numbers) | List virtual phone numbers | | [`2chat_list_whatsapp_catalog_products`](#2chat_list_whatsapp_catalog_products) | List catalog products | | [`2chat_list_whatsapp_conversations`](#2chat_list_whatsapp_conversations) | List WhatsApp conversations | | [`2chat_list_whatsapp_groups`](#2chat_list_whatsapp_groups) | List WhatsApp groups | | [`2chat_list_whatsapp_numbers`](#2chat_list_whatsapp_numbers) | List connected WhatsApp numbers | | [`2chat_search_contacts`](#2chat_search_contacts) | Search contacts | | [`2chat_send_sms`](#2chat_send_sms) | Send an SMS message | | [`2chat_send_waba_message`](#2chat_send_waba_message) | Send a WABA message | | [`2chat_send_whatsapp_message`](#2chat_send_whatsapp_message) | Send a WhatsApp message | | [`2chat_set_whatsapp_image_status`](#2chat_set_whatsapp_image_status) | Set WhatsApp image status | | [`2chat_set_whatsapp_text_status`](#2chat_set_whatsapp_text_status) | Set WhatsApp text status | | [`2chat_set_whatsapp_video_status`](#2chat_set_whatsapp_video_status) | Set WhatsApp video status | | [`2chat_sync_waba_templates`](#2chat_sync_waba_templates) | Sync WABA templates from Meta | | [`2chat_update_contact`](#2chat_update_contact) | Update a contact | *** ## 2chat\_check\_whatsapp\_number Check if a number is on WhatsApp **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `your_number` | string | Yes | — | Your connected WhatsApp number in international format | | `number_to_check` | string | Yes | — | The phone number to check in international format | | `extra-information` | boolean | No | — | Include extra profile information if available | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "your_number": { "type": "string", "description": "Your connected WhatsApp number in international format" }, "number_to_check": { "type": "string", "description": "The phone number to check in international format" }, "extra-information": { "type": "boolean", "description": "Include extra profile information if available" } }, "required": [ "PCID", "your_number", "number_to_check" ] } ``` *** ## 2chat\_create\_contact Create a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `channel_uuid` | string | No | — | UUID of the channel to associate the contact with | | `contact_detail` | object\[] | Yes | — | Contact details array. Each item has type (E=Email, A=Address, PH=Phone, WAPH=WhatsApp Phone) and value. | | `first_name` | string | Yes | — | Contact's first name | | `last_name` | string | No | — | Contact's last name | | `profile_pic_url` | string | No | — | URL to the contact's profile picture | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "channel_uuid": { "type": "string", "description": "UUID of the channel to associate the contact with" }, "contact_detail": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "E", "A", "PH", "WAPH" ], "description": "Detail type: E=Email, A=Address, PH=Phone, WAPH=WhatsApp Phone" }, "value": { "type": "string", "description": "The detail value" } } }, "description": "Contact details array. Each item has type (E=Email, A=Address, PH=Phone, WAPH=WhatsApp Phone) and value." }, "first_name": { "type": "string", "description": "Contact's first name" }, "last_name": { "type": "string", "description": "Contact's last name" }, "profile_pic_url": { "type": "string", "description": "URL to the contact's profile picture" } }, "required": [ "PCID", "contact_detail", "first_name" ] } ``` *** ## 2chat\_delete\_contact Delete a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contact_uuid` | string | Yes | — | UUID of the contact | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contact_uuid": { "type": "string", "description": "UUID of the contact" } }, "required": [ "PCID", "contact_uuid" ] } ``` *** ## 2chat\_execute\_whatsapp\_channel\_command Execute command on a WhatsApp channel **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `channel_uuid` | string | Yes | — | UUID of the WhatsApp channel | | `command` | string | Yes | — | Command to execute on the channel | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "channel_uuid": { "type": "string", "description": "UUID of the WhatsApp channel" }, "command": { "type": "string", "description": "Command to execute on the channel", "enum": [ "connect", "disconnect" ] } }, "required": [ "PCID", "channel_uuid", "command" ] } ``` *** ## 2chat\_get\_account\_info Get account information ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## 2chat\_get\_call\_details Get call details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `call_uuid` | string | Yes | — | UUID of the call record (format: CDR\{uuid}) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "call_uuid": { "type": "string", "description": "UUID of the call record (format: CDR{uuid})" } }, "required": [ "PCID", "call_uuid" ] } ``` *** ## 2chat\_get\_call\_history Get call history **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page_number` | integer | No | — | Page number for pagination | | `direction` | string | No | — | Filter by call direction | | `to_number` | string | No | — | Filter by destination number | | `from_number` | string | No | — | Filter by source number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page_number": { "type": "integer", "description": "Page number for pagination" }, "direction": { "type": "string", "description": "Filter by call direction", "enum": [ "inbound", "outbound" ] }, "to_number": { "type": "string", "description": "Filter by destination number" }, "from_number": { "type": "string", "description": "Filter by source number" } }, "required": [ "PCID" ] } ``` *** ## 2chat\_get\_contact Get a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contact_uuid` | string | Yes | — | UUID of the contact | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contact_uuid": { "type": "string", "description": "UUID of the contact" } }, "required": [ "PCID", "contact_uuid" ] } ``` *** ## 2chat\_get\_estimated\_call\_price Get estimated call price **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `phone_number` | string | Yes | — | Destination phone number in international format | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "phone_number": { "type": "string", "description": "Destination phone number in international format" } }, "required": [ "PCID", "phone_number" ] } ``` *** ## 2chat\_get\_waba\_number Get WABA number details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `waba_uuid` | string | Yes | — | UUID of the WABA number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "waba_uuid": { "type": "string", "description": "UUID of the WABA number" } }, "required": [ "PCID", "waba_uuid" ] } ``` *** ## 2chat\_get\_waba\_templates Get WABA message templates **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `phone_number` | string | Yes | — | Your WABA phone number in international format | | `page` | integer | No | — | Page number (0-based) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "phone_number": { "type": "string", "description": "Your WABA phone number in international format" }, "page": { "type": "integer", "description": "Page number (0-based)" } }, "required": [ "PCID", "phone_number" ] } ``` *** ## 2chat\_get\_whatsapp\_conversation\_messages Get messages for a specific conversation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `your_number` | string | Yes | — | Your connected WhatsApp number in international format | | `remote_number` | string | Yes | — | The remote phone number in international format | | `page_number` | integer | No | — | Page number for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "your_number": { "type": "string", "description": "Your connected WhatsApp number in international format" }, "remote_number": { "type": "string", "description": "The remote phone number in international format" }, "page_number": { "type": "integer", "description": "Page number for pagination" } }, "required": [ "PCID", "your_number", "remote_number" ] } ``` *** ## 2chat\_get\_whatsapp\_group\_messages Get group messages **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `group_uuid` | string | Yes | — | UUID of the WhatsApp group | | `page_number` | integer | No | — | Page number for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "group_uuid": { "type": "string", "description": "UUID of the WhatsApp group" }, "page_number": { "type": "integer", "description": "Page number for pagination" } }, "required": [ "PCID", "group_uuid" ] } ``` *** ## 2chat\_get\_whatsapp\_group\_participants List group participants **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `group_uuid` | string | Yes | — | UUID of the WhatsApp group | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "group_uuid": { "type": "string", "description": "UUID of the WhatsApp group" } }, "required": [ "PCID", "group_uuid" ] } ``` *** ## 2chat\_get\_whatsapp\_messages Get WhatsApp messages for a number **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `your_number` | string | Yes | — | Your connected WhatsApp number in international format | | `page_number` | integer | No | — | Page number for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "your_number": { "type": "string", "description": "Your connected WhatsApp number in international format" }, "page_number": { "type": "integer", "description": "Page number for pagination" } }, "required": [ "PCID", "your_number" ] } ``` *** ## 2chat\_get\_whatsapp\_number Get WhatsApp number details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `channel_uuid` | string | Yes | — | UUID of the WhatsApp channel | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "channel_uuid": { "type": "string", "description": "UUID of the WhatsApp channel" } }, "required": [ "PCID", "channel_uuid" ] } ``` *** ## 2chat\_list\_account\_users List account users ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## 2chat\_list\_contacts List contacts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `channel_uuid` | string | No | — | Filter contacts by channel UUID | | `results_per_page` | integer | No | — | Number of results per page (1-100) | | `page_number` | integer | No | — | Page number for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "channel_uuid": { "type": "string", "description": "Filter contacts by channel UUID" }, "results_per_page": { "type": "integer", "description": "Number of results per page (1-100)" }, "page_number": { "type": "integer", "description": "Page number for pagination" } }, "required": [ "PCID" ] } ``` *** ## 2chat\_list\_virtual\_numbers List virtual phone numbers **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page_number` | integer | No | — | Page number for pagination | | `results_per_page` | integer | No | — | Number of results per page (default 50) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page_number": { "type": "integer", "description": "Page number for pagination" }, "results_per_page": { "type": "integer", "description": "Number of results per page (default 50)" } }, "required": [ "PCID" ] } ``` *** ## 2chat\_list\_whatsapp\_catalog\_products List catalog products **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `from_number` | string | Yes | — | Your connected WhatsApp number in international format | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "from_number": { "type": "string", "description": "Your connected WhatsApp number in international format" } }, "required": [ "PCID", "from_number" ] } ``` *** ## 2chat\_list\_whatsapp\_conversations List WhatsApp conversations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `channel_uuid` | string | Yes | — | UUID of the WhatsApp channel | | `page_number` | integer | Yes | — | Page number for pagination | | `phone_number` | string | No | — | Filter conversations by phone number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "channel_uuid": { "type": "string", "description": "UUID of the WhatsApp channel" }, "page_number": { "type": "integer", "description": "Page number for pagination" }, "phone_number": { "type": "string", "description": "Filter conversations by phone number" } }, "required": [ "PCID", "channel_uuid", "page_number" ] } ``` *** ## 2chat\_list\_whatsapp\_groups List WhatsApp groups **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `phone_number` | string | Yes | — | Your connected WhatsApp number in international format | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "phone_number": { "type": "string", "description": "Your connected WhatsApp number in international format" } }, "required": [ "PCID", "phone_number" ] } ``` *** ## 2chat\_list\_whatsapp\_numbers List connected WhatsApp numbers **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page_number` | integer | No | — | Page number for pagination | | `results_per_page` | integer | No | — | Number of results per page (default 50) | | `status` | string | No | — | Filter by connection status | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page_number": { "type": "integer", "description": "Page number for pagination" }, "results_per_page": { "type": "integer", "description": "Number of results per page (default 50)" }, "status": { "type": "string", "description": "Filter by connection status", "enum": [ "connected", "disconnected", "all" ] } }, "required": [ "PCID" ] } ``` *** ## 2chat\_search\_contacts Search contacts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `query` | string | No | — | Search query string | | `channel_uuid` | string | No | — | Filter by channel UUID | | `results_per_page` | integer | No | — | Number of results per page (1-100) | | `page_number` | integer | No | — | Page number for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "Search query string" }, "channel_uuid": { "type": "string", "description": "Filter by channel UUID" }, "results_per_page": { "type": "integer", "description": "Number of results per page (1-100)" }, "page_number": { "type": "integer", "description": "Page number for pagination" } }, "required": [ "PCID" ] } ``` *** ## 2chat\_send\_sms Send an SMS message **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `from_number` | string | Yes | — | Your virtual phone number in E.164 format (e.g., +1234567890) | | `text` | string | Yes | — | SMS message text (max 160 characters per segment) | | `to_number` | string | Yes | — | Recipient phone number in E.164 format | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "from_number": { "type": "string", "description": "Your virtual phone number in E.164 format (e.g., +1234567890)" }, "text": { "type": "string", "description": "SMS message text (max 160 characters per segment)" }, "to_number": { "type": "string", "description": "Recipient phone number in E.164 format" } }, "required": [ "PCID", "from_number", "text", "to_number" ] } ``` *** ## 2chat\_send\_waba\_message Send a WABA message **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `from_number` | string | Yes | — | Your WABA phone number in international format | | `params` | object | No | — | Template parameters | | `template_uuid` | string | No | — | UUID of the message template to use (for template messages) | | `text` | string | No | — | Message text (for session messages within the 24-hour window) | | `to_number` | string | Yes | — | Recipient phone number in international format | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "from_number": { "type": "string", "description": "Your WABA phone number in international format" }, "params": { "type": "object", "description": "Template parameters", "properties": { "body": { "type": "array", "items": { "type": "string" }, "description": "Body parameter values for the template" }, "header": { "type": "string", "description": "Header parameter value" } } }, "template_uuid": { "type": "string", "description": "UUID of the message template to use (for template messages)" }, "text": { "type": "string", "description": "Message text (for session messages within the 24-hour window)" }, "to_number": { "type": "string", "description": "Recipient phone number in international format" } }, "required": [ "PCID", "from_number", "to_number" ] } ``` *** ## 2chat\_send\_whatsapp\_message Send a WhatsApp message **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `from_number` | string | Yes | — | Your connected WhatsApp number in international format (e.g., +1234567890) | | `text` | string | Yes | — | Message text content | | `to_group_uuid` | string | No | — | UUID of the WhatsApp group to send the message to. Use instead of to\_number for group messages. | | `to_number` | string | No | — | Recipient phone number in international format. Required if not sending to a group. | | `url` | string | No | — | URL of media file to attach (image, video, audio, or document) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "from_number": { "type": "string", "description": "Your connected WhatsApp number in international format (e.g., +1234567890)" }, "text": { "type": "string", "description": "Message text content" }, "to_group_uuid": { "type": "string", "description": "UUID of the WhatsApp group to send the message to. Use instead of to_number for group messages." }, "to_number": { "type": "string", "description": "Recipient phone number in international format. Required if not sending to a group." }, "url": { "type": "string", "description": "URL of media file to attach (image, video, audio, or document)" } }, "required": [ "PCID", "from_number", "text" ] } ``` *** ## 2chat\_set\_whatsapp\_image\_status Set WhatsApp image status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `number` | string | Yes | — | Your connected WhatsApp number in international format | | `image_url` | string | Yes | — | URL of the image to post as status | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "number": { "type": "string", "description": "Your connected WhatsApp number in international format" }, "image_url": { "type": "string", "description": "URL of the image to post as status" } }, "required": [ "PCID", "number", "image_url" ] } ``` *** ## 2chat\_set\_whatsapp\_text\_status Set WhatsApp text status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `number` | string | Yes | — | Your connected WhatsApp number in international format | | `params` | object | No | — | Optional styling parameters | | `text` | string | Yes | — | Text content for the status | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "number": { "type": "string", "description": "Your connected WhatsApp number in international format" }, "params": { "type": "object", "description": "Optional styling parameters", "properties": { "backgroundColor": { "type": "string", "description": "Background color in hex format (e.g., #FF5733)" }, "font": { "type": "integer", "description": "Font style index" } } }, "text": { "type": "string", "description": "Text content for the status" } }, "required": [ "PCID", "number", "text" ] } ``` *** ## 2chat\_set\_whatsapp\_video\_status Set WhatsApp video status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `number` | string | Yes | — | Your connected WhatsApp number in international format | | `video_url` | string | Yes | — | URL of the video to post as status | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "number": { "type": "string", "description": "Your connected WhatsApp number in international format" }, "video_url": { "type": "string", "description": "URL of the video to post as status" } }, "required": [ "PCID", "number", "video_url" ] } ``` *** ## 2chat\_sync\_waba\_templates Sync WABA templates from Meta **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `phone_number` | string | Yes | — | Your WABA phone number in international format | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "phone_number": { "type": "string", "description": "Your WABA phone number in international format" } }, "required": [ "PCID", "phone_number" ] } ``` *** ## 2chat\_update\_contact Update a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contact_uuid` | string | Yes | — | UUID of the contact | | `channel_uuid` | string | No | — | UUID of the channel to associate the contact with | | `first_name` | string | No | — | Contact's first name | | `last_name` | string | No | — | Contact's last name | | `profile_pic_url` | string | No | — | URL to the contact's profile picture | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contact_uuid": { "type": "string", "description": "UUID of the contact" }, "channel_uuid": { "type": "string", "description": "UUID of the channel to associate the contact with" }, "first_name": { "type": "string", "description": "Contact's first name" }, "last_name": { "type": "string", "description": "Contact's last name" }, "profile_pic_url": { "type": "string", "description": "URL to the contact's profile picture" } }, "required": [ "PCID", "contact_uuid" ] } ``` # abstract Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/abstract IP Intelligence API **Server path:** `/abstract` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`abstract_lookup_ip`](#abstract_lookup_ip) | Look up IP intelligence data | *** ## abstract\_lookup\_ip Look up IP intelligence data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ip_address` | string | No | — | IPv4 or IPv6 address to analyze. If omitted, the requester's IP is used. | | `fields` | string | No | — | Comma-separated list of top-level response fields to return (e.g. 'security,location,asn'). If omitted, all fields are returned. Available fields: ip\_address, security, asn, company, domains, location, timezone, flag, currency. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ip_address": { "type": "string", "description": "IPv4 or IPv6 address to analyze. If omitted, the requester's IP is used." }, "fields": { "type": "string", "description": "Comma-separated list of top-level response fields to return (e.g. 'security,location,asn'). If omitted, all fields are returned. Available fields: ip_address, security, asn, company, domains, location, timezone, flag, currency." } }, "required": [ "PCID" ] } ``` # abuseipdb Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/abuseipdb AbuseIPDB Threat Intelligence **Server path:** `/abuseipdb` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`abuseipdb_bulk_report`](#abuseipdb_bulk_report) | Submit abuse reports for multiple IP addresses via CSV data. Each line should contain: IP, categories, timestamp, and optional comment. | | [`abuseipdb_check_ip`](#abuseipdb_check_ip) | Check an IP address for abuse reports. Returns abuse confidence score, country, ISP, usage type, and recent report details. | | [`abuseipdb_check_subnet`](#abuseipdb_check_subnet) | Check a subnet (CIDR notation) for abuse reports. Returns aggregated abuse data for all IPs in the range. | | [`abuseipdb_clear_address`](#abuseipdb_clear_address) | Remove all reports your account has submitted for a specific IP address. This only removes your own reports, not reports from other users. | | [`abuseipdb_get_blacklist`](#abuseipdb_get_blacklist) | Download the AbuseIPDB blacklist of reported IP addresses. Returns IPs with the highest abuse confidence scores. | | [`abuseipdb_get_reports`](#abuseipdb_get_reports) | Retrieve paginated abuse reports for a specific IP address. Returns individual report entries with categories, comments, and reporter details. | | [`abuseipdb_report_ip`](#abuseipdb_report_ip) | Submit an abuse report for an IP address. Requires at least one abuse category. | *** ## abuseipdb\_bulk\_report Submit abuse reports for multiple IP addresses via CSV data. Each line should contain: IP, categories, timestamp, and optional comment. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `csv` | string | Yes | — | CSV data with columns: IP, Categories, ReportDate, Comment. First row must be the header row. Example: "IP,Categories,ReportDate,Comment\n1.2.3.4,18,2025-01-15T00:00:00-05:00,Brute force attempt" | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "csv": { "type": "string", "description": "CSV data with columns: IP, Categories, ReportDate, Comment. First row must be the header row. Example: \"IP,Categories,ReportDate,Comment\\n1.2.3.4,18,2025-01-15T00:00:00-05:00,Brute force attempt\"" } }, "required": [ "PCID", "csv" ] } ``` *** ## abuseipdb\_check\_ip Check an IP address for abuse reports. Returns abuse confidence score, country, ISP, usage type, and recent report details. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ipAddress` | string | Yes | — | IPv4 or IPv6 address to check | | `maxAgeInDays` | integer | No | — | Maximum age of reports to consider (1-365, default 30) | | `verbose` | boolean | No | — | Include full report details in the response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ipAddress": { "type": "string", "description": "IPv4 or IPv6 address to check" }, "maxAgeInDays": { "type": "integer", "description": "Maximum age of reports to consider (1-365, default 30)" }, "verbose": { "type": "boolean", "description": "Include full report details in the response" } }, "required": [ "PCID", "ipAddress" ] } ``` *** ## abuseipdb\_check\_subnet Check a subnet (CIDR notation) for abuse reports. Returns aggregated abuse data for all IPs in the range. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `network` | string | Yes | — | Subnet in CIDR notation (e.g., "192.168.1.0/24"). Maximum /24 for IPv4, /48 for IPv6. | | `maxAgeInDays` | integer | No | — | Maximum age of reports to consider (1-365, default 30) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "network": { "type": "string", "description": "Subnet in CIDR notation (e.g., \"192.168.1.0/24\"). Maximum /24 for IPv4, /48 for IPv6." }, "maxAgeInDays": { "type": "integer", "description": "Maximum age of reports to consider (1-365, default 30)" } }, "required": [ "PCID", "network" ] } ``` *** ## abuseipdb\_clear\_address Remove all reports your account has submitted for a specific IP address. This only removes your own reports, not reports from other users. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ipAddress` | string | Yes | — | IPv4 or IPv6 address to clear your reports for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ipAddress": { "type": "string", "description": "IPv4 or IPv6 address to clear your reports for" } }, "required": [ "PCID", "ipAddress" ] } ``` *** ## abuseipdb\_get\_blacklist Download the AbuseIPDB blacklist of reported IP addresses. Returns IPs with the highest abuse confidence scores. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `confidenceMinimum` | integer | No | — | Minimum abuse confidence score (1-100, default 100) | | `limit` | integer | No | — | Maximum number of IPs to return (up to 10000) | | `onlyCountries` | string | No | — | Comma-separated ISO 3166-1 alpha-2 country codes to filter by (e.g., "US,CN") | | `exceptCountries` | string | No | — | Comma-separated ISO 3166-1 alpha-2 country codes to exclude (e.g., "US,CN") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "confidenceMinimum": { "type": "integer", "description": "Minimum abuse confidence score (1-100, default 100)" }, "limit": { "type": "integer", "description": "Maximum number of IPs to return (up to 10000)" }, "onlyCountries": { "type": "string", "description": "Comma-separated ISO 3166-1 alpha-2 country codes to filter by (e.g., \"US,CN\")" }, "exceptCountries": { "type": "string", "description": "Comma-separated ISO 3166-1 alpha-2 country codes to exclude (e.g., \"US,CN\")" } }, "required": [ "PCID" ] } ``` *** ## abuseipdb\_get\_reports Retrieve paginated abuse reports for a specific IP address. Returns individual report entries with categories, comments, and reporter details. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ipAddress` | string | Yes | — | IPv4 or IPv6 address to get reports for | | `maxAgeInDays` | integer | No | — | Maximum age of reports to return (1-365, default 30) | | `page` | integer | No | — | Page number for pagination (default 1) | | `perPage` | integer | No | — | Number of results per page (1-100, default 25) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ipAddress": { "type": "string", "description": "IPv4 or IPv6 address to get reports for" }, "maxAgeInDays": { "type": "integer", "description": "Maximum age of reports to return (1-365, default 30)" }, "page": { "type": "integer", "description": "Page number for pagination (default 1)" }, "perPage": { "type": "integer", "description": "Number of results per page (1-100, default 25)" } }, "required": [ "PCID", "ipAddress" ] } ``` *** ## abuseipdb\_report\_ip Submit an abuse report for an IP address. Requires at least one abuse category. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ip` | string | Yes | — | IPv4 or IPv6 address to report | | `categories` | string | Yes | — | Comma-separated abuse category IDs (e.g., "18,22"). Categories: 1=DNS Compromise, 2=DNS Poisoning, 3=Fraud Orders, 4=DDoS Attack, 5=FTP Brute-Force, 6=Ping of Death, 7=Phishing, 8=Fraud VoIP, 9=Open Proxy, 10=Web Spam, 11=Email Spam, 12=Blog Spam, 13=VPN IP, 14=Port Scan, 15=Hacking, 16=SQL Injection, 17=Spoofing, 18=Brute-Force, 19=Bad Web Bot, 20=Exploited Host, 21=Web App Attack, 22=SSH, 23=IoT Targeted | | `comment` | string | No | — | Description of the malicious activity (max 1024 characters) | | `timestamp` | string | No | — | ISO 8601 datetime of the event (e.g., "2025-01-15T13:00:00-05:00") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ip": { "type": "string", "description": "IPv4 or IPv6 address to report" }, "categories": { "type": "string", "description": "Comma-separated abuse category IDs (e.g., \"18,22\"). Categories: 1=DNS Compromise, 2=DNS Poisoning, 3=Fraud Orders, 4=DDoS Attack, 5=FTP Brute-Force, 6=Ping of Death, 7=Phishing, 8=Fraud VoIP, 9=Open Proxy, 10=Web Spam, 11=Email Spam, 12=Blog Spam, 13=VPN IP, 14=Port Scan, 15=Hacking, 16=SQL Injection, 17=Spoofing, 18=Brute-Force, 19=Bad Web Bot, 20=Exploited Host, 21=Web App Attack, 22=SSH, 23=IoT Targeted" }, "comment": { "type": "string", "description": "Description of the malicious activity (max 1024 characters)" }, "timestamp": { "type": "string", "description": "ISO 8601 datetime of the event (e.g., \"2025-01-15T13:00:00-05:00\")" } }, "required": [ "PCID", "ip", "categories" ] } ``` # abyssale Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/abyssale Abyssale API **Server path:** `/abyssale` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`abyssale_check_auth`](#abyssale_check_auth) | Test authentication | | [`abyssale_create_project`](#abyssale_create_project) | Create a project | | [`abyssale_export_banners`](#abyssale_export_banners) | Export banners as ZIP | | [`abyssale_generate_async`](#abyssale_generate_async) | Generate assets asynchronously | | [`abyssale_generate_image`](#abyssale_generate_image) | Generate image synchronously | | [`abyssale_get_design`](#abyssale_get_design) | Get design details | | [`abyssale_get_design_format`](#abyssale_get_design_format) | Get design format details | | [`abyssale_get_duplication_status`](#abyssale_get_duplication_status) | Get duplication request status | | [`abyssale_get_generation_status`](#abyssale_get_generation_status) | Get generation request status | | [`abyssale_list_designs`](#abyssale_list_designs) | List all designs | | [`abyssale_list_fonts`](#abyssale_list_fonts) | List all fonts | | [`abyssale_list_projects`](#abyssale_list_projects) | List all projects | | [`abyssale_use_workspace_template`](#abyssale_use_workspace_template) | Duplicate workspace template | *** ## abyssale\_check\_auth Test authentication ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## abyssale\_create\_project Create a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Project name (2-100 characters) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Project name (2-100 characters)" } }, "required": [ "PCID", "name" ] } ``` *** ## abyssale\_export\_banners Export banners as ZIP **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `callback_url` | string | Yes | — | Webhook URL to receive the export completion notification | | `ids` | string\[] | Yes | — | Array of banner UUIDs to export | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "callback_url": { "type": "string", "description": "Webhook URL to receive the export completion notification" }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Array of banner UUIDs to export" } }, "required": [ "PCID", "callback_url", "ids" ] } ``` *** ## abyssale\_generate\_async Generate assets asynchronously **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `designId` | string | Yes | — | Design UUID | | `callback_url` | string | No | — | Webhook URL for completion notification | | `elements` | object | No | — | Element overrides keyed by element name. Each value is an object with element-type-specific properties. | | `image_file_type` | string | No | — | Output file type | | `template_format_names` | string\[] | No | — | Format names to generate. If omitted, generates all formats. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "designId": { "type": "string", "description": "Design UUID" }, "callback_url": { "type": "string", "description": "Webhook URL for completion notification" }, "elements": { "type": "object", "description": "Element overrides keyed by element name. Each value is an object with element-type-specific properties." }, "image_file_type": { "type": "string", "description": "Output file type", "enum": [ "png", "jpeg", "webp", "avif", "pdf", "gif", "html5", "mp4" ] }, "template_format_names": { "type": "array", "items": { "type": "string" }, "description": "Format names to generate. If omitted, generates all formats." } }, "required": [ "PCID", "designId" ] } ``` *** ## abyssale\_generate\_image Generate image synchronously **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `designId` | string | Yes | — | Design UUID | | `elements` | object | No | — | Element overrides keyed by element name. Each value is an object with element-type-specific properties (e.g. payload for text, image\_url for images). | | `image_file_type` | string | No | — | Output file type | | `template_format_name` | string | Yes | — | Name of the format to generate | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "designId": { "type": "string", "description": "Design UUID" }, "elements": { "type": "object", "description": "Element overrides keyed by element name. Each value is an object with element-type-specific properties (e.g. payload for text, image_url for images)." }, "image_file_type": { "type": "string", "description": "Output file type", "enum": [ "png", "jpeg", "webp", "avif", "pdf" ] }, "template_format_name": { "type": "string", "description": "Name of the format to generate" } }, "required": [ "PCID", "designId", "template_format_name" ] } ``` *** ## abyssale\_get\_design Get design details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `designId` | string | Yes | — | Design UUID | | `i` | string | No | — | Set to 'advanced' to retrieve advanced element properties | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "designId": { "type": "string", "description": "Design UUID" }, "i": { "type": "string", "description": "Set to 'advanced' to retrieve advanced element properties", "enum": [ "advanced" ] } }, "required": [ "PCID", "designId" ] } ``` *** ## abyssale\_get\_design\_format Get design format details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `designId` | string | Yes | — | Design UUID | | `formatSpecifier` | string | Yes | — | Format name or UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "designId": { "type": "string", "description": "Design UUID" }, "formatSpecifier": { "type": "string", "description": "Format name or UID" } }, "required": [ "PCID", "designId", "formatSpecifier" ] } ``` *** ## abyssale\_get\_duplication\_status Get duplication request status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `duplicateRequestId` | string | Yes | — | Duplication request UUID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "duplicateRequestId": { "type": "string", "description": "Duplication request UUID" } }, "required": [ "PCID", "duplicateRequestId" ] } ``` *** ## abyssale\_get\_generation\_status Get generation request status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `generation_request_id` | string | Yes | — | Generation request UUID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "generation_request_id": { "type": "string", "description": "Generation request UUID" } }, "required": [ "PCID", "generation_request_id" ] } ``` *** ## abyssale\_list\_designs List all designs **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `category_id` | string | No | — | Filter by category UUID | | `type` | string | No | — | Filter by design type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category_id": { "type": "string", "description": "Filter by category UUID" }, "type": { "type": "string", "description": "Filter by design type", "enum": [ "static", "animated", "printer", "printer_multipage" ] } }, "required": [ "PCID" ] } ``` *** ## abyssale\_list\_fonts List all fonts ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## abyssale\_list\_projects List all projects ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## abyssale\_use\_workspace\_template Duplicate workspace template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyTemplateId` | string | Yes | — | Workspace template UUID | | `name` | string | No | — | Custom name for the duplicated design (2-100 characters) | | `project_id` | string | Yes | — | Destination project UUID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyTemplateId": { "type": "string", "description": "Workspace template UUID" }, "name": { "type": "string", "description": "Custom name for the duplicated design (2-100 characters)" }, "project_id": { "type": "string", "description": "Destination project UUID" } }, "required": [ "PCID", "companyTemplateId", "project_id" ] } ``` # activecampaign Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/activecampaign ActiveCampaign - contact management, email marketing, automations, CRM deals and pipelines **Server path:** `/activecampaign` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`activecampaign_add_contact_to_automation`](#activecampaign_add_contact_to_automation) | Add a contact to an automation | | [`activecampaign_add_contact_to_list`](#activecampaign_add_contact_to_list) | Add or update contact list subscription | | [`activecampaign_add_tag_to_contact`](#activecampaign_add_tag_to_contact) | Add a tag to a contact | | [`activecampaign_create_contact_custom_field`](#activecampaign_create_contact_custom_field) | Create a contact custom field | | [`activecampaign_create_contact_field_relationship`](#activecampaign_create_contact_field_relationship) | Link custom field to lists | | [`activecampaign_create_contact_field_value`](#activecampaign_create_contact_field_value) | Create a contact field value | | [`activecampaign_create_contact_tag`](#activecampaign_create_contact_tag) | Create a tag | | [`activecampaign_create_deal`](#activecampaign_create_deal) | Create a deal | | [`activecampaign_create_deal_note`](#activecampaign_create_deal_note) | Create a deal note | | [`activecampaign_create_deal_pipeline`](#activecampaign_create_deal_pipeline) | Create a deal pipeline | | [`activecampaign_create_field_options`](#activecampaign_create_field_options) | Create field options | | [`activecampaign_create_list`](#activecampaign_create_list) | Create a list | | [`activecampaign_create_list_group_permission`](#activecampaign_create_list_group_permission) | Create list group permission | | [`activecampaign_create_or_update_contact`](#activecampaign_create_or_update_contact) | Create or update a contact | | [`activecampaign_deal_owner_bulk_update`](#activecampaign_deal_owner_bulk_update) | Bulk update deal owners | | [`activecampaign_get_campaign`](#activecampaign_get_campaign) | Get a campaign | | [`activecampaign_get_campaign_links`](#activecampaign_get_campaign_links) | Get campaign links | | [`activecampaign_get_contact`](#activecampaign_get_contact) | Get a contact | | [`activecampaign_get_contact_automation`](#activecampaign_get_contact_automation) | Get a contact automation | | [`activecampaign_get_contact_custom_field`](#activecampaign_get_contact_custom_field) | Get a contact custom field | | [`activecampaign_get_contact_field_value`](#activecampaign_get_contact_field_value) | Get a contact field value | | [`activecampaign_get_deal`](#activecampaign_get_deal) | Get a deal | | [`activecampaign_get_deal_pipeline`](#activecampaign_get_deal_pipeline) | Get a deal pipeline | | [`activecampaign_get_list`](#activecampaign_get_list) | Get a list | | [`activecampaign_get_tag`](#activecampaign_get_tag) | Get a tag | | [`activecampaign_list_automations`](#activecampaign_list_automations) | List automations | | [`activecampaign_list_campaigns`](#activecampaign_list_campaigns) | List campaigns | | [`activecampaign_list_contact_automations`](#activecampaign_list_contact_automations) | List a contact's automations | | [`activecampaign_list_contact_custom_fields`](#activecampaign_list_contact_custom_fields) | List contact custom fields | | [`activecampaign_list_contact_field_values`](#activecampaign_list_contact_field_values) | List contact field values | | [`activecampaign_list_contacts`](#activecampaign_list_contacts) | List, search, and filter contacts | | [`activecampaign_list_deal_activities`](#activecampaign_list_deal_activities) | List deal activities | | [`activecampaign_list_deal_pipelines`](#activecampaign_list_deal_pipelines) | List deal pipelines | | [`activecampaign_list_deals`](#activecampaign_list_deals) | List all deals | | [`activecampaign_list_email_activities`](#activecampaign_list_email_activities) | List email activities | | [`activecampaign_list_groups`](#activecampaign_list_groups) | List user groups | | [`activecampaign_list_lists`](#activecampaign_list_lists) | List contact lists | | [`activecampaign_list_tags`](#activecampaign_list_tags) | List tags | | [`activecampaign_remove_contact_from_automation`](#activecampaign_remove_contact_from_automation) | Remove a contact from an automation | | [`activecampaign_update_contact_field_value`](#activecampaign_update_contact_field_value) | Update a contact field value | | [`activecampaign_update_deal`](#activecampaign_update_deal) | Update a deal | | [`activecampaign_update_deal_note`](#activecampaign_update_deal_note) | Update a deal note | | [`activecampaign_update_deal_pipeline`](#activecampaign_update_deal_pipeline) | Update a deal pipeline | | [`activecampaign_update_list`](#activecampaign_update_list) | Update a list | *** ## activecampaign\_add\_contact\_to\_automation Add a contact to an automation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contactAutomation` | object | Yes | — | Contact Automation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contactAutomation": { "type": "object", "description": "Contact Automation", "properties": { "contact": { "type": "integer", "description": "Contact ID to enroll in the automation" }, "automation": { "type": "integer", "description": "Automation ID to enroll the contact in" } }, "required": [ "contact", "automation" ] } }, "required": [ "PCID", "contactAutomation" ] } ``` *** ## activecampaign\_add\_contact\_to\_list Add or update contact list subscription **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contactList` | object | Yes | — | Contact List | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contactList": { "type": "object", "description": "Contact List", "properties": { "list": { "type": "integer", "description": "List ID" }, "contact": { "type": "integer", "description": "Contact ID" }, "status": { "type": "integer", "description": "Subscription status (1=active/subscribed, 2=unsubscribed)", "enum": [ 1, 2 ] } }, "required": [ "list", "contact", "status" ] } }, "required": [ "PCID", "contactList" ] } ``` *** ## activecampaign\_add\_tag\_to\_contact Add a tag to a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contactTag` | object | Yes | — | Contact Tag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contactTag": { "type": "object", "description": "Contact Tag", "properties": { "contact": { "type": "integer", "description": "Contact ID to tag" }, "tag": { "type": "integer", "description": "Tag ID to apply to the contact" } }, "required": [ "contact", "tag" ] } }, "required": [ "PCID", "contactTag" ] } ``` *** ## activecampaign\_create\_contact\_custom\_field Create a contact custom field **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `field` | object | Yes | — | The field value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "field": { "type": "object", "description": "The field value", "properties": { "type": { "type": "string", "description": "Field type", "enum": [ "text", "textarea", "date", "datetime", "dropdown", "multiselect", "radio", "checkbox", "hidden", "currency", "number" ] }, "title": { "type": "string", "description": "Field label shown in the UI" }, "description": { "type": "string", "description": "Field description" }, "perstag": { "type": "string", "description": "Personalization tag for use in email templates" }, "defval": { "type": "string", "description": "Default value for the field" }, "show_in_list": { "type": "integer", "description": "Whether to show field in contact list view (0=no, 1=yes)", "enum": [ 0, 1 ] }, "visible": { "type": "integer", "description": "Whether field is visible (0=hidden, 1=visible)", "enum": [ 0, 1 ] }, "ordernum": { "type": "integer", "description": "Display order of the field" } }, "required": [ "type", "title" ] } }, "required": [ "PCID", "field" ] } ``` *** ## activecampaign\_create\_contact\_field\_relationship Link custom field to lists **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fieldId` | integer | Yes | — | Custom field ID to link | | `fieldRel` | object | Yes | — | Field Rel | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fieldId": { "type": "integer", "description": "Custom field ID to link" }, "fieldRel": { "type": "object", "description": "Field Rel", "properties": { "field": { "type": "integer", "description": "Custom field ID (should match path parameter)" }, "relid": { "type": "integer", "description": "List ID to link the field to" } }, "required": [ "field", "relid" ] } }, "required": [ "PCID", "fieldId", "fieldRel" ] } ``` *** ## activecampaign\_create\_contact\_field\_value Create a contact field value **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fieldValue` | object | Yes | — | Field Value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fieldValue": { "type": "object", "description": "Field Value", "properties": { "contact": { "type": "integer", "description": "Contact ID" }, "field": { "type": "integer", "description": "Custom field ID" }, "value": { "type": "string", "description": "Value to store in the field" } }, "required": [ "contact", "field", "value" ] } }, "required": [ "PCID", "fieldValue" ] } ``` *** ## activecampaign\_create\_contact\_tag Create a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `tag` | object | Yes | — | The tag value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag": { "type": "object", "description": "The tag value", "properties": { "tag": { "type": "string", "description": "Tag name" }, "tagType": { "type": "string", "description": "Tag type (e.g., \"contact\" for contact tags)", "enum": [ "contact", "template" ] }, "description": { "type": "string", "description": "Optional description for the tag" } }, "required": [ "tag", "tagType" ] } }, "required": [ "PCID", "tag" ] } ``` *** ## activecampaign\_create\_deal Create a deal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deal` | object | Yes | — | The deal value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deal": { "type": "object", "description": "The deal value", "properties": { "title": { "type": "string", "description": "Deal title" }, "contact": { "type": "integer", "description": "Contact ID associated with the deal" }, "value": { "type": "integer", "description": "Deal value in cents (e.g., 10000 = $100.00)" }, "currency": { "type": "string", "description": "Currency code (e.g., \"usd\", \"eur\")" }, "group": { "type": "integer", "description": "Pipeline (deal group) ID" }, "stage": { "type": "integer", "description": "Deal stage ID within the pipeline" }, "owner": { "type": "integer", "description": "Deal owner (user) ID" }, "percent": { "type": "integer", "description": "Probability percentage of closing (0-100)" }, "status": { "type": "integer", "description": "Deal status (0=open, 1=won, 2=lost)", "enum": [ 0, 1, 2 ] }, "description": { "type": "string", "description": "Deal description" } }, "required": [ "title", "contact", "value", "currency" ] } }, "required": [ "PCID", "deal" ] } ``` *** ## activecampaign\_create\_deal\_note Create a deal note **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dealId` | integer | Yes | — | Deal ID to add the note to | | `note` | object | Yes | — | The note value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dealId": { "type": "integer", "description": "Deal ID to add the note to" }, "note": { "type": "object", "description": "The note value", "properties": { "note": { "type": "string", "description": "Note content text" } }, "required": [ "note" ] } }, "required": [ "PCID", "dealId", "note" ] } ``` *** ## activecampaign\_create\_deal\_pipeline Create a deal pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dealGroup` | object | Yes | — | Deal Group | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dealGroup": { "type": "object", "description": "Deal Group", "properties": { "title": { "type": "string", "description": "Pipeline name" }, "currency": { "type": "string", "description": "Default currency code for deals in this pipeline (e.g., \"usd\")" }, "autoAssign": { "type": "integer", "description": "Auto-assign deals to users (0=off, 1=on)", "enum": [ 0, 1 ] }, "allgroups": { "type": "integer", "description": "Make pipeline accessible to all groups (0=no, 1=yes)", "enum": [ 0, 1 ] } }, "required": [ "title", "currency" ] } }, "required": [ "PCID", "dealGroup" ] } ``` *** ## activecampaign\_create\_field\_options Create field options **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fieldId` | integer | Yes | — | Custom field ID to add options to | | `fieldOptions` | object\[] | Yes | — | Array of field options to create | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fieldId": { "type": "integer", "description": "Custom field ID to add options to" }, "fieldOptions": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "Display label for the option" }, "value": { "type": "string", "description": "Stored value for the option" }, "isdefault": { "type": "integer", "enum": [ 0, 1 ], "description": "Whether this is the default option (0=no, 1=yes)" }, "orderid": { "type": "integer", "description": "Display order of the option" } }, "required": [ "label", "value" ] }, "description": "Array of field options to create" } }, "required": [ "PCID", "fieldId", "fieldOptions" ] } ``` *** ## activecampaign\_create\_list Create a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | object | Yes | — | The list value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "object", "description": "The list value", "properties": { "name": { "type": "string", "description": "List name" }, "stringid": { "type": "string", "description": "Unique string identifier for the list (URL-safe)" }, "sender_url": { "type": "string", "description": "URL of the sender's website" }, "sender_reminder": { "type": "string", "description": "Reminder message shown to subscribers about why they are on the list" }, "sender_name": { "type": "string", "description": "Name of the sender" }, "sender_addr1": { "type": "string", "description": "Sender's address line 1" }, "sender_city": { "type": "string", "description": "Sender's city" }, "sender_state": { "type": "string", "description": "Sender's state/province" }, "sender_zip": { "type": "string", "description": "Sender's postal/zip code" }, "sender_country": { "type": "string", "description": "Sender's country" } }, "required": [ "name", "sender_url", "sender_reminder" ] } }, "required": [ "PCID", "list" ] } ``` *** ## activecampaign\_create\_list\_group\_permission Create list group permission **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `listId` | integer | Yes | — | List ID to grant permission on | | `listGroupPermission` | object | Yes | — | List Group Permission | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "listId": { "type": "integer", "description": "List ID to grant permission on" }, "listGroupPermission": { "type": "object", "description": "List Group Permission", "properties": { "groupid": { "type": "integer", "description": "Group ID to grant permission to" }, "listid": { "type": "integer", "description": "List ID (should match path parameter)" } }, "required": [ "groupid", "listid" ] } }, "required": [ "PCID", "listId", "listGroupPermission" ] } ``` *** ## activecampaign\_create\_or\_update\_contact Create or update a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contact` | object | Yes | — | The contact value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contact": { "type": "object", "description": "The contact value", "properties": { "email": { "type": "string", "description": "Contact's email address (used as unique identifier)" }, "firstName": { "type": "string", "description": "Contact's first name" }, "lastName": { "type": "string", "description": "Contact's last name" }, "phone": { "type": "string", "description": "Contact's phone number" }, "fieldValues": { "type": "array", "items": { "type": "object" }, "description": "Custom field values to set on the contact" } }, "required": [ "email" ] } }, "required": [ "PCID", "contact" ] } ``` *** ## activecampaign\_deal\_owner\_bulk\_update Bulk update deal owners **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dealIds` | integer\[] | Yes | — | Array of deal IDs to reassign | | `owner` | integer | Yes | — | New owner (user) ID to assign all specified deals to | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dealIds": { "type": "array", "items": { "type": "integer" }, "description": "Array of deal IDs to reassign" }, "owner": { "type": "integer", "description": "New owner (user) ID to assign all specified deals to" } }, "required": [ "PCID", "dealIds", "owner" ] } ``` *** ## activecampaign\_get\_campaign Get a campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_get\_campaign\_links Get campaign links **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_get\_contact Get a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Contact ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Contact ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_get\_contact\_automation Get a contact automation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Contact automation record ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Contact automation record ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_get\_contact\_custom\_field Get a contact custom field **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Custom field ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Custom field ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_get\_contact\_field\_value Get a contact field value **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Field value ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Field value ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_get\_deal Get a deal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Deal ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Deal ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_get\_deal\_pipeline Get a deal pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Pipeline (deal group) ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Pipeline (deal group) ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_get\_list Get a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | List ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "List ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_get\_tag Get a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Tag ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Tag ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_list\_automations List automations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Maximum number of automations to return | | `offset` | integer | No | — | Number of automations to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Maximum number of automations to return" }, "offset": { "type": "integer", "description": "Number of automations to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_campaigns List campaigns **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filtersStatus` | integer | No | — | Filter by campaign status (0=draft, 1=scheduled, 2=sending, 3=sent, 5=disabled) | | `filtersType` | string | No | — | Filter by campaign type (single, recurring, split, responder, reminder, special, activerss, text) | | `filtersAfter` | string | No | — | Filter campaigns sent after this date (YYYY-MM-DD format) | | `filtersBefore` | string | No | — | Filter campaigns sent before this date (YYYY-MM-DD format) | | `search` | string | No | — | Search campaigns by name | | `limit` | integer | No | — | Maximum number of campaigns to return | | `offset` | integer | No | — | Number of campaigns to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filtersStatus": { "type": "integer", "description": "Filter by campaign status (0=draft, 1=scheduled, 2=sending, 3=sent, 5=disabled)" }, "filtersType": { "type": "string", "description": "Filter by campaign type (single, recurring, split, responder, reminder, special, activerss, text)" }, "filtersAfter": { "type": "string", "description": "Filter campaigns sent after this date (YYYY-MM-DD format)" }, "filtersBefore": { "type": "string", "description": "Filter campaigns sent before this date (YYYY-MM-DD format)" }, "search": { "type": "string", "description": "Search campaigns by name" }, "limit": { "type": "integer", "description": "Maximum number of campaigns to return" }, "offset": { "type": "integer", "description": "Number of campaigns to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_contact\_automations List a contact's automations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contactId` | integer | Yes | — | Contact ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contactId": { "type": "integer", "description": "Contact ID" } }, "required": [ "PCID", "contactId" ] } ``` *** ## activecampaign\_list\_contact\_custom\_fields List contact custom fields **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Maximum number of fields to return (default 100) | | `offset` | integer | No | — | Number of fields to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Maximum number of fields to return (default 100)" }, "offset": { "type": "integer", "description": "Number of fields to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_contact\_field\_values List contact field values **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filtersContact` | integer | No | — | Filter field values by contact ID | | `filtersField` | integer | No | — | Filter field values by custom field ID | | `limit` | integer | No | — | Maximum number of results to return | | `offset` | integer | No | — | Number of results to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filtersContact": { "type": "integer", "description": "Filter field values by contact ID" }, "filtersField": { "type": "integer", "description": "Filter field values by custom field ID" }, "limit": { "type": "integer", "description": "Maximum number of results to return" }, "offset": { "type": "integer", "description": "Number of results to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_contacts List, search, and filter contacts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ids` | string | No | — | Filter contacts by ID. Can be repeated for multiple IDs (for example, ids\[]=1\&ids\[]=2). | | `email` | string | No | — | Email address of the contact you want to get | | `email_like` | string | No | — | Filter contacts that contain this value in the email address | | `exclude` | integer | No | — | Exclude from the response the contact with the given ID | | `listid` | string | No | — | Filter contacts associated with the given list | | `segmentid` | string | No | — | Return only contacts that match a list segment. The first API call within 1 hour or an API call with the param forceQuery=1 will kick off an new segment request. When the segment results are ready, subsequent API calls without the forceQuery param will return contacts that match the segment (timeout 1 hour). | | `formid` | integer | No | — | Filter contacts associated with the given form | | `id_greater` | integer | No | — | Only include contacts with an ID greater than the given ID | | `id_less` | integer | No | — | Only include contacts with an ID less than the given ID | | `phone` | string | No | — | Filter contacts where the phone number starts with the given value | | `organization` | integer | No | — | (Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID | | `search` | string | No | — | Filter contacts that match the given value in the contact names, organization, phone or email | | `seriesid` | integer | No | — | Filter contacts associated with the given automation | | `status` | integer | No | — | Contact status filter. See available values in ActiveCampaign contact parameters. | | `tagid` | integer | No | — | Filter contacts associated with the given tag | | `waitid` | integer | No | — | Filter by contacts in the wait queue of an automation block | | `in_group_lists` | string | No | — | Set to true to return only contacts the current user has permission to see | | `forceQuery` | number | No | — | If present and equal to 1, a new segment request is kicked off which will return an updated result set. Otherwise, a segmented API request with a consistent sorting returns the same results for 1 hour. | | `sortId` | number | No | — | If sorting results by a score or custom field, this parameter holds the id of the score or custom field respectively | | `filtersCreatedBefore` | string | No | — | Filter contacts that were created prior to this date | | `filtersCreatedAfter` | string | No | — | Filter contacts that were created after this date | | `filtersUpdatedBefore` | string | No | — | Filter contacts that were updated before this date | | `filtersUpdatedAfter` | string | No | — | Filter contacts that were updated after this date | | `ordersId` | string | No | — | Order contacts by unique ID | | `ordersCdate` | string | No | — | Order contacts by creation date | | `ordersEmail` | string | No | — | Order contacts by email | | `ordersFirstName` | string | No | — | Order contacts by first name | | `ordersLastName` | string | No | — | Order contacts by last name | | `ordersName` | string | No | — | Order contacts by full name | | `ordersScore` | string | No | — | Order contacts by score. Use together with sortId. | | `limit` | integer | No | — | Maximum number of contacts to return (default 20, max 100) | | `offset` | integer | No | — | Number of contacts to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ids": { "type": "string", "description": "Filter contacts by ID. Can be repeated for multiple IDs (for example, ids[]=1&ids[]=2)." }, "email": { "type": "string", "description": "Email address of the contact you want to get" }, "email_like": { "type": "string", "description": "Filter contacts that contain this value in the email address" }, "exclude": { "type": "integer", "description": "Exclude from the response the contact with the given ID" }, "listid": { "type": "string", "description": "Filter contacts associated with the given list" }, "segmentid": { "type": "string", "description": "Return only contacts that match a list segment. The first API call within 1 hour or an API call with the param forceQuery=1 will kick off an new segment request. When the segment results are ready, subsequent API calls without the forceQuery param will return contacts that match the segment (timeout 1 hour)." }, "formid": { "type": "integer", "description": "Filter contacts associated with the given form" }, "id_greater": { "type": "integer", "description": "Only include contacts with an ID greater than the given ID" }, "id_less": { "type": "integer", "description": "Only include contacts with an ID less than the given ID" }, "phone": { "type": "string", "description": "Filter contacts where the phone number starts with the given value" }, "organization": { "type": "integer", "description": "(Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID" }, "search": { "type": "string", "description": "Filter contacts that match the given value in the contact names, organization, phone or email" }, "seriesid": { "type": "integer", "description": "Filter contacts associated with the given automation" }, "status": { "type": "integer", "description": "Contact status filter. See available values in ActiveCampaign contact parameters." }, "tagid": { "type": "integer", "description": "Filter contacts associated with the given tag" }, "waitid": { "type": "integer", "description": "Filter by contacts in the wait queue of an automation block" }, "in_group_lists": { "type": "string", "description": "Set to true to return only contacts the current user has permission to see" }, "forceQuery": { "type": "number", "description": "If present and equal to 1, a new segment request is kicked off which will return an updated result set. Otherwise, a segmented API request with a consistent sorting returns the same results for 1 hour.", "enum": [ 0, 1 ] }, "sortId": { "type": "number", "description": "If sorting results by a score or custom field, this parameter holds the id of the score or custom field respectively" }, "filtersCreatedBefore": { "type": "string", "description": "Filter contacts that were created prior to this date" }, "filtersCreatedAfter": { "type": "string", "description": "Filter contacts that were created after this date" }, "filtersUpdatedBefore": { "type": "string", "description": "Filter contacts that were updated before this date" }, "filtersUpdatedAfter": { "type": "string", "description": "Filter contacts that were updated after this date" }, "ordersId": { "type": "string", "description": "Order contacts by unique ID", "enum": [ "desc", "asc" ] }, "ordersCdate": { "type": "string", "description": "Order contacts by creation date", "enum": [ "desc", "asc" ] }, "ordersEmail": { "type": "string", "description": "Order contacts by email", "enum": [ "desc", "asc" ] }, "ordersFirstName": { "type": "string", "description": "Order contacts by first name", "enum": [ "desc", "asc" ] }, "ordersLastName": { "type": "string", "description": "Order contacts by last name", "enum": [ "desc", "asc" ] }, "ordersName": { "type": "string", "description": "Order contacts by full name", "enum": [ "desc", "asc" ] }, "ordersScore": { "type": "string", "description": "Order contacts by score. Use together with sortId.", "enum": [ "desc", "asc" ] }, "limit": { "type": "integer", "description": "Maximum number of contacts to return (default 20, max 100)" }, "offset": { "type": "integer", "description": "Number of contacts to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_deal\_activities List deal activities **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filtersDeal` | integer | No | — | Filter activities by deal ID | | `filtersOwner` | integer | No | — | Filter activities by owner (user) ID | | `limit` | integer | No | — | Maximum number of activities to return | | `offset` | integer | No | — | Number of activities to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filtersDeal": { "type": "integer", "description": "Filter activities by deal ID" }, "filtersOwner": { "type": "integer", "description": "Filter activities by owner (user) ID" }, "limit": { "type": "integer", "description": "Maximum number of activities to return" }, "offset": { "type": "integer", "description": "Number of activities to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_deal\_pipelines List deal pipelines **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Maximum number of pipelines to return | | `offset` | integer | No | — | Number of pipelines to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Maximum number of pipelines to return" }, "offset": { "type": "integer", "description": "Number of pipelines to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_deals List all deals **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filtersSearch` | string | No | — | Search text to use with search\_field parameter. | | `filtersSearchField` | string | No | — | Field to search for. See available values in ActiveCampaign deal parameters. | | `filtersTitle` | string | No | — | Filter by deal's title | | `filtersStage` | integer | No | — | Filter by deal's stage | | `filtersGroup` | integer | No | — | Filter by deal's pipeline | | `filtersStatus` | integer | No | — | Filter by deal's status. See available values in ActiveCampaign deal parameters. | | `filtersOwner` | integer | No | — | Filter by deal's owner | | `filtersNextdateRange` | string | No | — | Filter by deal's tasks due dates. See available values in ActiveCampaign deal parameters. | | `filtersTag` | string | No | — | Filter by tag names associated with deal's primary contact. See available values in ActiveCampaign deal parameters. | | `filtersTasktype` | string | No | — | Filter by deals that have tasks with given type | | `filtersCreatedBefore` | string | No | — | Returns deals that are created less than given date | | `filtersCreatedAfter` | string | No | — | Returns deals that are created greater than or equal to given date | | `filtersUpdatedBefore` | string | No | — | Returns deals that are updated less than given date | | `filtersUpdatedAfter` | string | No | — | Returns deals that are updated greater than or equal to given date | | `filtersOrganization` | integer | No | — | Filter by deal's primary contact's organization's id | | `filtersMinimumValue` | integer | No | — | In USD with dollar portion. Returns deals whose values are greater than or equal to given value | | `filtersMaximumValue` | integer | No | — | In USD with dollar portion. Returns deals whose values are less than or equal to given value | | `filtersScoreGreaterThan` | string | No | — | In a format of \:\. Returns deals whose score value is greater than given value | | `filtersScoreLessThan` | string | No | — | In a format of \:\. Returns deals whose score value is less than given value | | `filtersScore` | string | No | — | In a format of \:\. Returns deals whose score value is equal to given value | | `ordersTitle` | string | No | — | Order by deal's title. | | `ordersValue` | string | No | — | Order by deal's value. | | `ordersCdate` | string | No | — | Order by deal's created date. | | `ordersContactName` | string | No | — | Order by deal's primary contact's first name. | | `ordersContactOrgname` | string | No | — | Order by deal's primary contact's organization name. | | `ordersNextAction` | string | No | — | Order by deal's next task's due date first. Then append deals with no next task. Lastly append deals with overdue tasks. If dates are the same, order by deal's id. | | `limit` | integer | No | — | Maximum number of deals to return | | `offset` | integer | No | — | Number of deals to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filtersSearch": { "type": "string", "description": "Search text to use with search_field parameter." }, "filtersSearchField": { "type": "string", "description": "Field to search for. See available values in ActiveCampaign deal parameters." }, "filtersTitle": { "type": "string", "description": "Filter by deal's title" }, "filtersStage": { "type": "integer", "description": "Filter by deal's stage" }, "filtersGroup": { "type": "integer", "description": "Filter by deal's pipeline" }, "filtersStatus": { "type": "integer", "description": "Filter by deal's status. See available values in ActiveCampaign deal parameters." }, "filtersOwner": { "type": "integer", "description": "Filter by deal's owner" }, "filtersNextdateRange": { "type": "string", "description": "Filter by deal's tasks due dates. See available values in ActiveCampaign deal parameters." }, "filtersTag": { "type": "string", "description": "Filter by tag names associated with deal's primary contact. See available values in ActiveCampaign deal parameters." }, "filtersTasktype": { "type": "string", "description": "Filter by deals that have tasks with given type" }, "filtersCreatedBefore": { "type": "string", "description": "Returns deals that are created less than given date" }, "filtersCreatedAfter": { "type": "string", "description": "Returns deals that are created greater than or equal to given date" }, "filtersUpdatedBefore": { "type": "string", "description": "Returns deals that are updated less than given date" }, "filtersUpdatedAfter": { "type": "string", "description": "Returns deals that are updated greater than or equal to given date" }, "filtersOrganization": { "type": "integer", "description": "Filter by deal's primary contact's organization's id" }, "filtersMinimumValue": { "type": "integer", "description": "In USD with dollar portion. Returns deals whose values are greater than or equal to given value" }, "filtersMaximumValue": { "type": "integer", "description": "In USD with dollar portion. Returns deals whose values are less than or equal to given value" }, "filtersScoreGreaterThan": { "type": "string", "description": "In a format of :. Returns deals whose score value is greater than given value" }, "filtersScoreLessThan": { "type": "string", "description": "In a format of :. Returns deals whose score value is less than given value" }, "filtersScore": { "type": "string", "description": "In a format of :. Returns deals whose score value is equal to given value" }, "ordersTitle": { "type": "string", "description": "Order by deal's title.", "enum": [ "desc", "asc" ] }, "ordersValue": { "type": "string", "description": "Order by deal's value.", "enum": [ "desc", "asc" ] }, "ordersCdate": { "type": "string", "description": "Order by deal's created date.", "enum": [ "desc", "asc" ] }, "ordersContactName": { "type": "string", "description": "Order by deal's primary contact's first name.", "enum": [ "desc", "asc" ] }, "ordersContactOrgname": { "type": "string", "description": "Order by deal's primary contact's organization name.", "enum": [ "desc", "asc" ] }, "ordersNextAction": { "type": "string", "description": "Order by deal's next task's due date first. Then append deals with no next task. Lastly append deals with overdue tasks. If dates are the same, order by deal's id.", "enum": [ "desc", "asc" ] }, "limit": { "type": "integer", "description": "Maximum number of deals to return" }, "offset": { "type": "integer", "description": "Number of deals to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_email\_activities List email activities **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filtersContact` | integer | No | — | Filter email activities by contact ID | | `filtersCampaign` | integer | No | — | Filter email activities by campaign ID | | `limit` | integer | No | — | Maximum number of activities to return | | `offset` | integer | No | — | Number of activities to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filtersContact": { "type": "integer", "description": "Filter email activities by contact ID" }, "filtersCampaign": { "type": "integer", "description": "Filter email activities by campaign ID" }, "limit": { "type": "integer", "description": "Maximum number of activities to return" }, "offset": { "type": "integer", "description": "Number of activities to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_groups List user groups **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Maximum number of groups to return | | `offset` | integer | No | — | Number of groups to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Maximum number of groups to return" }, "offset": { "type": "integer", "description": "Number of groups to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_lists List contact lists **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filtersNameContains` | string | No | — | Filter lists whose name contains this string | | `limit` | integer | No | — | Maximum number of lists to return | | `offset` | integer | No | — | Number of lists to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filtersNameContains": { "type": "string", "description": "Filter lists whose name contains this string" }, "limit": { "type": "integer", "description": "Maximum number of lists to return" }, "offset": { "type": "integer", "description": "Number of lists to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_list\_tags List tags **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `search` | string | No | — | Filter tags by name (partial match) | | `limit` | integer | No | — | Maximum number of tags to return | | `offset` | integer | No | — | Number of tags to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "search": { "type": "string", "description": "Filter tags by name (partial match)" }, "limit": { "type": "integer", "description": "Maximum number of tags to return" }, "offset": { "type": "integer", "description": "Number of tags to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## activecampaign\_remove\_contact\_from\_automation Remove a contact from an automation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Contact automation record ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Contact automation record ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activecampaign\_update\_contact\_field\_value Update a contact field value **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Field value ID | | `fieldValue` | object | Yes | — | Field Value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Field value ID" }, "fieldValue": { "type": "object", "description": "Field Value", "properties": { "value": { "type": "string", "description": "New value for the field" } }, "required": [ "value" ] } }, "required": [ "PCID", "id", "fieldValue" ] } ``` *** ## activecampaign\_update\_deal Update a deal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Deal ID | | `deal` | object | Yes | — | The deal value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Deal ID" }, "deal": { "type": "object", "description": "The deal value", "properties": { "title": { "type": "string", "description": "Deal title" }, "value": { "type": "integer", "description": "Deal value in cents" }, "currency": { "type": "string", "description": "Currency code" }, "group": { "type": "integer", "description": "Pipeline (deal group) ID" }, "stage": { "type": "integer", "description": "Deal stage ID" }, "owner": { "type": "integer", "description": "Deal owner (user) ID" }, "percent": { "type": "integer", "description": "Probability percentage (0-100)" }, "status": { "type": "integer", "description": "Deal status (0=open, 1=won, 2=lost)", "enum": [ 0, 1, 2 ] }, "description": { "type": "string", "description": "Deal description" } } } }, "required": [ "PCID", "id", "deal" ] } ``` *** ## activecampaign\_update\_deal\_note Update a deal note **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dealId` | integer | Yes | — | Deal ID the note belongs to | | `noteId` | integer | Yes | — | Note ID to update | | `note` | object | Yes | — | The note value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dealId": { "type": "integer", "description": "Deal ID the note belongs to" }, "noteId": { "type": "integer", "description": "Note ID to update" }, "note": { "type": "object", "description": "The note value", "properties": { "note": { "type": "string", "description": "Updated note content" } }, "required": [ "note" ] } }, "required": [ "PCID", "dealId", "noteId", "note" ] } ``` *** ## activecampaign\_update\_deal\_pipeline Update a deal pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Pipeline (deal group) ID | | `dealGroup` | object | Yes | — | Deal Group | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Pipeline (deal group) ID" }, "dealGroup": { "type": "object", "description": "Deal Group", "properties": { "title": { "type": "string", "description": "Pipeline name" }, "currency": { "type": "string", "description": "Default currency code" }, "autoAssign": { "type": "integer", "description": "Auto-assign deals to users (0=off, 1=on)", "enum": [ 0, 1 ] }, "allgroups": { "type": "integer", "description": "Make pipeline accessible to all groups (0=no, 1=yes)", "enum": [ 0, 1 ] } } } }, "required": [ "PCID", "id", "dealGroup" ] } ``` *** ## activecampaign\_update\_list Update a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | List ID | | `list` | object | Yes | — | The list value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "List ID" }, "list": { "type": "object", "description": "The list value", "properties": { "name": { "type": "string", "description": "List name" }, "sender_url": { "type": "string", "description": "URL of the sender's website" }, "sender_reminder": { "type": "string", "description": "Reminder message for subscribers" }, "sender_name": { "type": "string", "description": "Name of the sender" }, "sender_addr1": { "type": "string", "description": "Sender's address line 1" }, "sender_city": { "type": "string", "description": "Sender's city" }, "sender_state": { "type": "string", "description": "Sender's state/province" }, "sender_zip": { "type": "string", "description": "Sender's postal/zip code" }, "sender_country": { "type": "string", "description": "Sender's country" } } } }, "required": [ "PCID", "id", "list" ] } ``` # activetrail Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/activetrail ActiveTrail Email Marketing **PinkConnect service:** `activetrail` | **Type:** Application (parent with child servers) | **PCID required:** Yes activetrail is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [activetrail-campaigns](/api-reference/mcp-servers/application/activetrail/activetrail-campaigns) | `/activetrail-campaigns` | 29 | ActiveTrail Campaigns - email, SMS, WhatsApp campaigns and reports | | [activetrail-contacts](/api-reference/mcp-servers/application/activetrail/activetrail-contacts) | `/activetrail-contacts` | 27 | ActiveTrail Contacts - manage contacts, groups, and mailing lists | | [activetrail-management](/api-reference/mcp-servers/application/activetrail/activetrail-management) | `/activetrail-management` | 25 | ActiveTrail Management - account settings, automations, and webhooks | # activetrail-campaigns Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/activetrail/activetrail-campaigns ActiveTrail Campaigns - email, SMS, WhatsApp campaigns and reports **Server path:** `/activetrail-campaigns` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`activetrail_campaigns_create_campaign`](#activetrail_campaigns_create_campaign) | Create a new email campaign for specific groups | | [`activetrail_campaigns_create_sms_campaign`](#activetrail_campaigns_create_sms_campaign) | Create a new SMS campaign | | [`activetrail_campaigns_create_template`](#activetrail_campaigns_create_template) | Create a new email template | | [`activetrail_campaigns_delete_campaign`](#activetrail_campaigns_delete_campaign) | Delete a campaign | | [`activetrail_campaigns_delete_template`](#activetrail_campaigns_delete_template) | Delete a template | | [`activetrail_campaigns_get_campaign`](#activetrail_campaigns_get_campaign) | Get a campaign by ID | | [`activetrail_campaigns_get_campaign_bounces`](#activetrail_campaigns_get_campaign_bounces) | Get campaign bounce data and domain breakdown | | [`activetrail_campaigns_get_campaign_click_details`](#activetrail_campaigns_get_campaign_click_details) | Get click report with link details for a campaign | | [`activetrail_campaigns_get_campaign_opens`](#activetrail_campaigns_get_campaign_opens) | Get contacts who opened a campaign | | [`activetrail_campaigns_get_campaign_report`](#activetrail_campaigns_get_campaign_report) | Get overview report for a specific campaign | | [`activetrail_campaigns_get_campaign_scheduling`](#activetrail_campaigns_get_campaign_scheduling) | Get campaign schedule settings | | [`activetrail_campaigns_get_campaign_unsubscribed`](#activetrail_campaigns_get_campaign_unsubscribed) | Get unsubscribed contacts from a campaign | | [`activetrail_campaigns_get_sms_campaign`](#activetrail_campaigns_get_sms_campaign) | Get an SMS campaign by ID | | [`activetrail_campaigns_get_sms_campaign_report`](#activetrail_campaigns_get_sms_campaign_report) | Get a specific SMS campaign summary report | | [`activetrail_campaigns_get_template`](#activetrail_campaigns_get_template) | Get a specific template | | [`activetrail_campaigns_list_campaign_reports`](#activetrail_campaigns_list_campaign_reports) | Get campaign reports with send, open, click, bounce data | | [`activetrail_campaigns_list_campaigns`](#activetrail_campaigns_list_campaigns) | Get account email campaigns | | [`activetrail_campaigns_list_sent_campaigns`](#activetrail_campaigns_list_sent_campaigns) | Get list of sent campaigns | | [`activetrail_campaigns_list_sms_campaign_reports`](#activetrail_campaigns_list_sms_campaign_reports) | Get SMS campaign reports | | [`activetrail_campaigns_list_sms_campaigns`](#activetrail_campaigns_list_sms_campaigns) | Get account SMS campaigns | | [`activetrail_campaigns_list_templates`](#activetrail_campaigns_list_templates) | Get saved email templates | | [`activetrail_campaigns_list_whats_app_templates`](#activetrail_campaigns_list_whats_app_templates) | Get all approved WhatsApp templates | | [`activetrail_campaigns_send_operational_email`](#activetrail_campaigns_send_operational_email) | Send an email operational message to individual emails (max 500) | | [`activetrail_campaigns_send_operational_email_to_contacts`](#activetrail_campaigns_send_operational_email_to_contacts) | Send an email operational message to contacts (max 500) | | [`activetrail_campaigns_send_whats_app_campaign`](#activetrail_campaigns_send_whats_app_campaign) | Create and send a WhatsApp campaign | | [`activetrail_campaigns_update_campaign`](#activetrail_campaigns_update_campaign) | Update a draft campaign | | [`activetrail_campaigns_update_campaign_scheduling`](#activetrail_campaigns_update_campaign_scheduling) | Update campaign schedule (draft only) | | [`activetrail_campaigns_update_sms_campaign`](#activetrail_campaigns_update_sms_campaign) | Update an SMS campaign | | [`activetrail_campaigns_update_template`](#activetrail_campaigns_update_template) | Update a template | *** ## activetrail\_campaigns\_create\_campaign Create a new email campaign for specific groups **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | object | No | — | Campaign content | | `groupIds` | integer\[] | Yes | — | Target group IDs | | `name` | string | Yes | — | Campaign name | | `subject` | string | Yes | — | Email subject line | | `type` | string | No | — | Campaign type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "object", "description": "Campaign content" }, "groupIds": { "type": "array", "items": { "type": "integer" }, "description": "Target group IDs" }, "name": { "type": "string", "description": "Campaign name" }, "subject": { "type": "string", "description": "Email subject line" }, "type": { "type": "string", "description": "Campaign type" } }, "required": [ "PCID", "groupIds", "name", "subject" ] } ``` *** ## activetrail\_campaigns\_create\_sms\_campaign Create a new SMS campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | Yes | — | SMS message content | | `groupIds` | integer\[] | Yes | — | Target group IDs | | `name` | string | Yes | — | Campaign name | | `sendDate` | string | No | — | Scheduled send date | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "SMS message content" }, "groupIds": { "type": "array", "items": { "type": "integer" }, "description": "Target group IDs" }, "name": { "type": "string", "description": "Campaign name" }, "sendDate": { "type": "string", "description": "Scheduled send date" } }, "required": [ "PCID", "content", "groupIds", "name" ] } ``` *** ## activetrail\_campaigns\_create\_template Create a new email template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `category` | string | No | — | Template category | | `content` | string | Yes | — | Template HTML content | | `name` | string | Yes | — | Template name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category": { "type": "string", "description": "Template category" }, "content": { "type": "string", "description": "Template HTML content" }, "name": { "type": "string", "description": "Template name" } }, "required": [ "PCID", "content", "name" ] } ``` *** ## activetrail\_campaigns\_delete\_campaign Delete a campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_delete\_template Delete a template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Template ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Template ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_get\_campaign Get a campaign by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_get\_campaign\_bounces Get campaign bounce data and domain breakdown **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_get\_campaign\_click\_details Get click report with link details for a campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_get\_campaign\_opens Get contacts who opened a campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | | `Groupid` | integer | No | — | Filter by group | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" }, "Groupid": { "type": "integer", "description": "Filter by group" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_get\_campaign\_report Get overview report for a specific campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_get\_campaign\_scheduling Get campaign schedule settings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_get\_campaign\_unsubscribed Get unsubscribed contacts from a campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_get\_sms\_campaign Get an SMS campaign by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | SMS campaign ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "SMS campaign ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_get\_sms\_campaign\_report Get a specific SMS campaign summary report **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | SMS campaign ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "SMS campaign ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_get\_template Get a specific template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Template ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Template ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_list\_campaign\_reports Get campaign reports with send, open, click, bounce data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_campaigns\_list\_campaigns Get account email campaigns **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `MailingListId` | integer | No | — | Filter by mailing list | | `ContentCategoryId` | integer | No | — | Filter by content category | | `SearchTerm` | string | No | — | Search term to filter results | | `SendType` | string | No | — | Send Type | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "MailingListId": { "type": "integer", "description": "Filter by mailing list" }, "ContentCategoryId": { "type": "integer", "description": "Filter by content category" }, "SearchTerm": { "type": "string", "description": "Search term to filter results" }, "SendType": { "type": "string", "description": "Send Type" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_campaigns\_list\_sent\_campaigns Get list of sent campaigns ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_campaigns\_list\_sms\_campaign\_reports Get SMS campaign reports **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `SendType` | string | No | — | Send Type | | `SearchTerm` | string | No | — | Search term to filter results | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SendType": { "type": "string", "description": "Send Type" }, "SearchTerm": { "type": "string", "description": "Search term to filter results" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_campaigns\_list\_sms\_campaigns Get account SMS campaigns **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `IsIncludeNotSent` | boolean | No | — | Include unsent campaigns | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `SearchTerm` | string | No | — | Search term to filter results | | `FilterType` | string | No | — | Filter Type | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "IsIncludeNotSent": { "type": "boolean", "description": "Include unsent campaigns" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "SearchTerm": { "type": "string", "description": "Search term to filter results" }, "FilterType": { "type": "string", "description": "Filter Type" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_campaigns\_list\_templates Get saved email templates ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_campaigns\_list\_whats\_app\_templates Get all approved WhatsApp templates ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_campaigns\_send\_operational\_email Send an email operational message to individual emails (max 500) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | Yes | — | Email HTML content | | `email` | string | Yes | — | Recipient email address | | `subject` | string | Yes | — | Email subject | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Email HTML content" }, "email": { "type": "string", "description": "Recipient email address" }, "subject": { "type": "string", "description": "Email subject" } }, "required": [ "PCID", "content", "email", "subject" ] } ``` *** ## activetrail\_campaigns\_send\_operational\_email\_to\_contacts Send an email operational message to contacts (max 500) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contactId` | string | Yes | — | Contact ID | | `content` | string | Yes | — | Email HTML content | | `subject` | string | Yes | — | Email subject | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contactId": { "type": "string", "description": "Contact ID" }, "content": { "type": "string", "description": "Email HTML content" }, "subject": { "type": "string", "description": "Email subject" } }, "required": [ "PCID", "contactId", "content", "subject" ] } ``` *** ## activetrail\_campaigns\_send\_whats\_app\_campaign Create and send a WhatsApp campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attachment` | object | No | — | File attachment | | `contacts` | object\[] | Yes | — | Target contacts | | `content` | string | No | — | Message content | | `templateSid` | string | Yes | — | Approved WhatsApp template SID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attachment": { "type": "object", "description": "File attachment" }, "contacts": { "type": "array", "items": { "type": "object" }, "description": "Target contacts" }, "content": { "type": "string", "description": "Message content" }, "templateSid": { "type": "string", "description": "Approved WhatsApp template SID" } }, "required": [ "PCID", "contacts", "templateSid" ] } ``` *** ## activetrail\_campaigns\_update\_campaign Update a draft campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | | `content` | object | No | — | The content value | | `groupIds` | integer\[] | No | — | Group Ids | | `name` | string | No | — | The name value | | `subject` | string | No | — | The subject value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" }, "content": { "type": "object", "description": "The content value" }, "groupIds": { "type": "array", "items": { "type": "integer" }, "description": "Group Ids" }, "name": { "type": "string", "description": "The name value" }, "subject": { "type": "string", "description": "The subject value" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_update\_campaign\_scheduling Update campaign schedule (draft only) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Campaign ID | | `recurring` | boolean | No | — | Whether campaign is recurring | | `sendDate` | string | No | — | Scheduled send date | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Campaign ID" }, "recurring": { "type": "boolean", "description": "Whether campaign is recurring" }, "sendDate": { "type": "string", "description": "Scheduled send date" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_update\_sms\_campaign Update an SMS campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | SMS campaign ID | | `content` | string | No | — | The content value | | `groupIds` | integer\[] | No | — | Group Ids | | `name` | string | No | — | The name value | | `sendDate` | string | No | — | Send Date | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "SMS campaign ID" }, "content": { "type": "string", "description": "The content value" }, "groupIds": { "type": "array", "items": { "type": "integer" }, "description": "Group Ids" }, "name": { "type": "string", "description": "The name value" }, "sendDate": { "type": "string", "description": "Send Date" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_campaigns\_update\_template Update a template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Template ID | | `category` | string | No | — | The category value | | `content` | string | No | — | The content value | | `name` | string | No | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Template ID" }, "category": { "type": "string", "description": "The category value" }, "content": { "type": "string", "description": "The content value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "id" ] } ``` # activetrail-contacts Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/activetrail/activetrail-contacts ActiveTrail Contacts - manage contacts, groups, and mailing lists **Server path:** `/activetrail-contacts` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`activetrail_contacts_add_group_member`](#activetrail_contacts_add_group_member) | Add a contact to a group | | [`activetrail_contacts_add_mailing_list_member`](#activetrail_contacts_add_mailing_list_member) | Add a member to a mailing list | | [`activetrail_contacts_create_contact`](#activetrail_contacts_create_contact) | Create a new contact | | [`activetrail_contacts_create_group`](#activetrail_contacts_create_group) | Create a new group | | [`activetrail_contacts_create_mailing_list`](#activetrail_contacts_create_mailing_list) | Create a new mailing list | | [`activetrail_contacts_delete_contact`](#activetrail_contacts_delete_contact) | Remove a contact from account | | [`activetrail_contacts_delete_group`](#activetrail_contacts_delete_group) | Delete a group | | [`activetrail_contacts_delete_mailing_list`](#activetrail_contacts_delete_mailing_list) | Delete a mailing list | | [`activetrail_contacts_get_contact`](#activetrail_contacts_get_contact) | Get individual contact details | | [`activetrail_contacts_get_contact_activity`](#activetrail_contacts_get_contact_activity) | Get contact activity on emails sent to them | | [`activetrail_contacts_get_contact_groups`](#activetrail_contacts_get_contact_groups) | Get groups membership for a contact | | [`activetrail_contacts_get_contact_mailing_lists`](#activetrail_contacts_get_contact_mailing_lists) | Get contact mailing list memberships | | [`activetrail_contacts_get_group`](#activetrail_contacts_get_group) | Get a specific group by ID | | [`activetrail_contacts_get_mailing_list`](#activetrail_contacts_get_mailing_list) | Get a mailing list by ID | | [`activetrail_contacts_import_contacts`](#activetrail_contacts_import_contacts) | Import contacts to a group (max 1000 per call) | | [`activetrail_contacts_list_contact_subscriptions`](#activetrail_contacts_list_contact_subscriptions) | Get contact subscription status and source | | [`activetrail_contacts_list_contacts`](#activetrail_contacts_list_contacts) | Get account contacts list with filtering | | [`activetrail_contacts_list_group_members`](#activetrail_contacts_list_group_members) | Get all group member contacts | | [`activetrail_contacts_list_groups`](#activetrail_contacts_list_groups) | Get all account groups | | [`activetrail_contacts_list_mailing_list_members`](#activetrail_contacts_list_mailing_list_members) | Get all mailing list members | | [`activetrail_contacts_list_mailing_lists`](#activetrail_contacts_list_mailing_lists) | Get account mailing lists | | [`activetrail_contacts_list_subscribers`](#activetrail_contacts_list_subscribers) | Get subscribed contacts with status source | | [`activetrail_contacts_list_unsubscribers`](#activetrail_contacts_list_unsubscribers) | Get unsubscribed contacts with status source | | [`activetrail_contacts_remove_group_member`](#activetrail_contacts_remove_group_member) | Remove a contact from a group | | [`activetrail_contacts_remove_mailing_list_member`](#activetrail_contacts_remove_mailing_list_member) | Remove a member from a mailing list | | [`activetrail_contacts_update_contact`](#activetrail_contacts_update_contact) | Update an existing contact | | [`activetrail_contacts_update_group`](#activetrail_contacts_update_group) | Update a group | *** ## activetrail\_contacts\_add\_group\_member Add a contact to a group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Group ID | | `contactId` | string | Yes | — | Contact ID to add | | `status` | string | No | — | Subscription status | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Group ID" }, "contactId": { "type": "string", "description": "Contact ID to add" }, "status": { "type": "string", "description": "Subscription status" } }, "required": [ "PCID", "id", "contactId" ] } ``` *** ## activetrail\_contacts\_add\_mailing\_list\_member Add a member to a mailing list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Mailing list ID | | `contactId` | string | Yes | — | Contact ID to add | | `status` | string | No | — | Subscription status | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Mailing list ID" }, "contactId": { "type": "string", "description": "Contact ID to add" }, "status": { "type": "string", "description": "Subscription status" } }, "required": [ "PCID", "id", "contactId" ] } ``` *** ## activetrail\_contacts\_create\_contact Create a new contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `customFields` | object | No | — | Custom field values | | `email` | string | No | — | Contact email address | | `firstName` | string | No | — | Contact first name | | `lastName` | string | No | — | Contact last name | | `phone` | string | No | — | Contact phone number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "customFields": { "type": "object", "description": "Custom field values" }, "email": { "type": "string", "description": "Contact email address" }, "firstName": { "type": "string", "description": "Contact first name" }, "lastName": { "type": "string", "description": "Contact last name" }, "phone": { "type": "string", "description": "Contact phone number" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_contacts\_create\_group Create a new group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `description` | string | No | — | Group description | | `name` | string | Yes | — | Group name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "Group description" }, "name": { "type": "string", "description": "Group name" } }, "required": [ "PCID", "name" ] } ``` *** ## activetrail\_contacts\_create\_mailing\_list Create a new mailing list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `description` | string | No | — | Mailing list description | | `name` | string | Yes | — | Mailing list name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "Mailing list description" }, "name": { "type": "string", "description": "Mailing list name" } }, "required": [ "PCID", "name" ] } ``` *** ## activetrail\_contacts\_delete\_contact Remove a contact from account **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Contact ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Contact ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_delete\_group Delete a group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Group ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Group ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_delete\_mailing\_list Delete a mailing list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Mailing list ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Mailing list ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_get\_contact Get individual contact details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Contact ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Contact ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_get\_contact\_activity Get contact activity on emails sent to them **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Contact ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Contact ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_get\_contact\_groups Get groups membership for a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Contact ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Contact ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_get\_contact\_mailing\_lists Get contact mailing list memberships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Contact ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Contact ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_get\_group Get a specific group by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Group ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Group ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_get\_mailing\_list Get a mailing list by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Mailing list ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Mailing list ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_import\_contacts Import contacts to a group (max 1000 per call) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contacts` | object\[] | Yes | — | Contact objects to import | | `groupId` | integer | Yes | — | Target group ID | | `status` | string | No | — | Subscription status for imported contacts | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contacts": { "type": "array", "items": { "type": "object" }, "description": "Contact objects to import" }, "groupId": { "type": "integer", "description": "Target group ID" }, "status": { "type": "string", "description": "Subscription status for imported contacts" } }, "required": [ "PCID", "contacts", "groupId" ] } ``` *** ## activetrail\_contacts\_list\_contact\_subscriptions Get contact subscription status and source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `FromDate` | string | No | — | Start date | | `ToDate` | string | No | — | End date | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "FromDate": { "type": "string", "description": "Start date" }, "ToDate": { "type": "string", "description": "End date" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_contacts\_list\_contacts Get account contacts list with filtering **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `CustomerStates` | string | No | — | Filter by status: active, unsubscribed, bounced | | `SearchTerm` | string | No | — | Search criteria | | `FromDate` | string | No | — | Date range start | | `ToDate` | string | No | — | Date range end | | `Page` | integer | No | — | Pagination page number | | `Limit` | integer | No | — | Results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CustomerStates": { "type": "string", "description": "Filter by status: active, unsubscribed, bounced" }, "SearchTerm": { "type": "string", "description": "Search criteria" }, "FromDate": { "type": "string", "description": "Date range start" }, "ToDate": { "type": "string", "description": "Date range end" }, "Page": { "type": "integer", "description": "Pagination page number" }, "Limit": { "type": "integer", "description": "Results per page" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_contacts\_list\_group\_members Get all group member contacts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Group ID | | `CustomerStates` | string | No | — | Customer States | | `SearchTerm` | string | No | — | Search term to filter results | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Group ID" }, "CustomerStates": { "type": "string", "description": "Customer States" }, "SearchTerm": { "type": "string", "description": "Search term to filter results" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_list\_groups Get all account groups **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `SearchTerm` | string | No | — | Group name filter | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SearchTerm": { "type": "string", "description": "Group name filter" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_contacts\_list\_mailing\_list\_members Get all mailing list members **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Mailing list ID | | `CustomerStates` | string | No | — | Customer States | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Mailing list ID" }, "CustomerStates": { "type": "string", "description": "Customer States" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_list\_mailing\_lists Get account mailing lists ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_contacts\_list\_subscribers Get subscribed contacts with status source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_contacts\_list\_unsubscribers Get unsubscribed contacts with status source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_contacts\_remove\_group\_member Remove a contact from a group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Group ID | | `memberId` | string | Yes | — | Contact ID to remove | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Group ID" }, "memberId": { "type": "string", "description": "Contact ID to remove" } }, "required": [ "PCID", "id", "memberId" ] } ``` *** ## activetrail\_contacts\_remove\_mailing\_list\_member Remove a member from a mailing list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Mailing list ID | | `memberId` | string | Yes | — | Contact ID to remove | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Mailing list ID" }, "memberId": { "type": "string", "description": "Contact ID to remove" } }, "required": [ "PCID", "id", "memberId" ] } ``` *** ## activetrail\_contacts\_update\_contact Update an existing contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Contact ID | | `customFields` | object | No | — | Custom Fields | | `email` | string | No | — | The email value | | `firstName` | string | No | — | First Name | | `lastName` | string | No | — | Last Name | | `phone` | string | No | — | The phone value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Contact ID" }, "customFields": { "type": "object", "description": "Custom Fields" }, "email": { "type": "string", "description": "The email value" }, "firstName": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "phone": { "type": "string", "description": "The phone value" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_contacts\_update\_group Update a group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Group ID | | `description` | string | No | — | The description value | | `name` | string | No | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Group ID" }, "description": { "type": "string", "description": "The description value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "id" ] } ``` # activetrail-management Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/activetrail/activetrail-management ActiveTrail Management - account settings, automations, and webhooks **Server path:** `/activetrail-management` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`activetrail_management_create_content_category`](#activetrail_management_create_content_category) | Create a new content category | | [`activetrail_management_create_webhook`](#activetrail_management_create_webhook) | Create a new webhook | | [`activetrail_management_delete_content_category`](#activetrail_management_delete_content_category) | Delete a content category by ID | | [`activetrail_management_delete_webhook`](#activetrail_management_delete_webhook) | Delete a webhook | | [`activetrail_management_get_account_balance`](#activetrail_management_get_account_balance) | Get email and SMS credit balance | | [`activetrail_management_get_automation`](#activetrail_management_get_automation) | Get automation details by ID | | [`activetrail_management_get_automation_activation`](#activetrail_management_get_automation_activation) | Get automation activation status | | [`activetrail_management_get_automation_contacts_ended`](#activetrail_management_get_automation_contacts_ended) | Get contacts that finished an automation | | [`activetrail_management_get_automation_contacts_started`](#activetrail_management_get_automation_contacts_started) | Get contacts that started an automation | | [`activetrail_management_get_automation_design`](#activetrail_management_get_automation_design) | Get complete automation design | | [`activetrail_management_get_automation_overview_report`](#activetrail_management_get_automation_overview_report) | Get summary report for an automation | | [`activetrail_management_get_automation_trigger_info`](#activetrail_management_get_automation_trigger_info) | Get automation trigger information | | [`activetrail_management_get_contact_fields`](#activetrail_management_get_contact_fields) | Get account contact fields filtered by type | | [`activetrail_management_get_contact_growth_report`](#activetrail_management_get_contact_growth_report) | Get daily contact growth metrics (active/inactive) | | [`activetrail_management_get_content_category`](#activetrail_management_get_content_category) | Get a specific content category by ID | | [`activetrail_management_get_executive_report`](#activetrail_management_get_executive_report) | Get executive-level account reports | | [`activetrail_management_get_sending_profiles`](#activetrail_management_get_sending_profiles) | Get email sending profiles configured for account | | [`activetrail_management_get_sms_sending_profiles`](#activetrail_management_get_sms_sending_profiles) | Get SMS sending profiles for account | | [`activetrail_management_get_webhook`](#activetrail_management_get_webhook) | Get a specific webhook by ID | | [`activetrail_management_list_automations`](#activetrail_management_list_automations) | Get account automations | | [`activetrail_management_list_content_categories`](#activetrail_management_list_content_categories) | Get all account content categories | | [`activetrail_management_list_webhooks`](#activetrail_management_list_webhooks) | Get account webhooks | | [`activetrail_management_update_automation_activation`](#activetrail_management_update_automation_activation) | Activate or deactivate an automation | | [`activetrail_management_update_content_category`](#activetrail_management_update_content_category) | Update a content category | | [`activetrail_management_update_webhook`](#activetrail_management_update_webhook) | Update a webhook | *** ## activetrail\_management\_create\_content\_category Create a new content category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `description` | string | No | — | Category description | | `name` | string | Yes | — | Category name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "Category description" }, "name": { "type": "string", "description": "Category name" } }, "required": [ "PCID", "name" ] } ``` *** ## activetrail\_management\_create\_webhook Create a new webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `eventType` | string | Yes | — | Event type to listen for | | `state` | string | No | — | Webhook state | | `url` | string | Yes | — | Webhook callback URL | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "eventType": { "type": "string", "description": "Event type to listen for" }, "state": { "type": "string", "description": "Webhook state" }, "url": { "type": "string", "description": "Webhook callback URL" } }, "required": [ "PCID", "eventType", "url" ] } ``` *** ## activetrail\_management\_delete\_content\_category Delete a content category by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Category ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Category ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_delete\_webhook Delete a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Webhook ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Webhook ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_get\_account\_balance Get email and SMS credit balance ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_management\_get\_automation Get automation details by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Automation ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Automation ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_get\_automation\_activation Get automation activation status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Automation ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Automation ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_get\_automation\_contacts\_ended Get contacts that finished an automation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Automation ID | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Filter` | string | No | — | The filter value | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Automation ID" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Filter": { "type": "string", "description": "The filter value" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_get\_automation\_contacts\_started Get contacts that started an automation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Automation ID | | `FromDate` | string | No | — | Start date for filtering (inclusive) | | `ToDate` | string | No | — | End date for filtering (inclusive) | | `Filter` | string | No | — | The filter value | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Automation ID" }, "FromDate": { "type": "string", "description": "Start date for filtering (inclusive)" }, "ToDate": { "type": "string", "description": "End date for filtering (inclusive)" }, "Filter": { "type": "string", "description": "The filter value" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_get\_automation\_design Get complete automation design **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Automation ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Automation ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_get\_automation\_overview\_report Get summary report for an automation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Automation ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Automation ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_get\_automation\_trigger\_info Get automation trigger information **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Automation ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Automation ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_get\_contact\_fields Get account contact fields filtered by type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `FieldsType` | string | No | — | Type of fields to filter | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "FieldsType": { "type": "string", "description": "Type of fields to filter" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_management\_get\_contact\_growth\_report Get daily contact growth metrics (active/inactive) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `FromDate` | string | No | — | Start date | | `ToDate` | string | No | — | End date (default 3 months back) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "FromDate": { "type": "string", "description": "Start date" }, "ToDate": { "type": "string", "description": "End date (default 3 months back)" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_management\_get\_content\_category Get a specific content category by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Category ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Category ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_get\_executive\_report Get executive-level account reports ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_management\_get\_sending\_profiles Get email sending profiles configured for account ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_management\_get\_sms\_sending\_profiles Get SMS sending profiles for account ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_management\_get\_webhook Get a specific webhook by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Webhook ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Webhook ID" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_list\_automations Get account automations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `StateType` | string | No | — | Filter by state | | `Page` | integer | No | — | Page number for pagination | | `Limit` | integer | No | — | Maximum number of results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "StateType": { "type": "string", "description": "Filter by state" }, "Page": { "type": "integer", "description": "Page number for pagination" }, "Limit": { "type": "integer", "description": "Maximum number of results to return" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_management\_list\_content\_categories Get all account content categories ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_management\_list\_webhooks Get account webhooks **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `EventType` | string | No | — | Event Type | | `StateType` | string | No | — | State Type | | `TargetType` | string | No | — | Target Type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "EventType": { "type": "string", "description": "Event Type" }, "StateType": { "type": "string", "description": "State Type" }, "TargetType": { "type": "string", "description": "Target Type" } }, "required": [ "PCID" ] } ``` *** ## activetrail\_management\_update\_automation\_activation Activate or deactivate an automation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Automation ID | | `active` | boolean | Yes | — | Whether the automation should be active | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Automation ID" }, "active": { "type": "boolean", "description": "Whether the automation should be active" } }, "required": [ "PCID", "id", "active" ] } ``` *** ## activetrail\_management\_update\_content\_category Update a content category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Category ID | | `description` | string | No | — | The description value | | `name` | string | No | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Category ID" }, "description": { "type": "string", "description": "The description value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "id" ] } ``` *** ## activetrail\_management\_update\_webhook Update a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Webhook ID | | `eventType` | string | No | — | Event Type | | `state` | string | No | — | The state value | | `url` | string | No | — | The url value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Webhook ID" }, "eventType": { "type": "string", "description": "Event Type" }, "state": { "type": "string", "description": "The state value" }, "url": { "type": "string", "description": "The url value" } }, "required": [ "PCID", "id" ] } ``` # adobe-analytics Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/adobe-analytics Adobe Analytics - reporting, segments, calculated metrics, projects, and component management **PinkConnect service:** `adobe-analytics` | **Type:** Application (parent with child servers) | **PCID required:** Yes adobe-analytics is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [adobe-analytics-management](/api-reference/mcp-servers/application/adobe-analytics/adobe-analytics-management) | `/adobe-analytics-management` | 30 | Adobe Analytics Management - projects, date ranges, tags, shares, users, and audit logs | | [adobe-analytics-reporting](/api-reference/mcp-servers/application/adobe-analytics/adobe-analytics-reporting) | `/adobe-analytics-reporting` | 22 | Adobe Analytics Reporting - reports, segments, calculated metrics, dimensions, metrics, and report suites | # adobe-analytics-management Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/adobe-analytics/adobe-analytics-management Adobe Analytics Management - projects, date ranges, tags, shares, users, and audit logs **Server path:** `/adobe-analytics-management` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`adobe_analytics_management_create_date_range`](#adobe_analytics_management_create_date_range) | Creates configuration for a DateRange. | | [`adobe_analytics_management_delete_date_range`](#adobe_analytics_management_delete_date_range) | Deletes a DateRange. | | [`adobe_analytics_management_delete_share`](#adobe_analytics_management_delete_share) | Removes the shareId and all associations from that share | | [`adobe_analytics_management_delete_tag`](#adobe_analytics_management_delete_tag) | Removes the tagId and all associations from that tag to any components | | [`adobe_analytics_management_delete_tag_items`](#adobe_analytics_management_delete_tag_items) | Disassociates all tags from the given components | | [`adobe_analytics_management_find_all`](#adobe_analytics_management_find_all) | Returns a list of users for the current user's login company | | [`adobe_analytics_management_find_all_for_company`](#adobe_analytics_management_find_all_for_company) | Returns a list of tags for the current user's company | | [`adobe_analytics_management_find_all_shares_for_company`](#adobe_analytics_management_find_all_shares_for_company) | Returns a list of shares for the current user's company | | [`adobe_analytics_management_get_components_by_tag_name`](#adobe_analytics_management_get_components_by_tag_name) | Retrieves component ids associated with the given tag names | | [`adobe_analytics_management_get_current_user`](#adobe_analytics_management_get_current_user) | Get the current user | | [`adobe_analytics_management_get_date_range`](#adobe_analytics_management_get_date_range) | Retrieves configuration for a DateRange. | | [`adobe_analytics_management_get_date_ranges`](#adobe_analytics_management_get_date_ranges) | Returns a list of dateranges for the user | | [`adobe_analytics_management_get_share_by_id`](#adobe_analytics_management_get_share_by_id) | Retrieves an share by its id | | [`adobe_analytics_management_get_tag_by_id`](#adobe_analytics_management_get_tag_by_id) | Retrieves an tag by its id | | [`adobe_analytics_management_get_tag_list_by_component_id_and_component_type`](#adobe_analytics_management_get_tag_list_by_component_id_and_component_type) | Retrieves a tags for a given component by componentId and componentType | | [`adobe_analytics_management_get_usage_access_logs`](#adobe_analytics_management_get_usage_access_logs) | Retrieves usage and access logs for the search criteria provided. | | [`adobe_analytics_management_projects_create_project`](#adobe_analytics_management_projects_create_project) | Creates a single project. | | [`adobe_analytics_management_projects_delete_project`](#adobe_analytics_management_projects_delete_project) | deletes a project. | | [`adobe_analytics_management_projects_get_project`](#adobe_analytics_management_projects_get_project) | Retrieves configuration for a Project. | | [`adobe_analytics_management_projects_get_projects`](#adobe_analytics_management_projects_get_projects) | Returns a list of projects for the user | | [`adobe_analytics_management_projects_update_project`](#adobe_analytics_management_projects_update_project) | Updates configuration for a project. | | [`adobe_analytics_management_projects_validate_project`](#adobe_analytics_management_projects_validate_project) | Validates a Project definition | | [`adobe_analytics_management_save_share`](#adobe_analytics_management_save_share) | Saves the given share for the current user's company | | [`adobe_analytics_management_save_tag_component_list`](#adobe_analytics_management_save_tag_component_list) | Tag a component with one or many tags at once. WARNING: Authoritative; deletes/overwrites all pre-existing associations | | [`adobe_analytics_management_save_tag_list`](#adobe_analytics_management_save_tag_list) | Saves the given tag(s) for the current user's company | | [`adobe_analytics_management_search_component_shares`](#adobe_analytics_management_search_component_shares) | search for shares for several components at once | | [`adobe_analytics_management_search_component_tags_2`](#adobe_analytics_management_search_component_tags_2) | search for tags for several components at once | | [`adobe_analytics_management_shared_to_me`](#adobe_analytics_management_shared_to_me) | get components shared with the current user by type | | [`adobe_analytics_management_update_date_range`](#adobe_analytics_management_update_date_range) | Updates configuration for a DateRange. | | [`adobe_analytics_management_update_shares`](#adobe_analytics_management_update_shares) | Share components with users. WARNING: Authoritative; deletes/overwrites all pre-existing shares for the given components | *** ## adobe\_analytics\_management\_create\_date\_range Creates configuration for a DateRange. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `locale` | string | No | — | Locale or language code | | `expansion` | string\[] | No | — | Comma-delimited list of additional date range metadata fields to include on response. | | `created` | string | No | — | The created value | | `definition` | object | No | — | The definition value | | `description` | string | No | — | The description value | | `id` | string | No | — | System generated id | | `modified` | string | No | — | The modified value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `reportSuiteName` | string | No | — | The report suite name for which the component was created/updated | | `rsid` | string | No | — | The report suite id for which the component was created/updated | | `siteTitle` | string | No | — | Site Title | | `tags` | object\[] | No | — | The tags value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "locale": { "type": "string", "description": "Locale or language code" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "definition", "ownerFullName", "modified", "tags" ] }, "description": "Comma-delimited list of additional date range metadata fields to include on response.", "enum": [ "definition", "ownerFullName", "modified", "tags" ] }, "created": { "type": "string", "description": "The created value" }, "definition": { "type": "object", "description": "The definition value" }, "description": { "type": "string", "description": "The description value" }, "id": { "type": "string", "description": "System generated id" }, "modified": { "type": "string", "description": "The modified value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "type": "object", "description": "The owner value", "properties": { "id": { "type": "integer", "description": "the login id of the owner" }, "name": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" }, "login": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" } }, "required": [ "id" ] }, "reportSuiteName": { "type": "string", "description": "The report suite name for which the component was created/updated" }, "rsid": { "type": "string", "description": "The report suite id for which the component was created/updated" }, "siteTitle": { "type": "string", "description": "Site Title" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "the tag id" }, "name": { "type": "string", "description": "the tag name" }, "description": { "type": "string", "description": "the tag description" }, "components": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string" }, "componentId": { "type": "string" }, "tags": { "type": "array" } } }, "description": "the list of components that have been tagged with this tag" } } }, "description": "The tags value" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_delete\_date\_range Deletes a DateRange. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dateRangeId` | string | Yes | — | The id of the date range to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dateRangeId": { "type": "string", "description": "The id of the date range to delete" } }, "required": [ "PCID", "dateRangeId" ] } ``` *** ## adobe\_analytics\_management\_delete\_share Removes the shareId and all associations from that share **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The shareId to be deleted | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The shareId to be deleted" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_management\_delete\_tag Removes the tagId and all associations from that tag to any components **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The tagId to be deleted | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The tagId to be deleted" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_management\_delete\_tag\_items Disassociates all tags from the given components **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `componentIds` | string | Yes | — | Comma-separated list of componentIds to operate on. | | `componentType` | string | Yes | — | The component type to operate on. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "componentIds": { "type": "string", "description": "Comma-separated list of componentIds to operate on." }, "componentType": { "type": "string", "description": "The component type to operate on.", "enum": [ "segment", "dashboard", "bookmark", "calculatedMetric", "project", "dateRange", "metric", "dimension", "virtualReportSuite", "scheduledJob", "alert", "classificationSet" ] } }, "required": [ "PCID", "componentIds", "componentType" ] } ``` *** ## adobe\_analytics\_management\_find\_all Returns a list of users for the current user's login company **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_find\_all\_for\_company Returns a list of tags for the current user's company **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_find\_all\_shares\_for\_company Returns a list of shares for the current user's company **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_get\_components\_by\_tag\_name Retrieves component ids associated with the given tag names **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `tagNames` | string | Yes | — | Comma separated list of tag names. | | `componentType` | string | Yes | — | The component type to operate on. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tagNames": { "type": "string", "description": "Comma separated list of tag names." }, "componentType": { "type": "string", "description": "The component type to operate on.", "enum": [ "segment", "dashboard", "bookmark", "calculatedMetric", "project", "dateRange", "metric", "dimension", "virtualReportSuite", "scheduledJob", "alert", "classificationSet" ] } }, "required": [ "PCID", "tagNames", "componentType" ] } ``` *** ## adobe\_analytics\_management\_get\_current\_user Get the current user ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_get\_date\_range Retrieves configuration for a DateRange. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dateRangeId` | string | Yes | — | The DateRange id for which to retrieve information | | `locale` | string | No | — | Locale or language code | | `expansion` | string\[] | No | — | Comma-delimited list of additional date range metadata fields to include on response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dateRangeId": { "type": "string", "description": "The DateRange id for which to retrieve information" }, "locale": { "type": "string", "description": "Locale or language code" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "definition", "ownerFullName", "modified", "tags" ] }, "description": "Comma-delimited list of additional date range metadata fields to include on response.", "enum": [ "definition", "ownerFullName", "modified", "tags" ] } }, "required": [ "PCID", "dateRangeId" ] } ``` *** ## adobe\_analytics\_management\_get\_date\_ranges Returns a list of dateranges for the user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `locale` | string | No | — | Locale or language code | | `filterByIds` | string | No | — | Filter list to only include date ranges in the specified list (comma-delimited list of IDs) | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | | `expansion` | string\[] | No | — | Comma-delimited list of additional date range metadata fields to include on response. | | `includeType` | string\[] | No | — | Include additional date ranges not owned by user. The "all" option takes precedence over "shared" | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "locale": { "type": "string", "description": "Locale or language code" }, "filterByIds": { "type": "string", "description": "Filter list to only include date ranges in the specified list (comma-delimited list of IDs)" }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "definition", "ownerFullName", "modified", "tags" ] }, "description": "Comma-delimited list of additional date range metadata fields to include on response.", "enum": [ "definition", "ownerFullName", "modified", "tags" ] }, "includeType": { "type": "array", "items": { "type": "string", "enum": [ "all", "shared", "templates" ] }, "description": "Include additional date ranges not owned by user. The \"all\" option takes precedence over \"shared\"", "enum": [ "all", "shared", "templates" ] } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_get\_share\_by\_id Retrieves an share by its id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Share ID to be retrieved | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Share ID to be retrieved" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_management\_get\_tag\_by\_id Retrieves an tag by its id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Tag ID to be retrieved | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Tag ID to be retrieved" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_management\_get\_tag\_list\_by\_component\_id\_and\_component\_type Retrieves a tags for a given component by componentId and componentType **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `componentId` | string | Yes | — | The componentId to operate on. Currently this is just the segmentId. | | `componentType` | string | Yes | — | The component type to operate on. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "componentId": { "type": "string", "description": "The componentId to operate on. Currently this is just the segmentId." }, "componentType": { "type": "string", "description": "The component type to operate on.", "enum": [ "segment", "dashboard", "bookmark", "calculatedMetric", "project", "dateRange", "metric", "dimension", "virtualReportSuite", "scheduledJob", "alert", "classificationSet" ] } }, "required": [ "PCID", "componentId", "componentType" ] } ``` *** ## adobe\_analytics\_management\_get\_usage\_access\_logs Retrieves usage and access logs for the search criteria provided. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `startDate` | string | Yes | — | Start date for the maximum of a 3 month period. | | `endDate` | string | Yes | — | End date for the maximum of a 3 month period. | | `login` | string | No | — | The login value of the user you want to filter logs by. | | `ip` | string | No | — | The IP address you want to filter logs by. | | `rsid` | string | No | — | The report suite ID you want to filter logs by. | | `eventType` | string | No | — | The numeric id for the event type you want to filter logs by. | | `event` | string | No | — | The event description you want to filter logs by. No wildcards permitted. | | `limit` | integer | No | — | Number of results per page. | | `page` | integer | No | — | Page number (base 0 - first page is "0"). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "startDate": { "type": "string", "description": "Start date for the maximum of a 3 month period." }, "endDate": { "type": "string", "description": "End date for the maximum of a 3 month period." }, "login": { "type": "string", "description": "The login value of the user you want to filter logs by." }, "ip": { "type": "string", "description": "The IP address you want to filter logs by." }, "rsid": { "type": "string", "description": "The report suite ID you want to filter logs by." }, "eventType": { "type": "string", "description": "The numeric id for the event type you want to filter logs by." }, "event": { "type": "string", "description": "The event description you want to filter logs by. No wildcards permitted." }, "limit": { "type": "integer", "description": "Number of results per page." }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")." } }, "required": [ "PCID", "startDate", "endDate" ] } ``` *** ## adobe\_analytics\_management\_projects\_create\_project Creates a single project. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `expansion` | string\[] | No | — | Comma-delimited list of additional project metadata fields to include on response. | | `locale` | string | No | — | Locale or language code | | `accessLevel` | string | No | — | Access Level | | `created` | string | No | — | The created value | | `definition` | object | No | — | The definition value | | `description` | string | No | — | The description value | | `externalReferences` | object | No | — | External References | | `id` | string | No | — | System generated id | | `modified` | string | No | — | The modified value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `reportSuiteName` | string | No | — | The report suite name for which the component was created/updated | | `rsid` | string | No | — | The report suite id for which the component was created/updated | | `shares` | object\[] | No | — | The shares value | | `tags` | object\[] | No | — | The tags value | | `type` | string | No | — | The type value | | `versionNotes` | string | No | — | Version Notes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "shares", "tags", "accessLevel", "modified", "externalReferences", "definition" ] }, "description": "Comma-delimited list of additional project metadata fields to include on response." }, "locale": { "type": "string", "description": "Locale or language code" }, "accessLevel": { "type": "string", "description": "Access Level" }, "created": { "type": "string", "description": "The created value" }, "definition": { "type": "object", "description": "The definition value" }, "description": { "type": "string", "description": "The description value" }, "externalReferences": { "type": "object", "description": "External References" }, "id": { "type": "string", "description": "System generated id" }, "modified": { "type": "string", "description": "The modified value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "type": "object", "description": "The owner value", "properties": { "id": { "type": "integer", "description": "the login id of the owner" }, "name": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" }, "login": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" } }, "required": [ "id" ] }, "reportSuiteName": { "type": "string", "description": "The report suite name for which the component was created/updated" }, "rsid": { "type": "string", "description": "The report suite id for which the component was created/updated" }, "shares": { "type": "array", "items": { "type": "object" }, "description": "The shares value" }, "tags": { "type": "array", "items": { "type": "object" }, "description": "The tags value" }, "type": { "type": "string", "description": "The type value", "enum": [ "project", "mobileScorecard" ] }, "versionNotes": { "type": "string", "description": "Version Notes" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_projects\_delete\_project deletes a project. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | string | Yes | — | The Project id for which to retrieve information | | `locale` | string | No | — | Locale or language code | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "string", "description": "The Project id for which to retrieve information" }, "locale": { "type": "string", "description": "Locale or language code" } }, "required": [ "PCID", "projectId" ] } ``` *** ## adobe\_analytics\_management\_projects\_get\_project Retrieves configuration for a Project. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | string | Yes | — | The Project id for which to retrieve information | | `expansion` | string\[] | No | — | Comma-delimited list of additional project metadata fields to include on response. | | `locale` | string | No | — | Locale or language code | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "string", "description": "The Project id for which to retrieve information" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "shares", "tags", "accessLevel", "modified", "externalReferences", "definition" ] }, "description": "Comma-delimited list of additional project metadata fields to include on response." }, "locale": { "type": "string", "description": "Locale or language code" } }, "required": [ "PCID", "projectId" ] } ``` *** ## adobe\_analytics\_management\_projects\_get\_projects Returns a list of projects for the user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `includeType` | string\[] | No | — | Include additional projects not owned by user. The "all" option takes precedence over "shared". If neither guided, or project is included, both types are returned | | `expansion` | string\[] | No | — | Comma-delimited list of additional project metadata fields to include on response. | | `filterByIds` | string | No | — | Filter list to only include projects in the specified list (comma-delimited list of IDs) | | `locale` | string | No | — | Locale or language code | | `pagination` | string | No | — | return paginated results | | `ownerId` | integer | No | — | Filter list to only include projects owned by the specified loginId | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "includeType": { "type": "array", "items": { "type": "string", "enum": [ "all", "shared" ] }, "description": "Include additional projects not owned by user. The \"all\" option takes precedence over \"shared\". If neither guided, or project is included, both types are returned" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "shares", "tags", "accessLevel", "modified", "externalReferences", "definition" ] }, "description": "Comma-delimited list of additional project metadata fields to include on response." }, "filterByIds": { "type": "string", "description": "Filter list to only include projects in the specified list (comma-delimited list of IDs)" }, "locale": { "type": "string", "description": "Locale or language code" }, "pagination": { "type": "string", "description": "return paginated results", "enum": [ "true", "false" ] }, "ownerId": { "type": "integer", "description": "Filter list to only include projects owned by the specified loginId" }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_projects\_update\_project Updates configuration for a project. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | string | Yes | — | The Project id for which to retrieve information | | `expansion` | string\[] | No | — | Comma-delimited list of additional project metadata fields to include on response. | | `locale` | string | No | — | Locale or language code | | `accessLevel` | string | No | — | Access Level | | `created` | string | No | — | The created value | | `definition` | object | No | — | The definition value | | `description` | string | No | — | The description value | | `externalReferences` | object | No | — | External References | | `id` | string | No | — | System generated id | | `modified` | string | No | — | The modified value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `reportSuiteName` | string | No | — | The report suite name for which the component was created/updated | | `rsid` | string | No | — | The report suite id for which the component was created/updated | | `shares` | object\[] | No | — | The shares value | | `tags` | object\[] | No | — | The tags value | | `type` | string | No | — | The type value | | `versionNotes` | string | No | — | Version Notes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "string", "description": "The Project id for which to retrieve information" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "shares", "tags", "accessLevel", "modified", "externalReferences", "definition" ] }, "description": "Comma-delimited list of additional project metadata fields to include on response." }, "locale": { "type": "string", "description": "Locale or language code" }, "accessLevel": { "type": "string", "description": "Access Level" }, "created": { "type": "string", "description": "The created value" }, "definition": { "type": "object", "description": "The definition value" }, "description": { "type": "string", "description": "The description value" }, "externalReferences": { "type": "object", "description": "External References" }, "id": { "type": "string", "description": "System generated id" }, "modified": { "type": "string", "description": "The modified value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "type": "object", "description": "The owner value", "properties": { "id": { "type": "integer", "description": "the login id of the owner" }, "name": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" }, "login": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" } }, "required": [ "id" ] }, "reportSuiteName": { "type": "string", "description": "The report suite name for which the component was created/updated" }, "rsid": { "type": "string", "description": "The report suite id for which the component was created/updated" }, "shares": { "type": "array", "items": { "type": "object" }, "description": "The shares value" }, "tags": { "type": "array", "items": { "type": "object" }, "description": "The tags value" }, "type": { "type": "string", "description": "The type value", "enum": [ "project", "mobileScorecard" ] }, "versionNotes": { "type": "string", "description": "Version Notes" } }, "required": [ "PCID", "projectId" ] } ``` *** ## adobe\_analytics\_management\_projects\_validate\_project Validates a Project definition **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `locale` | string | No | — | Locale or language code | | `project` | object | No | — | The project value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "locale": { "type": "string", "description": "Locale or language code" }, "project": { "type": "object", "description": "The project value" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_save\_share Saves the given share for the current user's company **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accessLevel` | string | No | — | Level of rights shared with entity. (for projects only) | | `componentId` | string | No | — | the id of the component being shared | | `componentType` | string | No | — | the type of component being shared | | `id` | integer | No | — | the share id | | `shareToDisplayName` | string | No | — | full name of the entity shared with | | `shareToId` | integer | No | — | the id of the user/group the component is shared with | | `shareToType` | string | No | — | the type of entity shared with (user/group/all) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accessLevel": { "type": "string", "description": "Level of rights shared with entity. (for projects only)" }, "componentId": { "type": "string", "description": "the id of the component being shared" }, "componentType": { "type": "string", "description": "the type of component being shared" }, "id": { "type": "integer", "description": "the share id" }, "shareToDisplayName": { "type": "string", "description": "full name of the entity shared with" }, "shareToId": { "type": "integer", "description": "the id of the user/group the component is shared with" }, "shareToType": { "type": "string", "description": "the type of entity shared with (user/group/all)" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_save\_tag\_component\_list Tag a component with one or many tags at once. WARNING: Authoritative; deletes/overwrites all pre-existing associations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object\[] | Yes | — | JSON-formatted object containing key-value pairs that conform to the schema | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string", "description": "Component Type" }, "componentId": { "type": "string", "description": "Component Id" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "the tag id" }, "name": { "type": "string", "description": "the tag name " }, "description": { "type": "string", "description": "the tag description" }, "components": { "type": "array", "description": "the list of components that have been tagged with this tag" } } }, "description": "The tags value" } } }, "description": "JSON-formatted object containing key-value pairs that conform to the schema" } }, "required": [ "PCID", "body" ] } ``` *** ## adobe\_analytics\_management\_save\_tag\_list Saves the given tag(s) for the current user's company **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object\[] | Yes | — | JSON-formatted array of Tag objects containing key-value pairs | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "the tag id" }, "name": { "type": "string", "description": "the tag name" }, "description": { "type": "string", "description": "the tag description" }, "components": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string" }, "componentId": { "type": "string" }, "tags": { "type": "array" } } }, "description": "the list of components that have been tagged with this tag" } } }, "description": "JSON-formatted array of Tag objects containing key-value pairs" } }, "required": [ "PCID", "body" ] } ``` *** ## adobe\_analytics\_management\_search\_component\_shares search for shares for several components at once **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | | `componentIds` | string\[] | No | — | Component Ids | | `componentType` | string | No | — | Component Type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" }, "componentIds": { "type": "array", "items": { "type": "string" }, "description": "Component Ids" }, "componentType": { "type": "string", "description": "Component Type" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_search\_component\_tags\_2 search for tags for several components at once **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | | `componentIds` | string\[] | No | — | Component Ids | | `componentType` | string | No | — | Component Type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" }, "componentIds": { "type": "array", "items": { "type": "string" }, "description": "Component Ids" }, "componentType": { "type": "string", "description": "Component Type" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_management\_shared\_to\_me get components shared with the current user by type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `componentType` | string | Yes | — | Component type to get shared ids for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "componentType": { "type": "string", "description": "Component type to get shared ids for" } }, "required": [ "PCID", "componentType" ] } ``` *** ## adobe\_analytics\_management\_update\_date\_range Updates configuration for a DateRange. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dateRangeId` | string | Yes | — | The DateRange id for which to retrieve information | | `locale` | string | No | — | Locale or language code | | `expansion` | string\[] | No | — | Comma-delimited list of additional date range metadata fields to include on response. | | `created` | string | No | — | The created value | | `definition` | object | No | — | The definition value | | `description` | string | No | — | The description value | | `id` | string | No | — | System generated id | | `modified` | string | No | — | The modified value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `reportSuiteName` | string | No | — | The report suite name for which the component was created/updated | | `rsid` | string | No | — | The report suite id for which the component was created/updated | | `siteTitle` | string | No | — | Site Title | | `tags` | object\[] | No | — | The tags value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dateRangeId": { "type": "string", "description": "The DateRange id for which to retrieve information" }, "locale": { "type": "string", "description": "Locale or language code" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "definition", "ownerFullName", "modified", "tags" ] }, "description": "Comma-delimited list of additional date range metadata fields to include on response.", "enum": [ "definition", "ownerFullName", "modified", "tags" ] }, "created": { "type": "string", "description": "The created value" }, "definition": { "type": "object", "description": "The definition value" }, "description": { "type": "string", "description": "The description value" }, "id": { "type": "string", "description": "System generated id" }, "modified": { "type": "string", "description": "The modified value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "type": "object", "description": "The owner value", "properties": { "id": { "type": "integer", "description": "the login id of the owner" }, "name": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" }, "login": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" } }, "required": [ "id" ] }, "reportSuiteName": { "type": "string", "description": "The report suite name for which the component was created/updated" }, "rsid": { "type": "string", "description": "The report suite id for which the component was created/updated" }, "siteTitle": { "type": "string", "description": "Site Title" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "the tag id" }, "name": { "type": "string", "description": "the tag name" }, "description": { "type": "string", "description": "the tag description" }, "components": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string" }, "componentId": { "type": "string" }, "tags": { "type": "array" } } }, "description": "the list of components that have been tagged with this tag" } } }, "description": "The tags value" } }, "required": [ "PCID", "dateRangeId" ] } ``` *** ## adobe\_analytics\_management\_update\_shares Share components with users. WARNING: Authoritative; deletes/overwrites all pre-existing shares for the given components **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `componentId` | string | No | — | Component Id | | `componentType` | string | No | — | Component Type | | `shares` | object\[] | No | — | The shares value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "componentId": { "type": "string", "description": "Component Id" }, "componentType": { "type": "string", "description": "Component Type" }, "shares": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "the share id" }, "shareToId": { "type": "integer", "format": "int32", "description": "the id of the user/group the component is shared with" }, "shareToType": { "type": "string", "description": "the type of entity shared with (user/group/all)" }, "shareToDisplayName": { "type": "string", "description": "full name of the entity shared with" }, "componentType": { "type": "string", "description": "the type of component being shared" }, "componentId": { "type": "string", "description": "the id of the component being shared" }, "accessLevel": { "type": "string", "description": "Level of rights shared with entity. (for projects only)" } } }, "description": "The shares value" } }, "required": [ "PCID" ] } ``` # adobe-analytics-reporting Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/adobe-analytics/adobe-analytics-reporting Adobe Analytics Reporting - reports, segments, calculated metrics, dimensions, metrics, and report suites **Server path:** `/adobe-analytics-reporting` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`adobe_analytics_reporting_calculatedmetrics_create_calculated_metric`](#adobe_analytics_reporting_calculatedmetrics_create_calculated_metric) | Create a new Calculated Metric | | [`adobe_analytics_reporting_calculatedmetrics_delete_calculated_metric`](#adobe_analytics_reporting_calculatedmetrics_delete_calculated_metric) | Deletion of Calculated Metrics by Id | | [`adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_function`](#adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_function) | Retrieve a calculated metric function by id | | [`adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_functions`](#adobe_analytics_reporting_calculatedmetrics_get_calculated_metric_functions) | Retrieve calculated metric functions | | [`adobe_analytics_reporting_calculatedmetrics_update_calculated_metric`](#adobe_analytics_reporting_calculatedmetrics_update_calculated_metric) | Update an existing calculated metric | | [`adobe_analytics_reporting_calculatedmetrics_validate_calculated_metric`](#adobe_analytics_reporting_calculatedmetrics_validate_calculated_metric) | Validate a calculated metric definition | | [`adobe_analytics_reporting_dimensions_get_dimension`](#adobe_analytics_reporting_dimensions_get_dimension) | Returns a dimension for the given report suite | | [`adobe_analytics_reporting_dimensions_get_dimensions`](#adobe_analytics_reporting_dimensions_get_dimensions) | Returns a list of dimensions for a given report suite. | | [`adobe_analytics_reporting_find_all`](#adobe_analytics_reporting_find_all) | Retrieves report suites that match the given filters. | | [`adobe_analytics_reporting_find_calculated_metrics`](#adobe_analytics_reporting_find_calculated_metrics) | Retrieve many calculated metrics | | [`adobe_analytics_reporting_find_one`](#adobe_analytics_reporting_find_one) | Retrieves report suite by id | | [`adobe_analytics_reporting_find_one_calculated_metric`](#adobe_analytics_reporting_find_one_calculated_metric) | Retrieve a single calculated metric by id | | [`adobe_analytics_reporting_get_metric`](#adobe_analytics_reporting_get_metric) | Returns a metric for the given report suite | | [`adobe_analytics_reporting_get_metrics`](#adobe_analytics_reporting_get_metrics) | Returns a list of metrics for the given report suite | | [`adobe_analytics_reporting_run_report`](#adobe_analytics_reporting_run_report) | Runs a report for the request in the post body | | [`adobe_analytics_reporting_run_top_item_report`](#adobe_analytics_reporting_run_top_item_report) | Runs a top items report for the request in the post body | | [`adobe_analytics_reporting_segments_create_segment`](#adobe_analytics_reporting_segments_create_segment) | Creates Segment | | [`adobe_analytics_reporting_segments_delete_segment`](#adobe_analytics_reporting_segments_delete_segment) | Delete Segment | | [`adobe_analytics_reporting_segments_get_segment`](#adobe_analytics_reporting_segments_get_segment) | Get a Single Segment | | [`adobe_analytics_reporting_segments_get_segments`](#adobe_analytics_reporting_segments_get_segments) | Retrieve All Segments | | [`adobe_analytics_reporting_segments_update_segment`](#adobe_analytics_reporting_segments_update_segment) | Update a Segment | | [`adobe_analytics_reporting_segments_validate_segment`](#adobe_analytics_reporting_segments_validate_segment) | Validate a Segment | *** ## adobe\_analytics\_reporting\_calculatedmetrics\_create\_calculated\_metric Create a new Calculated Metric **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `locale` | string | No | — | Locale or language code | | `expansion` | string\[] | No | — | Comma-delimited list of additional calculated metric metadata fields to include on response. | | `categories` | string\[] | No | — | The categories value | | `created` | string | No | — | Calculated metric creation date | | `definition` | object | No | — | The definition value | | `description` | string | No | — | The description value | | `id` | string | No | — | System generated id | | `modified` | string | No | — | The modified value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `polarity` | string | No | — | Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive | | `precision` | integer | No | — | Number of decimal places to include in calculated metric result | | `reportSuiteName` | string | No | — | The report suite name for which the component was created/updated | | `rsid` | string | No | — | The report suite id for which the component was created/updated | | `siteTitle` | string | No | — | Site Title | | `tags` | object\[] | No | — | The tags value | | `type` | string | No | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "locale": { "type": "string", "description": "Locale or language code" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "definition", "compatibility", "categories" ] }, "description": "Comma-delimited list of additional calculated metric metadata fields to include on response.", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "definition", "compatibility", "categories" ] }, "categories": { "type": "array", "items": { "type": "string" }, "description": "The categories value" }, "created": { "type": "string", "description": "Calculated metric creation date" }, "definition": { "type": "object", "description": "The definition value" }, "description": { "type": "string", "description": "The description value" }, "id": { "type": "string", "description": "System generated id" }, "modified": { "type": "string", "description": "The modified value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "type": "object", "description": "The owner value", "properties": { "id": { "type": "integer", "description": "the login id of the owner" }, "name": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" }, "login": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" } }, "required": [ "id" ] }, "polarity": { "type": "string", "description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive", "enum": [ "positive", "negative" ] }, "precision": { "type": "integer", "description": "Number of decimal places to include in calculated metric result" }, "reportSuiteName": { "type": "string", "description": "The report suite name for which the component was created/updated" }, "rsid": { "type": "string", "description": "The report suite id for which the component was created/updated" }, "siteTitle": { "type": "string", "description": "Site Title" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "the tag id" }, "name": { "type": "string", "description": "the tag name" }, "description": { "type": "string", "description": "the tag description" }, "components": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string" }, "componentId": { "type": "string" }, "tags": { "type": "array" } } }, "description": "the list of components that have been tagged with this tag" } } }, "description": "The tags value" }, "type": { "type": "string", "description": "The type value", "enum": [ "CURRENCY", "TIME", "DECIMAL", "PERCENT" ] } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_reporting\_calculatedmetrics\_delete\_calculated\_metric Deletion of Calculated Metrics by Id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The calculated metric ID to be deleted | | `locale` | string | No | — | Locale or language code | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The calculated metric ID to be deleted" }, "locale": { "type": "string", "description": "Locale or language code" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_reporting\_calculatedmetrics\_get\_calculated\_metric\_function Retrieve a calculated metric function by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The function ID to retrieve | | `locale` | string | No | — | Locale or language code | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The function ID to retrieve" }, "locale": { "type": "string", "description": "Locale or language code" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_reporting\_calculatedmetrics\_get\_calculated\_metric\_functions Retrieve calculated metric functions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `locale` | string | No | — | Locale or language code | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "locale": { "type": "string", "description": "Locale or language code" } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_reporting\_calculatedmetrics\_update\_calculated\_metric Update an existing calculated metric **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Calculated Metric ID to be updated | | `locale` | string | No | — | Locale or language code | | `expansion` | string\[] | No | — | Comma-delimited list of additional calculated metric metadata fields to include on response. | | `categories` | string\[] | No | — | The categories value | | `created` | string | No | — | Calculated metric creation date | | `definition` | object | No | — | The definition value | | `description` | string | No | — | The description value | | `modified` | string | No | — | The modified value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `polarity` | string | No | — | Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive | | `precision` | integer | No | — | Number of decimal places to include in calculated metric result | | `reportSuiteName` | string | No | — | The report suite name for which the component was created/updated | | `rsid` | string | No | — | The report suite id for which the component was created/updated | | `siteTitle` | string | No | — | Site Title | | `tags` | object\[] | No | — | The tags value | | `type` | string | No | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Calculated Metric ID to be updated" }, "locale": { "type": "string", "description": "Locale or language code" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "definition", "compatibility", "categories" ] }, "description": "Comma-delimited list of additional calculated metric metadata fields to include on response.", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "definition", "compatibility", "categories" ] }, "categories": { "type": "array", "items": { "type": "string" }, "description": "The categories value" }, "created": { "type": "string", "description": "Calculated metric creation date" }, "definition": { "type": "object", "description": "The definition value" }, "description": { "type": "string", "description": "The description value" }, "modified": { "type": "string", "description": "The modified value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "type": "object", "description": "The owner value", "properties": { "id": { "type": "integer", "description": "the login id of the owner" }, "name": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" }, "login": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" } }, "required": [ "id" ] }, "polarity": { "type": "string", "description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive", "enum": [ "positive", "negative" ] }, "precision": { "type": "integer", "description": "Number of decimal places to include in calculated metric result" }, "reportSuiteName": { "type": "string", "description": "The report suite name for which the component was created/updated" }, "rsid": { "type": "string", "description": "The report suite id for which the component was created/updated" }, "siteTitle": { "type": "string", "description": "Site Title" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "the tag id" }, "name": { "type": "string", "description": "the tag name" }, "description": { "type": "string", "description": "the tag description" }, "components": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string" }, "componentId": { "type": "string" }, "tags": { "type": "array" } } }, "description": "the list of components that have been tagged with this tag" } } }, "description": "The tags value" }, "type": { "type": "string", "description": "The type value", "enum": [ "CURRENCY", "TIME", "DECIMAL", "PERCENT" ] } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_reporting\_calculatedmetrics\_validate\_calculated\_metric Validate a calculated metric definition **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `locale` | string | No | — | Locale or language code | | `migrating` | boolean | No | — | Include migration functions in validation | | `categories` | string\[] | No | — | The categories value | | `created` | string | No | — | Calculated metric creation date | | `definition` | object | No | — | The definition value | | `description` | string | No | — | The description value | | `id` | string | No | — | System generated id | | `modified` | string | No | — | The modified value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `polarity` | string | No | — | Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive | | `precision` | integer | No | — | Number of decimal places to include in calculated metric result | | `reportSuiteName` | string | No | — | The report suite name for which the component was created/updated | | `rsid` | string | No | — | The report suite id for which the component was created/updated | | `siteTitle` | string | No | — | Site Title | | `tags` | object\[] | No | — | The tags value | | `type` | string | No | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "locale": { "type": "string", "description": "Locale or language code" }, "migrating": { "type": "boolean", "description": "Include migration functions in validation" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "The categories value" }, "created": { "type": "string", "description": "Calculated metric creation date" }, "definition": { "type": "object", "description": "The definition value" }, "description": { "type": "string", "description": "The description value" }, "id": { "type": "string", "description": "System generated id" }, "modified": { "type": "string", "description": "The modified value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "type": "object", "description": "The owner value", "properties": { "id": { "type": "integer", "description": "the login id of the owner" }, "name": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" }, "login": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" } }, "required": [ "id" ] }, "polarity": { "type": "string", "description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive", "enum": [ "positive", "negative" ] }, "precision": { "type": "integer", "description": "Number of decimal places to include in calculated metric result" }, "reportSuiteName": { "type": "string", "description": "The report suite name for which the component was created/updated" }, "rsid": { "type": "string", "description": "The report suite id for which the component was created/updated" }, "siteTitle": { "type": "string", "description": "Site Title" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "the tag id" }, "name": { "type": "string", "description": "the tag name" }, "description": { "type": "string", "description": "the tag description" }, "components": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string" }, "componentId": { "type": "string" }, "tags": { "type": "array" } } }, "description": "the list of components that have been tagged with this tag" } } }, "description": "The tags value" }, "type": { "type": "string", "description": "The type value", "enum": [ "CURRENCY", "TIME", "DECIMAL", "PERCENT" ] } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_reporting\_dimensions\_get\_dimension Returns a dimension for the given report suite **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dimensionId` | string | Yes | — | The dimension ID. For example a valid id is a value like 'evar1' | | `rsid` | string | Yes | — | The report suite ID. | | `locale` | string | No | — | The locale to use for returning system named dimensions. | | `expansion` | string\[] | No | — | Add extra metadata to items (comma-delimited list) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dimensionId": { "type": "string", "description": "The dimension ID. For example a valid id is a value like 'evar1'" }, "rsid": { "type": "string", "description": "The report suite ID." }, "locale": { "type": "string", "description": "The locale to use for returning system named dimensions." }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "tags", "shares", "allowedForReporting", "categories" ] }, "description": "Add extra metadata to items (comma-delimited list)", "enum": [ "tags", "shares", "allowedForReporting", "categories" ] } }, "required": [ "PCID", "dimensionId", "rsid" ] } ``` *** ## adobe\_analytics\_reporting\_dimensions\_get\_dimensions Returns a list of dimensions for a given report suite. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rsid` | string | Yes | — | A Report Suite ID | | `locale` | string | No | — | Locale or language code | | `segmentable` | boolean | No | — | Only include dimensions that are valid within a segment. | | `reportable` | boolean | No | — | Only include dimensions that are valid within a report. | | `classifiable` | boolean | No | — | Only include classifiable dimensions. | | `expansion` | string\[] | No | — | Add extra metadata to items (comma-delimited list) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rsid": { "type": "string", "description": "A Report Suite ID" }, "locale": { "type": "string", "description": "Locale or language code" }, "segmentable": { "type": "boolean", "description": "Only include dimensions that are valid within a segment.", "enum": [ true ] }, "reportable": { "type": "boolean", "description": "Only include dimensions that are valid within a report.", "enum": [ true ] }, "classifiable": { "type": "boolean", "description": "Only include classifiable dimensions.", "enum": [ true ] }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "tags", "shares", "allowedForReporting", "categories" ] }, "description": "Add extra metadata to items (comma-delimited list)", "enum": [ "tags", "shares", "allowedForReporting", "categories" ] } }, "required": [ "PCID", "rsid" ] } ``` *** ## adobe\_analytics\_reporting\_find\_all Retrieves report suites that match the given filters. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rsids` | string | No | — | Filter list to only include suites in this RSID list (comma-delimited) | | `rsidContains` | string | No | — | Filter list to only include suites whose rsid contains rsidContains. | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | | `expansion` | string\[] | No | — | Comma-delimited list of additional metadata fields to include on response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rsids": { "type": "string", "description": "Filter list to only include suites in this RSID list (comma-delimited)" }, "rsidContains": { "type": "string", "description": "Filter list to only include suites whose rsid contains rsidContains." }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "name", "parentRsid", "currency", "calendarType", "timezoneZoneinfo" ] }, "description": "Comma-delimited list of additional metadata fields to include on response.", "enum": [ "name", "parentRsid", "currency", "calendarType", "timezoneZoneinfo" ] } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_reporting\_find\_calculated\_metrics Retrieve many calculated metrics **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rsids` | string | No | — | Filter list to only include calculated metrics tied to specified RSID list (comma-delimited) | | `ownerId` | integer | No | — | Filter list to only include calculated metrics owned by the specified loginId | | `filterByIds` | string | No | — | Filter list to only include calculated metrics in the specified list (comma-delimited list of IDs) (this is the same as calculatedMetricFilter, and is overwritten by calculatedMetricFilter | | `toBeUsedInRsid` | string | No | — | The report suite where the calculated metric intended to be used. This report suite will be used to determine things like compatibility and permissions. If it is not specified then the permissions will be calculated based on the union of all metrics authorized in all groups the user belongs to. If the compatibility expansion is specified and toBeUsedInRsid is not then the compatibility returned is based off the compatibility from the last time the calculated metric was saved. | | `locale` | string | No | — | Locale or language code | | `name` | string | No | — | Filter list to only include calculated metrics that contains the Name | | `tagNames` | string | No | — | Filter list to only include calculated metrics that contains one of the tags | | `favorite` | boolean | No | — | Filter list to only include calculated metrics that are favorites | | `approved` | boolean | No | — | Filter list to only include calculated metrics that are approved | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | | `sortDirection` | string | No | — | Sort direction (ASC or DESC) | | `sortProperty` | string | No | — | Property to sort by (name, modified\_date, id is currently allowed) | | `expansion` | string\[] | No | — | Comma-delimited list of additional calculated metric metadata fields to include on response. | | `includeType` | string\[] | No | — | Include additional calculated metrics not owned by user. The "all" option takes precedence over "shared" | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rsids": { "type": "string", "description": "Filter list to only include calculated metrics tied to specified RSID list (comma-delimited)" }, "ownerId": { "type": "integer", "description": "Filter list to only include calculated metrics owned by the specified loginId" }, "filterByIds": { "type": "string", "description": "Filter list to only include calculated metrics in the specified list (comma-delimited list of IDs) (this is the same as calculatedMetricFilter, and is overwritten by calculatedMetricFilter" }, "toBeUsedInRsid": { "type": "string", "description": "The report suite where the calculated metric intended to be used. This report suite will be used to determine things like compatibility and permissions. If it is not specified then the permissions will be calculated based on the union of all metrics authorized in all groups the user belongs to. If the compatibility expansion is specified and toBeUsedInRsid is not then the compatibility returned is based off the compatibility from the last time the calculated metric was saved." }, "locale": { "type": "string", "description": "Locale or language code" }, "name": { "type": "string", "description": "Filter list to only include calculated metrics that contains the Name" }, "tagNames": { "type": "string", "description": "Filter list to only include calculated metrics that contains one of the tags" }, "favorite": { "type": "boolean", "description": "Filter list to only include calculated metrics that are favorites" }, "approved": { "type": "boolean", "description": "Filter list to only include calculated metrics that are approved" }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" }, "sortDirection": { "type": "string", "description": "Sort direction (ASC or DESC)" }, "sortProperty": { "type": "string", "description": "Property to sort by (name, modified_date, id is currently allowed)" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "definition", "compatibility", "categories" ] }, "description": "Comma-delimited list of additional calculated metric metadata fields to include on response.", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "definition", "compatibility", "categories" ] }, "includeType": { "type": "array", "items": { "type": "string", "enum": [ "all", "shared", "templates" ] }, "description": "Include additional calculated metrics not owned by user. The \"all\" option takes precedence over \"shared\"", "enum": [ "all", "shared", "templates" ] } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_reporting\_find\_one Retrieves report suite by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rsid` | string | Yes | — | The rsid of the suite to return | | `expansion` | string\[] | No | — | Comma-delimited list of additional metadata fields to include on response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rsid": { "type": "string", "description": "The rsid of the suite to return" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "name", "parentRsid", "currency", "calendarType", "timezoneZoneinfo" ] }, "description": "Comma-delimited list of additional metadata fields to include on response.", "enum": [ "name", "parentRsid", "currency", "calendarType", "timezoneZoneinfo" ] } }, "required": [ "PCID", "rsid" ] } ``` *** ## adobe\_analytics\_reporting\_find\_one\_calculated\_metric Retrieve a single calculated metric by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The calculated metric ID to retrieve | | `locale` | string | No | — | Locale or language code | | `expansion` | string\[] | No | — | Comma-delimited list of additional calculated metric metadata fields to include on response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The calculated metric ID to retrieve" }, "locale": { "type": "string", "description": "Locale or language code" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "definition", "compatibility", "categories" ] }, "description": "Comma-delimited list of additional calculated metric metadata fields to include on response.", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "definition", "compatibility", "categories" ] } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_reporting\_get\_metric Returns a metric for the given report suite **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The id of the metric for which to retrieve info. Note ids are values like pageviews, not metrics/pageviews | | `rsid` | string | Yes | — | ID of desired report suite ie. myrsid | | `locale` | string | No | — | Locale that system named metrics should be returned in | | `expansion` | string\[] | No | — | Add extra metadata to items (comma-delimited list) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id of the metric for which to retrieve info. Note ids are values like pageviews, not metrics/pageviews" }, "rsid": { "type": "string", "description": "ID of desired report suite ie. myrsid" }, "locale": { "type": "string", "description": "Locale that system named metrics should be returned in" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "tags", "shares", "allowedForReporting", "categories" ] }, "description": "Add extra metadata to items (comma-delimited list)", "enum": [ "tags", "shares", "allowedForReporting", "categories" ] } }, "required": [ "PCID", "id", "rsid" ] } ``` *** ## adobe\_analytics\_reporting\_get\_metrics Returns a list of metrics for the given report suite **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rsid` | string | Yes | — | ID of desired report suite ie. myrsid | | `locale` | string | No | — | Locale that system named metrics should be returned in | | `segmentable` | boolean | No | — | Filter the metrics by if they are valid in a segment. | | `expansion` | string\[] | No | — | Add extra metadata to items (comma-delimited list) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rsid": { "type": "string", "description": "ID of desired report suite ie. myrsid" }, "locale": { "type": "string", "description": "Locale that system named metrics should be returned in" }, "segmentable": { "type": "boolean", "description": "Filter the metrics by if they are valid in a segment." }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "tags", "shares", "allowedForReporting", "categories" ] }, "description": "Add extra metadata to items (comma-delimited list)", "enum": [ "tags", "shares", "allowedForReporting", "categories" ] } }, "required": [ "PCID", "rsid" ] } ``` *** ## adobe\_analytics\_reporting\_run\_report Runs a report for the request in the post body **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `anchorDate` | string | No | — | Anchor Date | | `dimension` | string | No | — | The dimension value | | `globalFilters` | object\[] | No | — | Global Filters | | `locale` | object | No | — | Locale or language code | | `metricContainer` | object | No | — | Metric Container | | `rowContainer` | object | No | — | Row Container | | `rsid` | string | No | — | The rsid value | | `search` | object | No | — | The search value | | `settings` | object | No | — | The settings value | | `statistics` | object | No | — | The statistics value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "anchorDate": { "type": "string", "description": "Anchor Date" }, "dimension": { "type": "string", "description": "The dimension value" }, "globalFilters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id value" }, "type": { "type": "string", "enum": [ "dateRange", "breakdown", "segment", "excludeItemIds" ], "description": "The type value" }, "dimension": { "type": "string", "description": "The dimension value" }, "itemId": { "type": "string", "description": "Item Id" }, "itemIds": { "type": "array", "items": { "type": "string" }, "description": "Item Ids" }, "segmentId": { "type": "string", "description": "Segment Id" }, "segmentDefinition": { "type": "object", "description": "Segment Definition" }, "dateRange": { "type": "string", "description": "Date Range" }, "excludeItemIds": { "type": "array", "items": { "type": "string" }, "description": "Exclude Item Ids" } } }, "description": "Global Filters" }, "locale": { "type": "object", "description": "Locale or language code", "properties": { "language": { "type": "string", "description": "The language value" }, "script": { "type": "string", "description": "The script value" }, "country": { "type": "string", "description": "The country value" }, "variant": { "type": "string", "description": "The variant value" }, "extensionKeys": { "type": "array", "items": { "type": "string" }, "description": "Extension Keys" }, "unicodeLocaleAttributes": { "type": "array", "items": { "type": "string" }, "description": "Unicode Locale Attributes" }, "unicodeLocaleKeys": { "type": "array", "items": { "type": "string" }, "description": "Unicode Locale Keys" }, "iso3Language": { "type": "string", "description": "Iso3 Language" }, "iso3Country": { "type": "string", "description": "Iso3 Country" }, "displayLanguage": { "type": "string", "description": "Display Language" }, "displayScript": { "type": "string", "description": "Display Script" }, "displayCountry": { "type": "string", "description": "Display Country" }, "displayVariant": { "type": "string", "description": "Display Variant" }, "displayName": { "type": "string", "description": "Display Name" } } }, "metricContainer": { "type": "object", "description": "Metric Container", "properties": { "metricFilters": { "type": "array", "items": { "type": "object" }, "description": "Metric Filters" }, "metrics": { "type": "array", "items": { "type": "object" }, "description": "The metrics value" } } }, "rowContainer": { "type": "object", "description": "Row Container", "properties": { "rowFilters": { "type": "array", "items": { "type": "object" }, "description": "Row Filters" }, "rows": { "type": "array", "items": { "type": "object" }, "description": "The rows value" } } }, "rsid": { "type": "string", "description": "The rsid value" }, "search": { "type": "object", "description": "The search value", "properties": { "clause": { "type": "string", "description": "The clause value" }, "excludeItemIds": { "type": "array", "items": { "type": "string" }, "description": "Exclude Item Ids" }, "itemIds": { "type": "array", "items": { "type": "string" }, "description": "Item Ids" }, "includeSearchTotal": { "type": "boolean", "description": "Include Search Total" }, "empty": { "type": "boolean", "description": "The empty value" } } }, "settings": { "type": "object", "description": "The settings value", "properties": { "limit": { "type": "integer", "description": "Maximum number of results to return" }, "page": { "type": "integer", "description": "Page number for pagination" }, "dimensionSort": { "type": "string", "description": "Dimension Sort" }, "countRepeatInstances": { "type": "boolean", "description": "Count Repeat Instances" }, "reflectRequest": { "type": "boolean", "description": "Reflect Request" }, "includeAnomalyDetection": { "type": "boolean", "description": "Include Anomaly Detection" }, "includePercentChange": { "type": "boolean", "description": "Include Percent Change" }, "includeLatLong": { "type": "boolean", "description": "Include Lat Long" }, "nonesBehavior": { "type": "string", "description": "Nones Behavior" } } }, "statistics": { "type": "object", "description": "The statistics value", "properties": { "functions": { "type": "array", "items": { "type": "string" }, "description": "The functions value" }, "ignoreZeroes": { "type": "boolean", "description": "Ignore Zeroes" } } } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_reporting\_run\_top\_item\_report Runs a top items report for the request in the post body **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rsid` | string | Yes | — | ID of desired report suite ie. myrsid | | `dimension` | string | Yes | — | Dimension to run the report against. Example: 'variables/page' | | `locale` | string | No | — | Locale that system named metrics should be returned in | | `dateRange` | string | No | — | Format: YYYY-MM-DD/YYYY-MM-DD | | `search-clause` | string | No | — | General search string; wrap with single quotes. Example: 'PageABC' | | `startDate` | string | No | — | Format: YYYY-MM-DD | | `endDate` | string | No | — | Format: YYYY-MM-DD | | `searchAnd` | string | No | — | Search terms that will be AND-ed together. Space delimited. | | `searchOr` | string | No | — | Search terms that will be OR-ed together. Space delimited. | | `searchNot` | string | No | — | Search terms that will be treated as NOT including. Space delimited. | | `searchPhrase` | string | No | — | A full search phrase that will be searched for. | | `lookupNoneValues` | boolean | No | — | Controls None values to be included | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rsid": { "type": "string", "description": "ID of desired report suite ie. myrsid" }, "dimension": { "type": "string", "description": "Dimension to run the report against. Example: 'variables/page'" }, "locale": { "type": "string", "description": "Locale that system named metrics should be returned in" }, "dateRange": { "type": "string", "description": "Format: YYYY-MM-DD/YYYY-MM-DD" }, "search-clause": { "type": "string", "description": "General search string; wrap with single quotes. Example: 'PageABC'" }, "startDate": { "type": "string", "description": "Format: YYYY-MM-DD" }, "endDate": { "type": "string", "description": "Format: YYYY-MM-DD" }, "searchAnd": { "type": "string", "description": "Search terms that will be AND-ed together. Space delimited." }, "searchOr": { "type": "string", "description": "Search terms that will be OR-ed together. Space delimited." }, "searchNot": { "type": "string", "description": "Search terms that will be treated as NOT including. Space delimited." }, "searchPhrase": { "type": "string", "description": "A full search phrase that will be searched for." }, "lookupNoneValues": { "type": "boolean", "description": "Controls None values to be included" }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" } }, "required": [ "PCID", "rsid", "dimension" ] } ``` *** ## adobe\_analytics\_reporting\_segments\_create\_segment Creates Segment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `locale` | string | No | — | Locale or language code | | `expansion` | string\[] | No | — | Comma-delimited list of additional segment metadata fields to include on response. | | `categories` | string\[] | No | — | The categories value | | `compatibility` | object | No | — | The compatibility value | | `created` | string | No | — | The created value | | `definition` | object | No | — | The definition value | | `definitionLastModified` | string | No | — | Definition Last Modified | | `description` | string | No | — | A description of the segment. | | `modified` | string | No | — | The modified value | | `name` | string | No | — | A name for the segment. | | `owner` | object | No | — | The owner value | | `reportSuiteName` | string | No | — | The friendly name for the report suite id. | | `rsid` | string | No | — | The report suite id. | | `siteTitle` | string | No | — | A name for the report suite. This is deprecated and should use the report suite name instead. | | `tags` | object\[] | No | — | All existing tags associated with the segment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "locale": { "type": "string", "description": "Locale or language code" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "compatibility", "definition", "publishingStatus", "definitionLastModified", "categories" ] }, "description": "Comma-delimited list of additional segment metadata fields to include on response.", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "compatibility", "definition", "publishingStatus", "definitionLastModified", "categories" ] }, "categories": { "type": "array", "items": { "type": "string" }, "description": "The categories value" }, "compatibility": { "type": "object", "description": "The compatibility value", "properties": { "valid": { "type": "boolean", "description": "The valid value" }, "message": { "type": "string", "description": "The message value" }, "validator_version": { "type": "string", "description": "Validator Version" }, "supported_products": { "type": "array", "items": { "type": "string" }, "description": "Supported Products" }, "supported_schema": { "type": "array", "items": { "type": "string" }, "description": "Supported Schema" }, "supported_features": { "type": "array", "items": { "type": "string" }, "description": "Supported Features" } } }, "created": { "type": "string", "description": "The created value" }, "definition": { "type": "object", "description": "The definition value", "properties": { "container": { "type": "object", "description": "The container value" }, "func": { "type": "string", "description": "The func value" }, "version": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The version value" } } }, "definitionLastModified": { "type": "string", "description": "Definition Last Modified" }, "description": { "type": "string", "description": "A description of the segment." }, "modified": { "type": "string", "description": "The modified value" }, "name": { "type": "string", "description": "A name for the segment." }, "owner": { "type": "object", "description": "The owner value", "properties": { "id": { "type": "integer", "description": "the login id of the owner" }, "name": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" }, "login": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" } }, "required": [ "id" ] }, "reportSuiteName": { "type": "string", "description": "The friendly name for the report suite id." }, "rsid": { "type": "string", "description": "The report suite id." }, "siteTitle": { "type": "string", "description": "A name for the report suite. This is deprecated and should use the report suite name instead." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "the tag id" }, "name": { "type": "string", "description": "the tag name" }, "description": { "type": "string", "description": "the tag description" }, "components": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string" }, "componentId": { "type": "string" }, "tags": { "type": "array" } } }, "description": "the list of components that have been tagged with this tag" } } }, "description": "All existing tags associated with the segment." } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_reporting\_segments\_delete\_segment Delete Segment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The segment ID to be deleted | | `locale` | string | No | — | Locale or language code | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The segment ID to be deleted" }, "locale": { "type": "string", "description": "Locale or language code" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_reporting\_segments\_get\_segment Get a Single Segment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The segment ID to retrieve | | `locale` | string | No | — | Locale or language code | | `expansion` | string\[] | No | — | Comma-delimited list of additional segment metadata fields to include on response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The segment ID to retrieve" }, "locale": { "type": "string", "description": "Locale or language code" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "compatibility", "definition", "publishingStatus", "definitionLastModified", "categories" ] }, "description": "Comma-delimited list of additional segment metadata fields to include on response.", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "compatibility", "definition", "publishingStatus", "definitionLastModified", "categories" ] } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_reporting\_segments\_get\_segments Retrieve All Segments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rsids` | string | No | — | Filter list to only include segments tied to specified RSID list (comma-delimited) | | `segmentFilter` | string | No | — | Filter list to only include segments in the specified list (comma-delimited list of IDs) | | `locale` | string | No | — | Locale or language code | | `name` | string | No | — | Filter list to only include segments that contains the Name | | `tagNames` | string | No | — | Filter list to only include segments that contains one of the tags | | `filterByPublishedSegments` | string | No | — | Filter list to only include segments where the published field is set to one of the allowable values (all, true, false). | | `limit` | integer | No | — | Number of results per page | | `page` | integer | No | — | Page number (base 0 - first page is "0") | | `sortDirection` | string | No | — | Sort direction (ASC or DESC | | `sortProperty` | string | No | — | Property to sort by (name, modified\_date, id is currently allowed) | | `expansion` | string\[] | No | — | Comma-delimited list of additional segment metadata fields to include on response. | | `includeType` | string\[] | No | — | Include additional segments not owned by user. The "all" option takes precedence over "shared" | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rsids": { "type": "string", "description": "Filter list to only include segments tied to specified RSID list (comma-delimited)" }, "segmentFilter": { "type": "string", "description": "Filter list to only include segments in the specified list (comma-delimited list of IDs)" }, "locale": { "type": "string", "description": "Locale or language code" }, "name": { "type": "string", "description": "Filter list to only include segments that contains the Name" }, "tagNames": { "type": "string", "description": "Filter list to only include segments that contains one of the tags" }, "filterByPublishedSegments": { "type": "string", "description": "Filter list to only include segments where the published field is set to one of the allowable values (all, true, false).", "enum": [ "all", "true", "false" ] }, "limit": { "type": "integer", "description": "Number of results per page" }, "page": { "type": "integer", "description": "Page number (base 0 - first page is \"0\")" }, "sortDirection": { "type": "string", "description": "Sort direction (ASC or DESC" }, "sortProperty": { "type": "string", "description": "Property to sort by (name, modified_date, id is currently allowed)" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "compatibility", "definition", "publishingStatus", "definitionLastModified", "categories" ] }, "description": "Comma-delimited list of additional segment metadata fields to include on response.", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "compatibility", "definition", "publishingStatus", "definitionLastModified", "categories" ] }, "includeType": { "type": "array", "items": { "type": "string", "enum": [ "shared", "all", "templates" ] }, "description": "Include additional segments not owned by user. The \"all\" option takes precedence over \"shared\"", "enum": [ "shared", "all", "templates" ] } }, "required": [ "PCID" ] } ``` *** ## adobe\_analytics\_reporting\_segments\_update\_segment Update a Segment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Segment ID to be updated | | `locale` | string | No | — | Locale or language code | | `expansion` | string\[] | No | — | Comma-delimited list of additional segment metadata fields to include on response. | | `body` | object | No | — | JSON-formatted Object containing key/value pairs to be updated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Segment ID to be updated" }, "locale": { "type": "string", "description": "Locale or language code" }, "expansion": { "type": "array", "items": { "type": "string", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "compatibility", "definition", "publishingStatus", "definitionLastModified", "categories" ] }, "description": "Comma-delimited list of additional segment metadata fields to include on response.", "enum": [ "reportSuiteName", "ownerFullName", "modified", "tags", "shares", "compatibility", "definition", "publishingStatus", "definitionLastModified", "categories" ] }, "body": { "type": "object", "description": "JSON-formatted Object containing key/value pairs to be updated." } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_analytics\_reporting\_segments\_validate\_segment Validate a Segment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rsid` | string | Yes | — | RSID to run the report against | | `categories` | string\[] | No | — | The categories value | | `compatibility` | object | No | — | The compatibility value | | `created` | string | No | — | The created value | | `definition` | object | No | — | The definition value | | `definitionLastModified` | string | No | — | Definition Last Modified | | `description` | string | No | — | A description of the segment. | | `modified` | string | No | — | The modified value | | `name` | string | No | — | A name for the segment. | | `owner` | object | No | — | The owner value | | `reportSuiteName` | string | No | — | The friendly name for the report suite id. | | `siteTitle` | string | No | — | A name for the report suite. This is deprecated and should use the report suite name instead. | | `tags` | object\[] | No | — | All existing tags associated with the segment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rsid": { "type": "string", "description": "RSID to run the report against" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "The categories value" }, "compatibility": { "type": "object", "description": "The compatibility value", "properties": { "valid": { "type": "boolean", "description": "The valid value" }, "message": { "type": "string", "description": "The message value" }, "validator_version": { "type": "string", "description": "Validator Version" }, "supported_products": { "type": "array", "items": { "type": "string" }, "description": "Supported Products" }, "supported_schema": { "type": "array", "items": { "type": "string" }, "description": "Supported Schema" }, "supported_features": { "type": "array", "items": { "type": "string" }, "description": "Supported Features" } } }, "created": { "type": "string", "description": "The created value" }, "definition": { "type": "object", "description": "The definition value", "properties": { "container": { "type": "object", "description": "The container value" }, "func": { "type": "string", "description": "The func value" }, "version": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The version value" } } }, "definitionLastModified": { "type": "string", "description": "Definition Last Modified" }, "description": { "type": "string", "description": "A description of the segment." }, "modified": { "type": "string", "description": "The modified value" }, "name": { "type": "string", "description": "A name for the segment." }, "owner": { "type": "object", "description": "The owner value", "properties": { "id": { "type": "integer", "description": "the login id of the owner" }, "name": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" }, "login": { "type": "string", "description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true" } }, "required": [ "id" ] }, "reportSuiteName": { "type": "string", "description": "The friendly name for the report suite id." }, "siteTitle": { "type": "string", "description": "A name for the report suite. This is deprecated and should use the report suite name instead." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "the tag id" }, "name": { "type": "string", "description": "the tag name" }, "description": { "type": "string", "description": "the tag description" }, "components": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string" }, "componentId": { "type": "string" }, "tags": { "type": "array" } } }, "description": "the list of components that have been tagged with this tag" } } }, "description": "All existing tags associated with the segment." } }, "required": [ "PCID", "rsid" ] } ``` # adobe-experience-manager Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/adobe-experience-manager Adobe AEM - content fragments, assets, and folder management for AEM as a Cloud Service **PinkConnect service:** `adobe-experience-manager` | **Type:** Application (parent with child servers) | **PCID required:** Yes adobe-experience-manager is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [adobe-experience-manager-assets](/api-reference/mcp-servers/application/adobe-experience-manager/adobe-experience-manager-assets) | `/adobe-experience-manager-assets` | 17 | Adobe AEM Assets - asset metadata, renditions, relations, and import | | [adobe-experience-manager-folders](/api-reference/mcp-servers/application/adobe-experience-manager/adobe-experience-manager-folders) | `/adobe-experience-manager-folders` | 7 | Adobe AEM Folders - create, list, and delete folders | | [adobe-experience-manager-sites](/api-reference/mcp-servers/application/adobe-experience-manager/adobe-experience-manager-sites) | `/adobe-experience-manager-sites` | 72 | Adobe AEM Sites - content fragments, models, variations, versions, tags, and workflows | # adobe-experience-manager-assets Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/adobe-experience-manager/adobe-experience-manager-assets Adobe AEM Assets - asset metadata, renditions, relations, and import **Server path:** `/adobe-experience-manager-assets` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`adobe_experience_manager_assets_create_asset_relations`](#adobe_experience_manager_assets_create_asset_relations) | Create new asset relations for an asset | | [`adobe_experience_manager_assets_delete_asset`](#adobe_experience_manager_assets_delete_asset) | Delete asset | | [`adobe_experience_manager_assets_delete_asset_relation`](#adobe_experience_manager_assets_delete_asset_relation) | Delete an asset relation for an asset | | [`adobe_experience_manager_assets_delete_asset_relations_for_relation_type`](#adobe_experience_manager_assets_delete_asset_relations_for_relation_type) | Delete all asset relations of the given relation type for an asset | | [`adobe_experience_manager_assets_get_asset`](#adobe_experience_manager_assets_get_asset) | Get an asset | | [`adobe_experience_manager_assets_get_asset_job_status`](#adobe_experience_manager_assets_get_asset_job_status) | Get the status of an async job | | [`adobe_experience_manager_assets_get_asset_metadata`](#adobe_experience_manager_assets_get_asset_metadata) | Delivers the specified asset's metadata | | [`adobe_experience_manager_assets_get_asset_original`](#adobe_experience_manager_assets_get_asset_original) | Returns the originally uploaded binary for the asset | | [`adobe_experience_manager_assets_get_asset_relation_types`](#adobe_experience_manager_assets_get_asset_relation_types) | Get the relation types for an asset | | [`adobe_experience_manager_assets_get_asset_relations`](#adobe_experience_manager_assets_get_asset_relations) | Get the asset relations for an asset | | [`adobe_experience_manager_assets_get_asset_relations_for_relation_type`](#adobe_experience_manager_assets_get_asset_relations_for_relation_type) | Get the asset relations for an asset filtered by relation type | | [`adobe_experience_manager_assets_get_asset_rendition`](#adobe_experience_manager_assets_get_asset_rendition) | Returns a pre-generated (on AEM Assets authoring environment) rendition of the asset | | [`adobe_experience_manager_assets_get_asset_renditions`](#adobe_experience_manager_assets_get_asset_renditions) | Returns a list of static renditions of an asset | | [`adobe_experience_manager_assets_get_import_job_result`](#adobe_experience_manager_assets_get_import_job_result) | Get Import Job Result | | [`adobe_experience_manager_assets_get_import_job_status`](#adobe_experience_manager_assets_get_import_job_status) | Get Import Job Status | | [`adobe_experience_manager_assets_import_from_url`](#adobe_experience_manager_assets_import_from_url) | Import From Url | | [`adobe_experience_manager_assets_patch_asset_metadata`](#adobe_experience_manager_assets_patch_asset_metadata) | Updates the asset's assetMetadata properties | *** ## adobe\_experience\_manager\_assets\_create\_asset\_relations Create new asset relations for an asset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset to access | | `items` | any\[] | Yes | — | Related assets to be added to the asset | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset to access" }, "items": { "type": "array", "description": "Related assets to be added to the asset" } }, "required": [ "PCID", "assetId", "items" ] } ``` *** ## adobe\_experience\_manager\_assets\_delete\_asset Delete asset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset | | `force` | boolean | No | — | If true, delete the asset even if it is referenced | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset" }, "force": { "type": "boolean", "description": "If true, delete the asset even if it is referenced" } }, "required": [ "PCID", "assetId" ] } ``` *** ## adobe\_experience\_manager\_assets\_delete\_asset\_relation Delete an asset relation for an asset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset to access | | `relationType` | string | Yes | — | Name of relation type for asset relation to be deleted. | | `relatedAssetId` | string | Yes | — | ID of the related asset to be deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset to access" }, "relationType": { "type": "string", "description": "Name of relation type for asset relation to be deleted." }, "relatedAssetId": { "type": "string", "description": "ID of the related asset to be deleted." } }, "required": [ "PCID", "assetId", "relationType", "relatedAssetId" ] } ``` *** ## adobe\_experience\_manager\_assets\_delete\_asset\_relations\_for\_relation\_type Delete all asset relations of the given relation type for an asset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset to access | | `relationType` | string | Yes | — | Name of relation type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset to access" }, "relationType": { "type": "string", "description": "Name of relation type" } }, "required": [ "PCID", "assetId", "relationType" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_asset Get an asset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." } }, "required": [ "PCID", "assetId" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_asset\_job\_status Get the status of an async job **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `jobId` | string | Yes | — | ID of an asynchronous job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "ID of an asynchronous job" } }, "required": [ "PCID", "jobId" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_asset\_metadata Delivers the specified asset's metadata **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset to access | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset to access" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." } }, "required": [ "PCID", "assetId" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_asset\_original Returns the originally uploaded binary for the asset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset | | `seoName` | string | Yes | — | any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset" }, "seoName": { "type": "string", "description": "any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." } }, "required": [ "PCID", "assetId", "seoName" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_asset\_relation\_types Get the relation types for an asset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset to access | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset to access" }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." } }, "required": [ "PCID", "assetId" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_asset\_relations Get the asset relations for an asset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset to access | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | | `relationTypes` | string\[] | No | — | Comma-delimited list of relation types to filter the asset relations to include only the specified types. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset to access" }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." }, "relationTypes": { "type": "array", "items": { "type": "string" }, "description": "Comma-delimited list of relation types to filter the asset relations to include only the specified types." } }, "required": [ "PCID", "assetId" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_asset\_relations\_for\_relation\_type Get the asset relations for an asset filtered by relation type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset to access | | `relationType` | string | Yes | — | Name of relation type | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset to access" }, "relationType": { "type": "string", "description": "Name of relation type" }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." } }, "required": [ "PCID", "assetId", "relationType" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_asset\_rendition Returns a pre-generated (on AEM Assets authoring environment) rendition of the asset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset | | `renditionName` | string | Yes | — | any url-encoded or alphanumeric, non-whitespace set of characters that need to match one of the renditions uploaded/created for the specified asset. may contain hyphens and dots | | `seoName` | string | Yes | — | any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | | `attachment` | string | No | — | Setting this parameter to `true` forces "download" prompt in browser by adapting the `Content-Disposition` appropriately. Default is `false`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset" }, "renditionName": { "type": "string", "description": "any url-encoded or alphanumeric, non-whitespace set of characters that need to match one of the renditions uploaded/created for the specified asset. may contain hyphens and dots" }, "seoName": { "type": "string", "description": "any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." }, "attachment": { "type": "string", "description": "Setting this parameter to `true` forces \"download\" prompt in browser by adapting the `Content-Disposition` appropriately. Default is `false`.", "enum": [ "true", "1", "false", "0" ] } }, "required": [ "PCID", "assetId", "renditionName", "seoName" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_asset\_renditions Returns a list of static renditions of an asset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." } }, "required": [ "PCID", "assetId" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_import\_job\_result Get Import Job Result **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `importJobId` | string | Yes | — | The identifier for an import job | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "importJobId": { "type": "string", "description": "The identifier for an import job" }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." } }, "required": [ "PCID", "importJobId" ] } ``` *** ## adobe\_experience\_manager\_assets\_get\_import\_job\_status Get Import Job Status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | | `importJobId` | string | Yes | — | The identifier for an import job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." }, "importJobId": { "type": "string", "description": "The identifier for an import job" } }, "required": [ "PCID", "importJobId" ] } ``` *** ## adobe\_experience\_manager\_assets\_import\_from\_url Import From Url **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetMetadata` | object | No | — | Metadata properties and values that should be applied to assets that are part of the import. Client should use the assetMetadata properties as exposed by the metadata API endpoints. | | `files` | object\[] | Yes | — | The files value | | `folder` | string | Yes | — | The ID or path for the folder into which to import the assets in AEM. | | `sourceName` | string | No | — | A user-friendly display name for the source of the assets | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetMetadata": { "type": "object", "description": "Metadata properties and values that should be applied to assets that are part of the import. Client should use the assetMetadata properties as exposed by the metadata API endpoints." }, "files": { "type": "array", "items": { "type": "object", "properties": { "assetMetadata": { "type": "object", "description": "Metadata properties and values that should be applied to assets that are part of the import. Client should use the assetMetadata properties as exposed by the metadata API endpoints." }, "fileName": { "type": "string", "description": "Name of the file as it will appear in the repository after upload" }, "mimeType": { "type": "string", "description": "The file format of the resource" }, "fileSize": { "type": "integer", "format": "int64", "description": "The size, in bytes, of the file to be imported" }, "url": { "type": "string", "format": "uri", "description": "The url from which to import" } }, "required": [ "fileName", "url" ] }, "description": "The files value" }, "folder": { "type": "string", "description": "The ID or path for the folder into which to import the assets in AEM." }, "sourceName": { "type": "string", "description": "A user-friendly display name for the source of the assets" } }, "required": [ "PCID", "files", "folder" ] } ``` *** ## adobe\_experience\_manager\_assets\_patch\_asset\_metadata Updates the asset's assetMetadata properties **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assetId` | string | Yes | — | ID of the asset to access | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `body` | object\[] | Yes | — | JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents. For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assetId": { "type": "string", "description": "ID of the asset to access" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "body": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "copy", "move", "remove", "replace", "test" ], "description": "The operation to perform" }, "path": { "type": "string", "description": "A JSON Pointer (RFC 6901) referencing the target location" }, "value": { "description": "The value to add/replace/test (required for add, replace, test operations)" }, "from": { "type": "string", "description": "A JSON Pointer referencing the source location (required for copy and move operations)" } }, "required": [ "op", "path" ] }, "description": "JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents. For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902)." } }, "required": [ "PCID", "assetId", "If-Match", "body" ] } ``` # adobe-experience-manager-folders Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/adobe-experience-manager/adobe-experience-manager-folders Adobe AEM Folders - create, list, and delete folders **Server path:** `/adobe-experience-manager-folders` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`adobe_experience_manager_folders_create_folders`](#adobe_experience_manager_folders_create_folders) | Creates new folders at the specified paths. | | [`adobe_experience_manager_folders_delete_by_path`](#adobe_experience_manager_folders_delete_by_path) | Delete folder(s) by path | | [`adobe_experience_manager_folders_delete_folder`](#adobe_experience_manager_folders_delete_folder) | Delete folder by its ID | | [`adobe_experience_manager_folders_get_by_path`](#adobe_experience_manager_folders_get_by_path) | List folders at the specified path | | [`adobe_experience_manager_folders_get_folder_by_id`](#adobe_experience_manager_folders_get_folder_by_id) | List folders under the specified folder ID | | [`adobe_experience_manager_folders_get_folder_job_result`](#adobe_experience_manager_folders_get_folder_job_result) | Get the results of a completed job | | [`adobe_experience_manager_folders_get_folder_job_status`](#adobe_experience_manager_folders_get_folder_job_status) | Get the status of an async job | *** ## adobe\_experience\_manager\_folders\_create\_folders Creates new folders at the specified paths. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "description": "The path of the folder to be created" }, "title": { "type": "string", "description": "The title of the folder to be created" } }, "required": [ "path" ] }, "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## adobe\_experience\_manager\_folders\_delete\_by\_path Delete folder(s) by path **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `force` | boolean | No | — | If true, delete the directory even if it is referenced | | `paths` | string\[] | Yes | — | The path of the folder to be deleted | | `recursive` | boolean | No | — | If true, delete the directory and all descendants | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "force": { "type": "boolean", "description": "If true, delete the directory even if it is referenced" }, "paths": { "type": "array", "items": { "type": "string" }, "description": "The path of the folder to be deleted" }, "recursive": { "type": "boolean", "description": "If true, delete the directory and all descendants" } }, "required": [ "PCID", "paths" ] } ``` *** ## adobe\_experience\_manager\_folders\_delete\_folder Delete folder by its ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | string | Yes | — | ID of the folder to access | | `recursive` | boolean | No | — | If true, delete the directory and all descendants | | `force` | boolean | No | — | If true, delete the directory even if it is referenced | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "folderId": { "type": "string", "description": "ID of the folder to access" }, "recursive": { "type": "boolean", "description": "If true, delete the directory and all descendants" }, "force": { "type": "boolean", "description": "If true, delete the directory even if it is referenced" } }, "required": [ "PCID", "folderId" ] } ``` *** ## adobe\_experience\_manager\_folders\_get\_by\_path List folders at the specified path **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | | `path` | string | No | — | Path of the folder from which to list the children. | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." }, "path": { "type": "string", "description": "Path of the folder from which to list the children." }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." } }, "required": [ "PCID" ] } ``` *** ## adobe\_experience\_manager\_folders\_get\_folder\_by\_id List folders under the specified folder ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | string | Yes | — | ID of the folder to access | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "folderId": { "type": "string", "description": "ID of the folder to access" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." } }, "required": [ "PCID", "folderId" ] } ``` *** ## adobe\_experience\_manager\_folders\_get\_folder\_job\_result Get the results of a completed job **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `jobId` | string | Yes | — | ID of a backend asynchronous job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "ID of a backend asynchronous job" } }, "required": [ "PCID", "jobId" ] } ``` *** ## adobe\_experience\_manager\_folders\_get\_folder\_job\_status Get the status of an async job **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `jobId` | string | Yes | — | ID of a backend asynchronous job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "ID of a backend asynchronous job" } }, "required": [ "PCID", "jobId" ] } ``` # adobe-experience-manager-sites Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/adobe-experience-manager/adobe-experience-manager-sites Adobe AEM Sites - content fragments, models, variations, versions, tags, and workflows **Server path:** `/adobe-experience-manager-sites` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`adobe_experience_manager_sites_batch_create`](#adobe_experience_manager_sites_batch_create) | Create a batch request | | [`adobe_experience_manager_sites_batch_get`](#adobe_experience_manager_sites_batch_get) | Retrieve the status of a batch request | | [`adobe_experience_manager_sites_batch_list`](#adobe_experience_manager_sites_batch_list) | List batch requests | | [`adobe_experience_manager_sites_fragment_add_tags_to_content_fragment`](#adobe_experience_manager_sites_fragment_add_tags_to_content_fragment) | Add tags to a Content Fragment | | [`adobe_experience_manager_sites_fragment_delete_tags_from_content_fragment`](#adobe_experience_manager_sites_fragment_delete_tags_from_content_fragment) | Delete the Tags applied to a Content Fragment | | [`adobe_experience_manager_sites_fragment_replace_tags_from_content_fragment`](#adobe_experience_manager_sites_fragment_replace_tags_from_content_fragment) | Replace the Tags applied to a Content Fragment | | [`adobe_experience_manager_sites_fragment_variations_delete_variation`](#adobe_experience_manager_sites_fragment_variations_delete_variation) | Delete a Content Fragment Variation | | [`adobe_experience_manager_sites_fragment_variations_update_variation`](#adobe_experience_manager_sites_fragment_variations_update_variation) | Edit a Content Fragment Variation | | [`adobe_experience_manager_sites_fragments_add_tags_to_variation`](#adobe_experience_manager_sites_fragments_add_tags_to_variation) | Add Tags to a Content Fragment Variation | | [`adobe_experience_manager_sites_fragments_change_model`](#adobe_experience_manager_sites_fragments_change_model) | Change the model of a Content Fragment | | [`adobe_experience_manager_sites_fragments_copy`](#adobe_experience_manager_sites_fragments_copy) | Copy a Content Fragment | | [`adobe_experience_manager_sites_fragments_copy_tree`](#adobe_experience_manager_sites_fragments_copy_tree) | Copy a Content Fragment | | [`adobe_experience_manager_sites_fragments_create_fragment`](#adobe_experience_manager_sites_fragments_create_fragment) | Create a Content Fragment | | [`adobe_experience_manager_sites_fragments_create_variation_for_fragment`](#adobe_experience_manager_sites_fragments_create_variation_for_fragment) | Create a Content Fragment Variation | | [`adobe_experience_manager_sites_fragments_create_versions_for_fragment`](#adobe_experience_manager_sites_fragments_create_versions_for_fragment) | Create a Version for a Content Fragment | | [`adobe_experience_manager_sites_fragments_delete_and_unpublish_fragment`](#adobe_experience_manager_sites_fragments_delete_and_unpublish_fragment) | Delete and unpublish Content Fragment | | [`adobe_experience_manager_sites_fragments_delete_fragment`](#adobe_experience_manager_sites_fragments_delete_fragment) | Delete a Content Fragment | | [`adobe_experience_manager_sites_fragments_delete_tags_from_variation`](#adobe_experience_manager_sites_fragments_delete_tags_from_variation) | Delete the Tags applied to a Content Fragment Variation | | [`adobe_experience_manager_sites_fragments_delete_version`](#adobe_experience_manager_sites_fragments_delete_version) | Delete a Content Fragment Version | | [`adobe_experience_manager_sites_fragments_find_and_replace`](#adobe_experience_manager_sites_fragments_find_and_replace) | Find and replace text in Content Fragments | | [`adobe_experience_manager_sites_fragments_fragment_referenced_by`](#adobe_experience_manager_sites_fragments_fragment_referenced_by) | Get the parent references of a Content Fragment | | [`adobe_experience_manager_sites_fragments_fully_update_fragment`](#adobe_experience_manager_sites_fragments_fully_update_fragment) | Update all mutable properties of a Content Fragment | | [`adobe_experience_manager_sites_fragments_get_domain`](#adobe_experience_manager_sites_fragments_get_domain) | Get the domain URL matching the AEM tier environment provided. | | [`adobe_experience_manager_sites_fragments_get_fragment`](#adobe_experience_manager_sites_fragments_get_fragment) | Get a Content Fragment | | [`adobe_experience_manager_sites_fragments_get_fragment_references`](#adobe_experience_manager_sites_fragments_get_fragment_references) | Get the references of a Content Fragment | | [`adobe_experience_manager_sites_fragments_get_fragment_references_tree`](#adobe_experience_manager_sites_fragments_get_fragment_references_tree) | Get the references of a Content Fragment as a list | | [`adobe_experience_manager_sites_fragments_get_fragment_variation_references`](#adobe_experience_manager_sites_fragments_get_fragment_variation_references) | Get the tree of references contained in a Content Fragment Variation | | [`adobe_experience_manager_sites_fragments_get_fragment_version`](#adobe_experience_manager_sites_fragments_get_fragment_version) | Get a Version for a Content Fragment | | [`adobe_experience_manager_sites_fragments_get_fragments`](#adobe_experience_manager_sites_fragments_get_fragments) | List all Content Fragments | | [`adobe_experience_manager_sites_fragments_get_languages`](#adobe_experience_manager_sites_fragments_get_languages) | Get the available language(s) for creating Language Copies for a given Content Fragment path | | [`adobe_experience_manager_sites_fragments_get_model`](#adobe_experience_manager_sites_fragments_get_model) | Get the model of a Content Fragment | | [`adobe_experience_manager_sites_fragments_get_permissions`](#adobe_experience_manager_sites_fragments_get_permissions) | Get the current user's permissions on a Content Fragment | | [`adobe_experience_manager_sites_fragments_get_preview_urlfor_fragment`](#adobe_experience_manager_sites_fragments_get_preview_urlfor_fragment) | Get the preview URLs for a Content Fragment | | [`adobe_experience_manager_sites_fragments_get_tags_from_fragment`](#adobe_experience_manager_sites_fragments_get_tags_from_fragment) | Get the Tags applied to a Content Fragment | | [`adobe_experience_manager_sites_fragments_get_tags_from_variation`](#adobe_experience_manager_sites_fragments_get_tags_from_variation) | Get the Tags applied to a Content Fragment Variation | | [`adobe_experience_manager_sites_fragments_get_translations`](#adobe_experience_manager_sites_fragments_get_translations) | Get the locales and language copies of a Content Fragment | | [`adobe_experience_manager_sites_fragments_get_variation_for_fragment`](#adobe_experience_manager_sites_fragments_get_variation_for_fragment) | Get a Variation for a Content Fragment | | [`adobe_experience_manager_sites_fragments_get_variations_for_fragment`](#adobe_experience_manager_sites_fragments_get_variations_for_fragment) | List a Content Fragment's Variations | | [`adobe_experience_manager_sites_fragments_get_versions_for_fragment`](#adobe_experience_manager_sites_fragments_get_versions_for_fragment) | List a Content Fragment's Versions | | [`adobe_experience_manager_sites_fragments_permissions`](#adobe_experience_manager_sites_fragments_permissions) | Get the current's user permissions on a list of resources | | [`adobe_experience_manager_sites_fragments_publish`](#adobe_experience_manager_sites_fragments_publish) | Publish Content Fragments | | [`adobe_experience_manager_sites_fragments_referenced_by`](#adobe_experience_manager_sites_fragments_referenced_by) | Get the parent references of a given list of resources | | [`adobe_experience_manager_sites_fragments_replace_tags_from_variation`](#adobe_experience_manager_sites_fragments_replace_tags_from_variation) | Replace the Tags applied to a Content Fragment Variation | | [`adobe_experience_manager_sites_fragments_restore_version`](#adobe_experience_manager_sites_fragments_restore_version) | Restore a Content Fragment Version | | [`adobe_experience_manager_sites_fragments_retrieve_model_uischema`](#adobe_experience_manager_sites_fragments_retrieve_model_uischema) | Get the UI schema associated with the Content Fragment Model of a Content Fragment | | [`adobe_experience_manager_sites_fragments_scheduled_publication_status`](#adobe_experience_manager_sites_fragments_scheduled_publication_status) | Get the scheduled publication status for a Content Fragment | | [`adobe_experience_manager_sites_fragments_scheduled_publication_status_multiple_fragments`](#adobe_experience_manager_sites_fragments_scheduled_publication_status_multiple_fragments) | Get the scheduled publication status for a list of Content Fragment IDs | | [`adobe_experience_manager_sites_fragments_search`](#adobe_experience_manager_sites_fragments_search) | Search API for Content Fragments based on various Search Criteria. | | [`adobe_experience_manager_sites_fragments_translations`](#adobe_experience_manager_sites_fragments_translations) | Get the locales and language copies of a given list of resources | | [`adobe_experience_manager_sites_fragments_update_checkout_state`](#adobe_experience_manager_sites_fragments_update_checkout_state) | Update checkout state of a Content Fragment | | [`adobe_experience_manager_sites_fragments_update_fragment`](#adobe_experience_manager_sites_fragments_update_fragment) | Edit a Content Fragment | | [`adobe_experience_manager_sites_graph_ql_get`](#adobe_experience_manager_sites_graph_ql_get) | GraphQL GET request | | [`adobe_experience_manager_sites_graph_ql_post`](#adobe_experience_manager_sites_graph_ql_post) | GraphQL POST request | | [`adobe_experience_manager_sites_models_add_tags_to_content_fragment_model`](#adobe_experience_manager_sites_models_add_tags_to_content_fragment_model) | Add Tags to a Content Fragment Model | | [`adobe_experience_manager_sites_models_copy`](#adobe_experience_manager_sites_models_copy) | Copy a Content Fragment Model | | [`adobe_experience_manager_sites_models_create_model`](#adobe_experience_manager_sites_models_create_model) | Create a Content Fragment Model | | [`adobe_experience_manager_sites_models_create_or_update_uischema`](#adobe_experience_manager_sites_models_create_or_update_uischema) | Update the existing UI schema associated with a Content Fragment Model | | [`adobe_experience_manager_sites_models_delete_model`](#adobe_experience_manager_sites_models_delete_model) | Delete a Content Fragment Model | | [`adobe_experience_manager_sites_models_delete_tags_from_content_fragment_model`](#adobe_experience_manager_sites_models_delete_tags_from_content_fragment_model) | Delete the Tags applied to a Content Fragment Model | | [`adobe_experience_manager_sites_models_get_model`](#adobe_experience_manager_sites_models_get_model) | Get a Content Fragment Model | | [`adobe_experience_manager_sites_models_get_models`](#adobe_experience_manager_sites_models_get_models) | List all Content Fragment Models | | [`adobe_experience_manager_sites_models_get_tags_from_content_fragment_model`](#adobe_experience_manager_sites_models_get_tags_from_content_fragment_model) | Get the Tags applied to a Content Fragment Model | | [`adobe_experience_manager_sites_models_publish`](#adobe_experience_manager_sites_models_publish) | Publish Content Fragment Models | | [`adobe_experience_manager_sites_models_replace_tags_from_content_fragment_model`](#adobe_experience_manager_sites_models_replace_tags_from_content_fragment_model) | Replace the Tags applied to a Content Fragment Model | | [`adobe_experience_manager_sites_models_retrieve_uischema`](#adobe_experience_manager_sites_models_retrieve_uischema) | Get the UI schema associated with the Content Fragment Model | | [`adobe_experience_manager_sites_models_scheduled_publication_status_multiple_models`](#adobe_experience_manager_sites_models_scheduled_publication_status_multiple_models) | Get the scheduled publication status for a list of Content Fragment Models | | [`adobe_experience_manager_sites_models_search`](#adobe_experience_manager_sites_models_search) | Search API for Content Fragment Models based on various Search Criteria. | | [`adobe_experience_manager_sites_models_update_model`](#adobe_experience_manager_sites_models_update_model) | Edit a Content Fragment Model | | [`adobe_experience_manager_sites_permissions`](#adobe_experience_manager_sites_permissions) | Get the current's user permissions on a list of resources | | [`adobe_experience_manager_sites_workflows_get_workflow`](#adobe_experience_manager_sites_workflows_get_workflow) | Get a Workflow | | [`adobe_experience_manager_sites_workflows_get_workflows`](#adobe_experience_manager_sites_workflows_get_workflows) | List Workflows | | [`adobe_experience_manager_sites_workflows_start`](#adobe_experience_manager_sites_workflows_start) | Start a workflow | *** ## adobe\_experience\_manager\_sites\_batch\_create Create a batch request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `requests` | object\[] | Yes | — | The requests value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "requests": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "description": "The path part of the request URL." }, "method": { "type": "string", "enum": [ "POST", "PUT", "DELETE", "PATCH" ], "description": "The HTTP method of the request." }, "headers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name." }, "value": { "type": "string", "description": "The value." } } }, "description": "The headers value" }, "queryParameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name." }, "value": { "type": "string", "description": "The value." } } }, "description": "Query Parameters" }, "body": { "type": "object", "description": "The body value" } }, "required": [ "path", "method" ] }, "description": "The requests value" } }, "required": [ "PCID", "requests" ] } ``` *** ## adobe\_experience\_manager\_sites\_batch\_get Retrieve the status of a batch request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The ID of the Batch Request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the Batch Request" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_experience\_manager\_sites\_batch\_list List batch requests **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `jobStatus` | string | No | — | If this optional parameter is provided, the batch requests will be filtered based on their status. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "jobStatus": { "type": "string", "description": "If this optional parameter is provided, the batch requests will be filtered based on their status.", "enum": [ "FINISHED", "FINISHED_SUCCESS", "FINISHED_FAILURE", "UNFINISHED", "UNFINISHED_ACTIVE", "UNFINISHED_QUEUED" ] } }, "required": [ "PCID" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragment\_add\_tags\_to\_content\_fragment Add tags to a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `tags` | string\[] | Yes | — | List of tag IDs to be added to the Content Fragment | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag IDs to be added to the Content Fragment" } }, "required": [ "PCID", "fragmentId", "tags" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragment\_delete\_tags\_from\_content\_fragment Delete the Tags applied to a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." } }, "required": [ "PCID", "fragmentId", "If-Match" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragment\_replace\_tags\_from\_content\_fragment Replace the Tags applied to a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `tags` | string\[] | Yes | — | List of tag IDs to be added to the Content Fragment | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag IDs to be added to the Content Fragment" } }, "required": [ "PCID", "fragmentId", "If-Match", "tags" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragment\_variations\_delete\_variation Delete a Content Fragment Variation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `name` | string | Yes | — | The name of the Variation | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `unlinkReferences` | boolean | No | — | Optional boolean parameter, if set to `true`, the references to the deleted fragment will be removed from the referencing fragments. By default, the value of this query parameter is `false`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "name": { "type": "string", "description": "The name of the Variation" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "unlinkReferences": { "type": "boolean", "description": "Optional boolean parameter, if set to `true`, the references to the deleted fragment will be removed from the referencing fragments. By default, the value of this query parameter is `false`." } }, "required": [ "PCID", "fragmentId", "name", "If-Match" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragment\_variations\_update\_variation Edit a Content Fragment Variation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `name` | string | Yes | — | The name of the Variation | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `body` | object\[] | Yes | — | JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents. For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "name": { "type": "string", "description": "The name of the Variation" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "body": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "copy", "move", "remove", "replace", "test" ], "description": "The operation to perform" }, "path": { "type": "string", "description": "A JSON Pointer (RFC 6901) referencing the target location" }, "value": { "description": "The value to add/replace/test (required for add, replace, test operations)" }, "from": { "type": "string", "description": "A JSON Pointer referencing the source location (required for copy and move operations)" } }, "required": [ "op", "path" ] }, "description": "JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents. For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902)." } }, "required": [ "PCID", "fragmentId", "name", "If-Match", "body" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_add\_tags\_to\_variation Add Tags to a Content Fragment Variation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `name` | string | Yes | — | The name of the variation for which the tags are retrieved. | | `tags` | string\[] | Yes | — | List of tag IDs to be added to the Content Fragment | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "name": { "type": "string", "description": "The name of the variation for which the tags are retrieved." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag IDs to be added to the Content Fragment" } }, "required": [ "PCID", "fragmentId", "name", "tags" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_change\_model Change the model of a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `modelId` | string | Yes | — | Defines a `base64url` with no padding encoded ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "modelId": { "type": "string", "description": "Defines a `base64url` with no padding encoded ID." } }, "required": [ "PCID", "fragmentId", "If-Match", "modelId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_copy Copy a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | The unique identifier of the Content Fragment to be copied. | | `name` | string | No | — | This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the destination folder, the server will automatically generate an alternative resource name based on the provided value. When a value is provided and a conflict exists in the destination folder, the caller will have to explicitly solve the conflict. | | `parentPath` | string | Yes | — | The folder to which the Content Fragment should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error. This path should start with `/content/dam` or should be relative to the `/content/dam` folder. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "The unique identifier of the Content Fragment to be copied." }, "name": { "type": "string", "description": "This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the destination folder, the server will automatically generate an alternative resource name based on the provided value. When a value is provided and a conflict exists in the destination folder, the caller will have to explicitly solve the conflict." }, "parentPath": { "type": "string", "description": "The folder to which the Content Fragment should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error. This path should start with `/content/dam` or should be relative to the `/content/dam` folder." } }, "required": [ "PCID", "fragmentId", "parentPath" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_copy\_tree Copy a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | The unique identifier of the Content Fragment to be copied. | | `copyReferencesToMainFolder` | boolean | No | — | If set to true, the references of the Content Fragment will be copied under the same folder as the main Content Fragment. If set to false, the references will be copied under their original folders. | | `name` | string | No | — | This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the destination folder, the server will automatically generate an alternative resource name based on the provided value. When a value is provided and a conflict exists in the destination folder, the caller will have to explicitly solve the conflict. | | `parentPath` | string | Yes | — | The folder to which the Content Fragment should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error. This path should start with `/content/dam` or should be relative to the `/content/dam` folder. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "The unique identifier of the Content Fragment to be copied." }, "copyReferencesToMainFolder": { "type": "boolean", "description": "If set to true, the references of the Content Fragment will be copied under the same folder as the main Content Fragment. If set to false, the references will be copied under their original folders." }, "name": { "type": "string", "description": "This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the destination folder, the server will automatically generate an alternative resource name based on the provided value. When a value is provided and a conflict exists in the destination folder, the caller will have to explicitly solve the conflict." }, "parentPath": { "type": "string", "description": "The folder to which the Content Fragment should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error. This path should start with `/content/dam` or should be relative to the `/content/dam` folder." } }, "required": [ "PCID", "fragmentId", "parentPath" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_create\_fragment Create a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `description` | string | No | — | The description of the new Content Fragment. | | `fields` | object\[] | No | — | Data needed for populating the content fragment fields defined in the model | | `modelId` | string | Yes | — | Defines a `base64url` with no padding encoded ID. | | `name` | string | No | — | Optional parameter that represents the name used when storing the new Content Fragment. When missing, the value will be derived by the server from the `title` value. | | `parentPath` | string | Yes | — | The folder path where the new Content Fragment will be created, relative to `/content/dam`. Examples: - `/wknd-shared/en/adventures` creates fragment at `/content/dam/wknd-shared/en/adventures` - `/my-site/content` creates fragment at `/content/dam/my-site/content` | | `title` | string | Yes | — | The title of the new Content Fragment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "The description of the new Content Fragment." }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the field." }, "type": { "type": "string", "enum": [ "text", "long-text", "number", "float-number", "date-time", "date", "time", "boolean", "enumeration", "tag", "content-fragment", "content-reference", "json" ], "description": "Type of data stored in the field." }, "multiple": { "type": "boolean", "description": "Whether the field has multiple values." }, "locked": { "type": "boolean", "description": "If set to true, the field cannot be edited. In case of live copies, the field inherits its value from the source content fragment and cannot be edited." } }, "required": [ "name", "type" ] }, "description": "Data needed for populating the content fragment fields defined in the model" }, "modelId": { "type": "string", "description": "Defines a `base64url` with no padding encoded ID." }, "name": { "type": "string", "description": "Optional parameter that represents the name used when storing the new Content Fragment. When missing, the value will be derived by the server from the `title` value." }, "parentPath": { "type": "string", "description": "The folder path where the new Content Fragment will be created, relative to `/content/dam`. Examples: - `/wknd-shared/en/adventures` creates fragment at `/content/dam/wknd-shared/en/adventures` - `/my-site/content` creates fragment at `/content/dam/my-site/content`" }, "title": { "type": "string", "description": "The title of the new Content Fragment." } }, "required": [ "PCID", "modelId", "parentPath", "title" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_create\_variation\_for\_fragment Create a Content Fragment Variation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `description` | string | No | — | Variation description. | | `title` | string | Yes | — | Variation title | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "description": { "type": "string", "description": "Variation description." }, "title": { "type": "string", "description": "Variation title" } }, "required": [ "PCID", "fragmentId", "title" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_create\_versions\_for\_fragment Create a Version for a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `comment` | string | No | — | Content Fragment version comment. | | `label` | string | No | — | Content Fragment version label. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "comment": { "type": "string", "description": "Content Fragment version comment." }, "label": { "type": "string", "description": "Content Fragment version label." } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_delete\_and\_unpublish\_fragment Delete and unpublish Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `unlinkReferences` | boolean | No | — | An optional boolean parameter. When set to `true`, the references to the deleted fragment are removed from all referencing fragments. By default, the value of this query parameter is `true`. | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "unlinkReferences": { "type": "boolean", "description": "An optional boolean parameter. When set to `true`, the references to the deleted fragment are removed from all referencing fragments. By default, the value of this query parameter is `true`." }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." } }, "required": [ "PCID", "fragmentId", "If-Match" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_delete\_fragment Delete a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `unlinkReferences` | boolean | No | — | Optional boolean parameter, if set to `true`, the references to the deleted fragment will be removed from the referencing fragments. By default, the value of this query parameter is `false`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "unlinkReferences": { "type": "boolean", "description": "Optional boolean parameter, if set to `true`, the references to the deleted fragment will be removed from the referencing fragments. By default, the value of this query parameter is `false`." } }, "required": [ "PCID", "fragmentId", "If-Match" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_delete\_tags\_from\_variation Delete the Tags applied to a Content Fragment Variation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `name` | string | Yes | — | The name of the variation for which the tags are retrieved. | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "name": { "type": "string", "description": "The name of the variation for which the tags are retrieved." }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." } }, "required": [ "PCID", "fragmentId", "name", "If-Match" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_delete\_version Delete a Content Fragment Version **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `versionId` | string | Yes | — | Content Fragment Version unique identifier | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "versionId": { "type": "string", "description": "Content Fragment Version unique identifier" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." } }, "required": [ "PCID", "fragmentId", "versionId", "If-Match" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_find\_and\_replace Find and replace text in Content Fragments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dryRun` | boolean | Yes | — | Find And Replace operation runs in simulation mode, we only get simulated results and no change is committed in JCR. | | `fieldNames` | string\[] | No | — | An optional list of text and long text field names. If provided, it will be used to restrict the Find And Replace operation to those specific fields within the Content Fragments. If not provided, the operation will be performed on all text and long text fields. | | `find` | string | Yes | — | String we want to replace in all TEXT fields in selected Content Fragments | | `ignoreErrors` | boolean | Yes | — | True means that we want replacement taking place for all cases when Replacement would be successful and do nothing for cases in error. | | `isCaseSensitive` | boolean | No | — | True means that we want to perform case sensitive search. | | `matchExactWord` | boolean | No | — | A flag indicating whether to only consider the exact matches of the `find` String When set to `true` (optional), the replacement will occur only for occurrences of the `find` String that are entire words, excluding parts of compound words. When set to `false` (default), the replacement will happen for any occurrence of the `find` String, including within compound words. | | `paths` | string\[] | Yes | — | The list of Content Fragments paths on which Find And Replace operation is performed. | | `replace` | string | Yes | — | Replacement string. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dryRun": { "type": "boolean", "description": "Find And Replace operation runs in simulation mode, we only get simulated results and no change is committed in JCR." }, "fieldNames": { "type": "array", "items": { "type": "string" }, "description": "An optional list of text and long text field names. If provided, it will be used to restrict the Find And Replace operation to those specific fields within the Content Fragments. If not provided, the operation will be performed on all text and long text fields." }, "find": { "type": "string", "description": "String we want to replace in all TEXT fields in selected Content Fragments" }, "ignoreErrors": { "type": "boolean", "description": "True means that we want replacement taking place for all cases when Replacement would be successful and do nothing for cases in error." }, "isCaseSensitive": { "type": "boolean", "description": "True means that we want to perform case sensitive search." }, "matchExactWord": { "type": "boolean", "description": "A flag indicating whether to only consider the exact matches of the `find` String When set to `true` (optional), the replacement will occur only for occurrences of the `find` String that are entire words, excluding parts of compound words. When set to `false` (default), the replacement will happen for any occurrence of the `find` String, including within compound words." }, "paths": { "type": "array", "items": { "type": "string" }, "description": "The list of Content Fragments paths on which Find And Replace operation is performed." }, "replace": { "type": "string", "description": "Replacement string." } }, "required": [ "PCID", "dryRun", "find", "ignoreErrors", "paths", "replace" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_fragment\_referenced\_by Get the parent references of a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_fully\_update\_fragment Update all mutable properties of a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `description` | string | No | — | Updated description of the Content Fragment. | | `fields` | object\[] | No | — | Updated fields on the Content Fragment. | | `title` | string | Yes | — | Updated title of the Content Fragment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "description": { "type": "string", "description": "Updated description of the Content Fragment." }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the field." }, "type": { "type": "string", "enum": [ "text", "long-text", "number", "float-number", "date-time", "date", "time", "boolean", "enumeration", "tag", "content-fragment", "content-reference", "json" ], "description": "Type of data stored in the field." }, "multiple": { "type": "boolean", "description": "Whether the field has multiple values." }, "locked": { "type": "boolean", "description": "If set to true, the field cannot be edited. In case of live copies, the field inherits its value from the source content fragment and cannot be edited." } }, "required": [ "name", "type" ] }, "description": "Updated fields on the Content Fragment." }, "title": { "type": "string", "description": "Updated title of the Content Fragment." } }, "required": [ "PCID", "fragmentId", "If-Match", "title" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_domain Get the domain URL matching the AEM tier environment provided. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_fragment Get a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | | `references` | string | No | — | This parameter defines how references will be retrieved for Content Fragments. The following options are available: \* `direct` - only direct references will be collected; they will not be hydrated; \* `direct-hydrated` - only direct references will be collected; they will be fully hydrated; \* `all` - all references up to the maximum allowed depth will be collected; they will not be hydrated; \* `all-hydrated` - all references up to the maximum allowed depth will be collected; they will be fully hydrated \* `none` - no references will be collected Non-hydrated responses will only include the properties defined by the `BaseReference` type when embedding references. Hydrated responses are defined by each implementation of the `BaseReference` type. In particular, for Content Fragment references the response will include the fragment's fields, variations, tags. | | `locale` | string | No | — | An optional parameter that specifies the locale of the Content Fragment, using a language and country code (e.g. en\_us). If provided, the corresponding language copy of the Content Fragment will be returned if available. If not available, a 404 error will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." }, "references": { "type": "string", "description": "This parameter defines how references will be retrieved for Content Fragments. The following options are available: * `direct` - only direct references will be collected; they will not be hydrated; * `direct-hydrated` - only direct references will be collected; they will be fully hydrated; * `all` - all references up to the maximum allowed depth will be collected; they will not be hydrated; * `all-hydrated` - all references up to the maximum allowed depth will be collected; they will be fully hydrated * `none` - no references will be collected Non-hydrated responses will only include the properties defined by the `BaseReference` type when embedding references. Hydrated responses are defined by each implementation of the `BaseReference` type. In particular, for Content Fragment references the response will include the fragment's fields, variations, tags.", "enum": [ "direct", "direct-hydrated", "all", "all-hydrated", "none" ] }, "locale": { "type": "string", "description": "An optional parameter that specifies the locale of the Content Fragment, using a language and country code (e.g. en_us). If provided, the corresponding language copy of the Content Fragment will be returned if available. If not available, a 404 error will be returned." } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_fragment\_references Get the references of a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Resource unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Resource unique identifier" } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_fragment\_references\_tree Get the references of a Content Fragment as a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Resource unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Resource unique identifier" } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_fragment\_variation\_references Get the tree of references contained in a Content Fragment Variation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Resource unique identifier | | `name` | string | Yes | — | The name of the variation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Resource unique identifier" }, "name": { "type": "string", "description": "The name of the variation" } }, "required": [ "PCID", "fragmentId", "name" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_fragment\_version Get a Version for a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `versionId` | string | Yes | — | Content Fragment Version unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "versionId": { "type": "string", "description": "Content Fragment Version unique identifier" } }, "required": [ "PCID", "fragmentId", "versionId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_fragments List all Content Fragments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `path` | string | No | — | Optional UTF-8 encoded parameter to specify a path where to start looking for content fragments. | | `references` | string | No | — | When the `path` query parameter identifies a Content Fragment, this parameter allows controlling the way the references are retrieved for that fragment. When this parameter is missing, the references will not be populated. The following options are available: \* `direct` - only direct references will be collected; they will not be hydrated; \* `direct-hydrated` - only direct references will be collected; they will be fully hydrated; \* `all` - all references up to the maximum allowed depth will be collected; they will not be hydrated; \* `all-hydrated` - all references up to the maximum allowed depth will be collected; they will be fully hydrated \* `none` - no references will be collected Non-hydrated responses will only include the properties defined by the `BaseReference` type when embedding references. Hydrated responses are defined by each implementation of the `BaseReference` type. In particular, for Content Fragment references the response will include the fragment's fields, variations, tags. | | `projection` | string | No | — | If this optional parameter is provided and its value is 'summary', the fragments in the response will contain only the required properties. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "path": { "type": "string", "description": "Optional UTF-8 encoded parameter to specify a path where to start looking for content fragments." }, "references": { "type": "string", "description": "When the `path` query parameter identifies a Content Fragment, this parameter allows controlling the way the references are retrieved for that fragment. When this parameter is missing, the references will not be populated. The following options are available: * `direct` - only direct references will be collected; they will not be hydrated; * `direct-hydrated` - only direct references will be collected; they will be fully hydrated; * `all` - all references up to the maximum allowed depth will be collected; they will not be hydrated; * `all-hydrated` - all references up to the maximum allowed depth will be collected; they will be fully hydrated * `none` - no references will be collected Non-hydrated responses will only include the properties defined by the `BaseReference` type when embedding references. Hydrated responses are defined by each implementation of the `BaseReference` type. In particular, for Content Fragment references the response will include the fragment's fields, variations, tags.", "enum": [ "direct", "direct-hydrated", "all", "all-hydrated", "none" ] }, "projection": { "type": "string", "description": "If this optional parameter is provided and its value is 'summary', the fragments in the response will contain only the required properties.", "enum": [ "minimal", "summary", "full" ] } }, "required": [ "PCID" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_languages Get the available language(s) for creating Language Copies for a given Content Fragment path **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `path` | string | Yes | — | Required UTF-8 encoded parameter to specify a Content Fragment path for which to retrieve the available language roots. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "path": { "type": "string", "description": "Required UTF-8 encoded parameter to specify a Content Fragment path for which to retrieve the available language roots." } }, "required": [ "PCID", "path" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_model Get the model of a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_permissions Get the current user's permissions on a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_preview\_urlfor\_fragment Get the preview URLs for a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_tags\_from\_fragment Get the Tags applied to a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_tags\_from\_variation Get the Tags applied to a Content Fragment Variation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `name` | string | Yes | — | The name of the variation for which the tags are retrieved. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "name": { "type": "string", "description": "The name of the variation for which the tags are retrieved." } }, "required": [ "PCID", "fragmentId", "name" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_translations Get the locales and language copies of a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_variation\_for\_fragment Get a Variation for a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `name` | string | Yes | — | The name of the Variation | | `references` | string | No | — | This parameter defines how references will be retrieved for Content Fragments. The following options are available: \* `direct` - only direct references will be collected; they will not be hydrated; \* `direct-hydrated` - only direct references will be collected; they will be fully hydrated; \* `all` - all references up to the maximum allowed depth will be collected; they will not be hydrated; \* `all-hydrated` - all references up to the maximum allowed depth will be collected; they will be fully hydrated \* `none` - no references will be collected Non-hydrated responses will only include the properties defined by the `BaseReference` type when embedding references. Hydrated responses are defined by each implementation of the `BaseReference` type. In particular, for Content Fragment references the response will include the fragment's fields, variations, tags. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "name": { "type": "string", "description": "The name of the Variation" }, "references": { "type": "string", "description": "This parameter defines how references will be retrieved for Content Fragments. The following options are available: * `direct` - only direct references will be collected; they will not be hydrated; * `direct-hydrated` - only direct references will be collected; they will be fully hydrated; * `all` - all references up to the maximum allowed depth will be collected; they will not be hydrated; * `all-hydrated` - all references up to the maximum allowed depth will be collected; they will be fully hydrated * `none` - no references will be collected Non-hydrated responses will only include the properties defined by the `BaseReference` type when embedding references. Hydrated responses are defined by each implementation of the `BaseReference` type. In particular, for Content Fragment references the response will include the fragment's fields, variations, tags.", "enum": [ "direct", "direct-hydrated", "all", "all-hydrated", "none" ] } }, "required": [ "PCID", "fragmentId", "name" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_variations\_for\_fragment List a Content Fragment's Variations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_get\_versions\_for\_fragment List a Content Fragment's Versions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_permissions Get the current's user permissions on a list of resources **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `paths` | string\[] | Yes | — | The list of resource paths - Content Fragments, Content Fragment Models and Folder - for which the system has to return the list of permissions for a user. The Content Fragments are expected to be within the `/content/dam` directory, the Content Fragment Models within the `/conf` directory, and the Folders could be within either `/content/dam` or the `/conf` directory. | | `preferredPermissions` | string\[] | No | — | The preferred list of permissions to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "paths": { "type": "array", "items": { "type": "string" }, "description": "The list of resource paths - Content Fragments, Content Fragment Models and Folder - for which the system has to return the list of permissions for a user. The Content Fragments are expected to be within the `/content/dam` directory, the Content Fragment Models within the `/conf` directory, and the Folders could be within either `/content/dam` or the `/conf` directory." }, "preferredPermissions": { "type": "array", "items": { "type": "string", "enum": [ "READ", "EDIT", "RENAME", "DELETE", "PUBLISH", "CREATE_CONTENT_FRAGMENT", "CREATE_CONTENT_FRAGMENT_MODEL", "CHECKIN", "CHECKOUT" ] }, "description": "The preferred list of permissions to return." } }, "required": [ "PCID", "paths" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_publish Publish Content Fragments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agentId` | string | No | — | The agent id used for publishing the content fragments. | | `filterReferencesByStatus` | object\[] | No | — | Provides the option to select which references should be included in the publication based on their status. When a status is selected (e.g., `DRAFT`), references with that status will be published along with the content fragment. Multiple statuses can be selected to include references with any of those statuses. If no option is selected, no references will be published regardless of their status. | | `ids` | string\[] | No | — | The list of content fragment IDs. | | `paths` | string\[] | No | — | The list of content fragment paths. | | `preValidationSeconds` | integer | No | — | If this property is provided, a validation of all the fragments contained in the payload together with all their references will be attempted. This validation only applies when `filterReferencesByStatus` is populated, as it validates the complete references tree based on the selected reference statuses. Without `filterReferencesByStatus`, there are no references to validate, making this property ineffective. The cutoff limit for this validation will be the provided value in seconds. The fragments from the payload which will be found invalid in the allocated interval will be removed from the publish operation and their status will be returned as such in the response. In case there are no valid fragments in the payload after the validation, the workflow will not be started. | | `scheduledTime` | integer | No | — | The scheduled time as an epoch timestamp. | | `workflowModelId` | string | No | — | The workflow model id used for initiating the workflow instance to handle the publication. AEM provides the designated model `/etc/workflow/models/scheduled_activation_with_references` for publishing content fragments including their references. | | `workflowTitle` | string | No | — | A freely defined non-empty string used to identify the workflow when it executes. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agentId": { "type": "string", "description": "The agent id used for publishing the content fragments." }, "filterReferencesByStatus": { "type": "array", "items": { "enum": [ "DRAFT", "UNPUBLISHED", "MODIFIED" ] }, "description": "Provides the option to select which references should be included in the publication based on their status. When a status is selected (e.g., `DRAFT`), references with that status will be published along with the content fragment. Multiple statuses can be selected to include references with any of those statuses. If no option is selected, no references will be published regardless of their status." }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The list of content fragment IDs." }, "paths": { "type": "array", "items": { "type": "string" }, "description": "The list of content fragment paths." }, "preValidationSeconds": { "type": "integer", "description": "If this property is provided, a validation of all the fragments contained in the payload together with all their references will be attempted. This validation only applies when `filterReferencesByStatus` is populated, as it validates the complete references tree based on the selected reference statuses. Without `filterReferencesByStatus`, there are no references to validate, making this property ineffective. The cutoff limit for this validation will be the provided value in seconds. The fragments from the payload which will be found invalid in the allocated interval will be removed from the publish operation and their status will be returned as such in the response. In case there are no valid fragments in the payload after the validation, the workflow will not be started." }, "scheduledTime": { "type": "integer", "description": "The scheduled time as an epoch timestamp." }, "workflowModelId": { "type": "string", "description": "The workflow model id used for initiating the workflow instance to handle the publication. AEM provides the designated model `/etc/workflow/models/scheduled_activation_with_references` for publishing content fragments including their references." }, "workflowTitle": { "type": "string", "description": "A freely defined non-empty string used to identify the workflow when it executes." } }, "required": [ "PCID" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_referenced\_by Get the parent references of a given list of resources **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `paths` | string\[] | Yes | — | The list of Content Fragment paths for which to retrieve the back references. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "paths": { "type": "array", "items": { "type": "string" }, "description": "The list of Content Fragment paths for which to retrieve the back references." } }, "required": [ "PCID", "paths" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_replace\_tags\_from\_variation Replace the Tags applied to a Content Fragment Variation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `name` | string | Yes | — | The name of the variation for which the tags are retrieved. | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `tags` | string\[] | Yes | — | List of tag IDs to be added to the Content Fragment | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "name": { "type": "string", "description": "The name of the variation for which the tags are retrieved." }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag IDs to be added to the Content Fragment" } }, "required": [ "PCID", "fragmentId", "name", "If-Match", "tags" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_restore\_version Restore a Content Fragment Version **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `versionId` | string | Yes | — | Content Fragment Version unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "versionId": { "type": "string", "description": "Content Fragment Version unique identifier" } }, "required": [ "PCID", "fragmentId", "versionId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_retrieve\_model\_uischema Get the UI schema associated with the Content Fragment Model of a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `X-Adobe-Accept-Unsupported-API` | integer | Yes | — | The `X-Adobe-Accept-Unsupported-API` request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code. | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "X-Adobe-Accept-Unsupported-API": { "type": "integer", "description": "The `X-Adobe-Accept-Unsupported-API` request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.", "enum": [ 1 ] }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" } }, "required": [ "PCID", "X-Adobe-Accept-Unsupported-API", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_scheduled\_publication\_status Get the scheduled publication status for a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Resource unique identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Resource unique identifier" } }, "required": [ "PCID", "fragmentId" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_scheduled\_publication\_status\_multiple\_fragments Get the scheduled publication status for a list of Content Fragment IDs **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ids` | string\[] | No | — | The list of Content Fragment IDs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The list of Content Fragment IDs." } }, "required": [ "PCID" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_search Search API for Content Fragments based on various Search Criteria. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `query` | string | Yes | — | The `query` parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded. | | `projection` | string | No | — | If this optional parameter is provided and its value is 'summary', the fragments in the response will contain only the required properties. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "query": { "type": "string", "description": "The `query` parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded." }, "projection": { "type": "string", "description": "If this optional parameter is provided and its value is 'summary', the fragments in the response will contain only the required properties.", "enum": [ "minimal", "summary", "full" ] } }, "required": [ "PCID", "query" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_translations Get the locales and language copies of a given list of resources **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `paths` | string\[] | Yes | — | The list of paths. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "paths": { "type": "array", "items": { "type": "string" }, "description": "The list of paths." } }, "required": [ "PCID", "paths" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_update\_checkout\_state Update checkout state of a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `checkedOut` | boolean | Yes | — | Indicates whether the fragment should be checked out (true) or checked in (false). - `true`: Checks out the fragment, creating an exclusive lock for the current user - `false`: Checks in the fragment, removing the exclusive lock | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "checkedOut": { "type": "boolean", "description": "Indicates whether the fragment should be checked out (true) or checked in (false). - `true`: Checks out the fragment, creating an exclusive lock for the current user - `false`: Checks in the fragment, removing the exclusive lock" } }, "required": [ "PCID", "fragmentId", "If-Match", "checkedOut" ] } ``` *** ## adobe\_experience\_manager\_sites\_fragments\_update\_fragment Edit a Content Fragment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fragmentId` | string | Yes | — | Content Fragment unique identifier | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `references` | string | No | — | An optional parameter that defines how references should be handled when patching the Content Fragment. | | `body` | object\[] | Yes | — | JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents. For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fragmentId": { "type": "string", "description": "Content Fragment unique identifier" }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "references": { "type": "string", "description": "An optional parameter that defines how references should be handled when patching the Content Fragment.", "enum": [ "none", "direct", "direct-hydrated" ] }, "body": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "copy", "move", "remove", "replace", "test" ], "description": "The operation to perform" }, "path": { "type": "string", "description": "A JSON Pointer (RFC 6901) referencing the target location" }, "value": { "description": "The value to add/replace/test (required for add, replace, test operations)" }, "from": { "type": "string", "description": "A JSON Pointer referencing the source location (required for copy and move operations)" } }, "required": [ "op", "path" ] }, "description": "JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents. For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902)." } }, "required": [ "PCID", "fragmentId", "If-Match", "body" ] } ``` *** ## adobe\_experience\_manager\_sites\_graph\_ql\_get GraphQL GET request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `query` | string | Yes | — | GraphQL query string | | `variables` | string | No | — | Variables simplify GraphQL queries by letting you pass data separately. Can be declared after the query are passed like arguments to a function and begin with `$`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "GraphQL query string" }, "variables": { "type": "string", "description": "Variables simplify GraphQL queries by letting you pass data separately. Can be declared after the query are passed like arguments to a function and begin with `$`." } }, "required": [ "PCID", "query" ] } ``` *** ## adobe\_experience\_manager\_sites\_graph\_ql\_post GraphQL POST request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `query` | string | Yes | — | Search query string | | `variables` | object | No | — | Variables simplify GraphQL queries by letting you pass data separately. Can be declared after the query and are passed like arguments to a function and begin with `$`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "Search query string" }, "variables": { "type": "object", "description": "Variables simplify GraphQL queries by letting you pass data separately. Can be declared after the query and are passed like arguments to a function and begin with `$`." } }, "required": [ "PCID", "query" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_add\_tags\_to\_content\_fragment\_model Add Tags to a Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The ID of the Content Fragment Model. | | `tags` | string\[] | Yes | — | List of tag IDs to be added to the Content Fragment | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the Content Fragment Model." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag IDs to be added to the Content Fragment" } }, "required": [ "PCID", "id", "tags" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_copy Copy a Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The unique identifier of the Content Fragment Model to be copied. | | `name` | string | No | — | This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the destination folder, the server will automatically generate an alternative resource name based on the provided value. | | `parentPath` | string | Yes | — | The configuration folder to which the Content Fragment Model should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The unique identifier of the Content Fragment Model to be copied." }, "name": { "type": "string", "description": "This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the destination folder, the server will automatically generate an alternative resource name based on the provided value." }, "parentPath": { "type": "string", "description": "The configuration folder to which the Content Fragment Model should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error." } }, "required": [ "PCID", "id", "parentPath" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_create\_model Create a Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dryRun` | boolean | No | — | If set to true, this operation allows validating the payload for creating one or more Content Fragment Models before performing the actual creation request. It performs the same validations as the creation process but does not create the models. | | `configurationFolder` | string | No | — | The configuration folder where the models should be created. If both `configurationFolder` and `models.configurationFolder` are provided, the latter will take precedence. | | `locked` | boolean | No | — | If the models are locked, then no edits can be performed on them, except for unlocking them. If both `locked` and `models.locked` are provided, the latter will take precedence. | | `models` | object\[] | No | — | The models value | | `status` | string | No | — | The status of this model. A model is in `draft` as soon as it's created, unless the user specifically marks the model as `enabled`. A model is in `disabled` state only when a user explicitly disables the model. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dryRun": { "type": "boolean", "description": "If set to true, this operation allows validating the payload for creating one or more Content Fragment Models before performing the actual creation request. It performs the same validations as the creation process but does not create the models." }, "configurationFolder": { "type": "string", "description": "The configuration folder where the models should be created. If both `configurationFolder` and `models.configurationFolder` are provided, the latter will take precedence." }, "locked": { "type": "boolean", "description": "If the models are locked, then no edits can be performed on them, except for unlocking them. If both `locked` and `models.locked` are provided, the latter will take precedence." }, "models": { "type": "array", "items": { "type": "object", "properties": { "configurationFolder": { "type": "string", "description": "The configuration folder where the model should be created." }, "name": { "type": "string", "description": "A human-readable name for this model." }, "technicalName": { "type": "string", "description": "Optional technical name used for storing the Content Fragment Model. If omitted, it will be generated from the 'name' property following JCR naming conventions (e.g., using hyphens). This name must adhere to JCR node naming rules. It cannot contain the characters: / : [ ] * | \\t \\r \\n. If a model with the same node name already exists in the target folder, an error will be returned due to the conflict." }, "description": { "type": "string", "description": "A human-readable description for this model." }, "locked": { "type": "boolean", "description": "If a model is locked, then no edits can be performed on this model, except for unlocking it." }, "status": { "type": "string", "enum": [ "enabled", "disabled", "draft" ], "description": "The status of this model. A model is in `draft` as soon as it's created, unless the user specifically marks the model as `enabled`. A model is in `disabled` state only when a user explicitly disables the model." }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of this field." }, "label": { "type": "string", "description": "A label to be used when rendering this field in an editable form. " }, "description": { "type": "string", "description": "A human-readable description for this field. " }, "required": { "type": "boolean", "description": "Defines whether this field is required or optional." }, "multiple": { "type": "boolean", "description": "Defines if this field should store multiple values." }, "minItems": { "type": "integer", "description": "A positive integer number that defines the minimum number of values that can be stored into this field" }, "maxItems": { "type": "integer", "description": "A positive integer number that defines the maximum number of values that can be stored into this field" }, "type": { "type": "string", "description": "Type of data stored in the field." }, "extensionConfig": { "type": "object", "description": "If this field is related to an extension, this object contains the configuration of the field for use by the extension. The values in this object are defined by the extension and can be used to configure the field's behavior or appearance. The values can be primitive types (string, boolean, number) or arrays of primitive types. More information about Content Fragments extensions can be found at AEM Content Fragments extensibility. " } } }, "description": "The fields value" }, "previewUrlPattern": { "type": "string", "format": "url", "description": "Preview URL Pattern for the given Model" } }, "required": [ "name" ] }, "description": "The models value" }, "status": { "type": "string", "description": "The status of this model. A model is in `draft` as soon as it's created, unless the user specifically marks the model as `enabled`. A model is in `disabled` state only when a user explicitly disables the model.", "enum": [ "enabled", "disabled", "draft" ] } }, "required": [ "PCID" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_create\_or\_update\_uischema Update the existing UI schema associated with a Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `X-Adobe-Accept-Unsupported-API` | integer | Yes | — | The `X-Adobe-Accept-Unsupported-API` request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code. | | `id` | string | Yes | — | The ID of the Content Fragment Model. | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `constraints` | object\[] | No | — | The constraints value | | `uiSchema` | object | No | — | Common base interface for any UI schema element. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "X-Adobe-Accept-Unsupported-API": { "type": "integer", "description": "The `X-Adobe-Accept-Unsupported-API` request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.", "enum": [ 1 ] }, "id": { "type": "string", "description": "The ID of the Content Fragment Model." }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "constraints": { "type": "array", "items": { "type": "object", "properties": { "if": { "type": "object", "description": "The operation used to evaluate the rule which doesn't have to be mapped to a specific property and can be applied to multiple properties at once" }, "then": { "type": "object", "description": "The operation used to evaluate the rule which doesn't have to be mapped to a specific property and can be applied to multiple properties at once" }, "else": { "type": "object", "description": "The operation used to evaluate the rule which doesn't have to be mapped to a specific property and can be applied to multiple properties at once" } }, "required": [ "if", "then" ] }, "description": "The constraints value" }, "uiSchema": { "type": "object", "description": "Common base interface for any UI schema element.", "properties": { "type": { "type": "string", "description": "Type of UI Schema element", "enum": [ "Control", "HorizontalLayout", "VerticalLayout", "Group", "Category", "Categorization" ] }, "options": { "type": "object", "description": "Additional options for a UI Schema element. The options which are not defined in this schema must have a name that starts with 'x-'." }, "rule": { "type": "object", "description": "Rules allow for dynamic aspects for a form, e.g. by hiding or disabling UI schema elements." } }, "required": [ "type" ] } }, "required": [ "PCID", "X-Adobe-Accept-Unsupported-API", "id", "If-Match" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_delete\_model Delete a Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | | `id` | string | Yes | — | The ID of the Content Fragment Model to retrieve. | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." }, "id": { "type": "string", "description": "The ID of the Content Fragment Model to retrieve." }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." } }, "required": [ "PCID", "id", "If-Match" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_delete\_tags\_from\_content\_fragment\_model Delete the Tags applied to a Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The ID of the Content Fragment Model. | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the Content Fragment Model." }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." } }, "required": [ "PCID", "id", "If-Match" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_get\_model Get a Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | | `id` | string | Yes | — | The ID of the Content Fragment Model to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." }, "id": { "type": "string", "description": "The ID of the Content Fragment Model to retrieve." } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_get\_models List all Content Fragment Models **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `projection` | string | No | — | This parameter is optional. If set to 'minimal', the response will include include only the resource identifiers of the Content Fragment Model: id, path, and name. If set to 'summary', the Content Fragment Model's fields will not be populated in the response. If set to 'full', the response will include all properties. By default, the value of this query parameter is 'full'. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "projection": { "type": "string", "description": "This parameter is optional. If set to 'minimal', the response will include include only the resource identifiers of the Content Fragment Model: id, path, and name. If set to 'summary', the Content Fragment Model's fields will not be populated in the response. If set to 'full', the response will include all properties. By default, the value of this query parameter is 'full'.", "enum": [ "minimal", "summary", "full" ] } }, "required": [ "PCID" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_get\_tags\_from\_content\_fragment\_model Get the Tags applied to a Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The ID of the Content Fragment Model. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the Content Fragment Model." } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_publish Publish Content Fragment Models **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agentId` | string | No | — | The agent id used for publishing the content fragment models. | | `filterAllowedModelIdsByStatus` | object\[] | Yes | — | The status of the referenced models. A model is in `draft` as soon as it's created, unless the user specifically marks the model as `enabled`. A model is in `disabled` state only when a user explicitly disables the model. | | `ids` | string\[] | Yes | — | The list of content fragment model ids. | | `scheduledTime` | integer | No | — | The scheduled time as an epoch timestamp. | | `workflowModelId` | string | No | — | The workflow model id used for initiating the workflow instance to handle the publication. AEM provides the designated model `/etc/workflow/models/scheduled_model_activation_with_references` for publishing contents including references. | | `workflowTitle` | string | No | — | A freely defined non-empty string used to identify the workflow when it executes. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agentId": { "type": "string", "description": "The agent id used for publishing the content fragment models." }, "filterAllowedModelIdsByStatus": { "type": "array", "items": { "enum": [ "ENABLED", "DISABLED", "DRAFT" ] }, "description": "The status of the referenced models. A model is in `draft` as soon as it's created, unless the user specifically marks the model as `enabled`. A model is in `disabled` state only when a user explicitly disables the model." }, "ids": { "type": "array", "items": { "type": "string" }, "description": "The list of content fragment model ids." }, "scheduledTime": { "type": "integer", "description": "The scheduled time as an epoch timestamp." }, "workflowModelId": { "type": "string", "description": "The workflow model id used for initiating the workflow instance to handle the publication. AEM provides the designated model `/etc/workflow/models/scheduled_model_activation_with_references` for publishing contents including references." }, "workflowTitle": { "type": "string", "description": "A freely defined non-empty string used to identify the workflow when it executes." } }, "required": [ "PCID", "filterAllowedModelIdsByStatus", "ids" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_replace\_tags\_from\_content\_fragment\_model Replace the Tags applied to a Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The ID of the Content Fragment Model. | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `tags` | string\[] | Yes | — | List of tag IDs to be added to the Content Fragment | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the Content Fragment Model." }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag IDs to be added to the Content Fragment" } }, "required": [ "PCID", "id", "If-Match", "tags" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_retrieve\_uischema Get the UI schema associated with the Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `X-Adobe-Accept-Unsupported-API` | integer | Yes | — | The `X-Adobe-Accept-Unsupported-API` request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code. | | `id` | string | Yes | — | The ID of the Content Fragment Model. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "X-Adobe-Accept-Unsupported-API": { "type": "integer", "description": "The `X-Adobe-Accept-Unsupported-API` request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.", "enum": [ 1 ] }, "id": { "type": "string", "description": "The ID of the Content Fragment Model." } }, "required": [ "PCID", "X-Adobe-Accept-Unsupported-API", "id" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_scheduled\_publication\_status\_multiple\_models Get the scheduled publication status for a list of Content Fragment Models **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ids` | string\[] | Yes | — | The list of Content Fragment Model IDs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ids": { "type": "array", "items": { "type": "string" }, "description": "The list of Content Fragment Model IDs." } }, "required": [ "PCID", "ids" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_search Search API for Content Fragment Models based on various Search Criteria. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `query` | string | Yes | — | The `query` parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded. | | `projection` | string | No | — | This parameter is optional. If set to 'minimal', the response will include include only the resource identifiers of the Content Fragment Model: id, path, and name. If set to 'summary', the Content Fragment Model's fields will not be populated in the response. If set to 'full', the response will include all properties. By default, the value of this query parameter is 'full'. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "query": { "type": "string", "description": "The `query` parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded." }, "projection": { "type": "string", "description": "This parameter is optional. If set to 'minimal', the response will include include only the resource identifiers of the Content Fragment Model: id, path, and name. If set to 'summary', the Content Fragment Model's fields will not be populated in the response. If set to 'full', the response will include all properties. By default, the value of this query parameter is 'full'.", "enum": [ "minimal", "summary", "full" ] } }, "required": [ "PCID", "query" ] } ``` *** ## adobe\_experience\_manager\_sites\_models\_update\_model Edit a Content Fragment Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `If-None-Match` | string | No | — | The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is "\*", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). | | `id` | string | Yes | — | The ID of the Content Fragment Model to retrieve. | | `If-Match` | string | Yes | — | The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "\*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). | | `body` | object\[] | Yes | — | JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents. For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "If-None-Match": { "type": "string", "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)." }, "id": { "type": "string", "description": "The ID of the Content Fragment Model to retrieve." }, "If-Match": { "type": "string", "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)." }, "body": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "copy", "move", "remove", "replace", "test" ], "description": "The operation to perform" }, "path": { "type": "string", "description": "A JSON Pointer (RFC 6901) referencing the target location" }, "value": { "description": "The value to add/replace/test (required for add, replace, test operations)" }, "from": { "type": "string", "description": "A JSON Pointer referencing the source location (required for copy and move operations)" } }, "required": [ "op", "path" ] }, "description": "JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents. For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902)." } }, "required": [ "PCID", "id", "If-Match", "body" ] } ``` *** ## adobe\_experience\_manager\_sites\_permissions Get the current's user permissions on a list of resources **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `paths` | string\[] | Yes | — | The list of resource paths - Content Fragments, Content Fragment Models and Folder - for which the system has to return the list of permissions for a user. The Content Fragments are expected to be within the `/content/dam` directory, the Content Fragment Models within the `/conf` directory, and the Folders could be within either `/content/dam` or the `/conf` directory. | | `preferredPermissions` | string\[] | No | — | The preferred list of permissions to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "paths": { "type": "array", "items": { "type": "string" }, "description": "The list of resource paths - Content Fragments, Content Fragment Models and Folder - for which the system has to return the list of permissions for a user. The Content Fragments are expected to be within the `/content/dam` directory, the Content Fragment Models within the `/conf` directory, and the Folders could be within either `/content/dam` or the `/conf` directory." }, "preferredPermissions": { "type": "array", "items": { "type": "string", "enum": [ "READ", "EDIT", "RENAME", "DELETE", "PUBLISH", "CREATE_CONTENT_FRAGMENT", "CREATE_CONTENT_FRAGMENT_MODEL", "CHECKIN", "CHECKOUT" ] }, "description": "The preferred list of permissions to return." } }, "required": [ "PCID", "paths" ] } ``` *** ## adobe\_experience\_manager\_sites\_workflows\_get\_workflow Get a Workflow **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workflowInstanceId` | string | Yes | — | The workflow instance identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workflowInstanceId": { "type": "string", "description": "The workflow instance identifier." } }, "required": [ "PCID", "workflowInstanceId" ] } ``` *** ## adobe\_experience\_manager\_sites\_workflows\_get\_workflows List Workflows **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cursor` | string | No | — | When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items. | | `limit` | integer | No | — | For a paginated request, this parameter defines the maximum number of items to retrieve. | | `query` | string | No | — | The `query` parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items." }, "limit": { "type": "integer", "description": "For a paginated request, this parameter defines the maximum number of items to retrieve." }, "query": { "type": "string", "description": "The `query` parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded." } }, "required": [ "PCID" ] } ``` *** ## adobe\_experience\_manager\_sites\_workflows\_start Start a workflow **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `type` | string | Yes | — | Type of workflow | | `workflowModelId` | string | No | — | The workflow model id used for initiating the workflow instance | | `workflowTitle` | string | No | — | A freely defined string used to identify the workflow when it executes. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "type": { "type": "string", "description": "Type of workflow", "enum": [ "publish-folder", "unpublish-fragments", "unpublish-models", "create-translation-structure", "move-fragments", "rename-fragments" ] }, "workflowModelId": { "type": "string", "description": "The workflow model id used for initiating the workflow instance" }, "workflowTitle": { "type": "string", "description": "A freely defined string used to identify the workflow when it executes." } }, "required": [ "PCID", "type" ] } ``` # adobe-sign Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/adobe-sign eSignature **Server path:** `/adobe-sign` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`adobe-sign_download_signed_document`](#adobe-sign_download_signed_document) | Download the signed document from an Adobe Sign agreement | | [`adobe-sign_get_agreement`](#adobe-sign_get_agreement) | Get the status and details of an Adobe Sign agreement | | [`adobe-sign_list_agreements`](#adobe-sign_list_agreements) | List Adobe Sign agreements | *** ## adobe-sign\_download\_signed\_document Download the signed document from an Adobe Sign agreement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | Agreement ID to download document from | | `attachAuditReport` | boolean | No | `false` | Whether to include audit trail in download | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "agreementId": { "type": "string", "description": "Agreement ID to download document from" }, "attachAuditReport": { "type": "boolean", "default": false, "description": "Whether to include audit trail in download" } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign\_get\_agreement Get the status and details of an Adobe Sign agreement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | Agreement ID to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "agreementId": { "type": "string", "description": "Agreement ID to retrieve" } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign\_list\_agreements List Adobe Sign agreements **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cursor` | string | No | — | Cursor for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "cursor": { "type": "string", "description": "Cursor for pagination" } }, "required": [ "PCID" ] } ``` # adobe-sign-api Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/adobe-sign-api Adobe Sign API **Server path:** `/adobe-sign-api` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`adobe-sign-api_add_template_fields_to_agreement`](#adobe-sign-api_add_template_fields_to_agreement) | Adds template fields to an agreement | | [`adobe-sign-api_create_agreement`](#adobe-sign-api_create_agreement) | Creates an agreement. Sends it out for signatures, and returns the agreementID in the response to the client. | | [`adobe-sign-api_create_agreement_view`](#adobe-sign-api_create_agreement_view) | Retrieves the latest state view url of agreement. | | [`adobe-sign-api_create_delegated_participant_sets`](#adobe-sign-api_create_delegated_participant_sets) | Creates a participantSet to which the agreement is forwarded for taking appropriate action. | | [`adobe-sign-api_create_library_document`](#adobe-sign-api_create_library_document) | Creates a template that is placed in the library of the user for reuse. | | [`adobe-sign-api_create_library_document_view`](#adobe-sign-api_create_library_document_view) | Retrieves the latest state view url of a library document. | | [`adobe-sign-api_create_reminder_on_participant`](#adobe-sign-api_create_reminder_on_participant) | Creates a reminder on the specified participants of an agreement identified by agreementId in the path. | | [`adobe-sign-api_create_share_on_agreement`](#adobe-sign-api_create_share_on_agreement) | Share an agreement with someone. | | [`adobe-sign-api_create_webhook`](#adobe-sign-api_create_webhook) | Creates a webhook. | | [`adobe-sign-api_delete_documents`](#adobe-sign-api_delete_documents) | Deletes all the documents of an agreement. | | [`adobe-sign-api_delete_webhook`](#adobe-sign-api_delete_webhook) | Deletes a webhook. | | [`adobe-sign-api_get_agreement_info`](#adobe-sign-api_get_agreement_info) | Retrieves the current status of an agreement. | | [`adobe-sign-api_get_agreement_note_for_api_user`](#adobe-sign-api_get_agreement_note_for_api_user) | Retrieves the latest note associated with an agreement. | | [`adobe-sign-api_get_agreement_reminders`](#adobe-sign-api_get_agreement_reminders) | Retrieves the reminders of an agreement, identified by agreementId in the path. | | [`adobe-sign-api_get_agreements`](#adobe-sign-api_get_agreements) | Retrieves agreements for the user. | | [`adobe-sign-api_get_all_documents`](#adobe-sign-api_get_all_documents) | Retrieves the IDs of the documents of an agreement identified by agreementId. | | [`adobe-sign-api_get_all_documents_image_urls`](#adobe-sign-api_get_all_documents_image_urls) | Retrieves image urls of all visible pages of all the documents associated with an agreement. | | [`adobe-sign-api_get_all_members`](#adobe-sign-api_get_all_members) | Retrieves information of members of the agreement. | | [`adobe-sign-api_get_audit_trail`](#adobe-sign-api_get_audit_trail) | Retrieves the audit trail of an agreement identified by agreementId. | | [`adobe-sign-api_get_combined_document_pages_info`](#adobe-sign-api_get_combined_document_pages_info) | Retrieves info of all pages of a combined PDF document for the documents associated with an agreement. | | [`adobe-sign-api_get_document`](#adobe-sign-api_get_document) | Retrieves the file stream of a document of an agreement. | | [`adobe-sign-api_get_document_image_urls`](#adobe-sign-api_get_document_image_urls) | Retrieves image urls of all visible pages of a document associated with an agreement. | | [`adobe-sign-api_get_documents`](#adobe-sign-api_get_documents) | Retrieves the IDs of the documents associated with library document. | | [`adobe-sign-api_get_events`](#adobe-sign-api_get_events) | Retrieves the events information for an agreement. | | [`adobe-sign-api_get_events_2`](#adobe-sign-api_get_events_2) | Retrieves the events information for a library document. | | [`adobe-sign-api_get_form_data`](#adobe-sign-api_get_form_data) | Retrieves data entered into the interactive form fields of the agreement. | | [`adobe-sign-api_get_form_fields`](#adobe-sign-api_get_form_fields) | Retrieves details of form fields of an agreement. | | [`adobe-sign-api_get_group_details`](#adobe-sign-api_get_group_details) | Retrieves detailed information about the group. | | [`adobe-sign-api_get_groups`](#adobe-sign-api_get_groups) | Retrieves all the groups in an account. | | [`adobe-sign-api_get_groups_of_user`](#adobe-sign-api_get_groups_of_user) | Retrieves the groups of the user. | | [`adobe-sign-api_get_library_document`](#adobe-sign-api_get_library_document) | Retrieves the file stream of a document of library document. | | [`adobe-sign-api_get_library_document_audit_trail`](#adobe-sign-api_get_library_document_audit_trail) | Retrieves the audit trail associated with a library document. | | [`adobe-sign-api_get_library_document_image_urls`](#adobe-sign-api_get_library_document_image_urls) | Retrieves image urls of all visible pages of a document associated with a library document. | | [`adobe-sign-api_get_library_document_info`](#adobe-sign-api_get_library_document_info) | Retrieves the details of a library document. | | [`adobe-sign-api_get_library_document_note_for_api_user`](#adobe-sign-api_get_library_document_note_for_api_user) | Retrieves the latest note of a library document for the API user. | | [`adobe-sign-api_get_library_documents`](#adobe-sign-api_get_library_documents) | Retrieves library documents for a user. | | [`adobe-sign-api_get_merge_info`](#adobe-sign-api_get_merge_info) | Retrieves the merge info stored with an agreement. | | [`adobe-sign-api_get_participant_set`](#adobe-sign-api_get_participant_set) | Retrieves the participant set of an agreement identified by agreementId in the path. | | [`adobe-sign-api_get_signing_url`](#adobe-sign-api_get_signing_url) | Retrieves the URL for the e-sign page for the current signer(s) of an agreement. | | [`adobe-sign-api_get_user_detail`](#adobe-sign-api_get_user_detail) | Retrieves detailed information about the user in the caller account. | | [`adobe-sign-api_get_user_views`](#adobe-sign-api_get_user_views) | Retrieves the URL of manage, account settings and user profile page. | | [`adobe-sign-api_get_users`](#adobe-sign-api_get_users) | Retrieves all the users in an account. | | [`adobe-sign-api_get_users_in_group`](#adobe-sign-api_get_users_in_group) | Retrieves all the users in a group. | | [`adobe-sign-api_get_webhook_info`](#adobe-sign-api_get_webhook_info) | Retrieves the details of a webhook. | | [`adobe-sign-api_get_webhooks`](#adobe-sign-api_get_webhooks) | Retrieves webhooks for a user. | | [`adobe-sign-api_modify_user`](#adobe-sign-api_modify_user) | Update an user. | | [`adobe-sign-api_modify_user_state`](#adobe-sign-api_modify_user_state) | Activate/Deactivate a given user. | | [`adobe-sign-api_reject_agreement_for_participation`](#adobe-sign-api_reject_agreement_for_participation) | Rejects the agreement for a participant. | | [`adobe-sign-api_update_agreement`](#adobe-sign-api_update_agreement) | Updates the agreement in draft state. | | [`adobe-sign-api_update_agreement_merge_info`](#adobe-sign-api_update_agreement_merge_info) | Set the merge info for an agreement. | | [`adobe-sign-api_update_agreement_state`](#adobe-sign-api_update_agreement_state) | Updates the state of an agreement identified by agreementId in the path. | | [`adobe-sign-api_update_agreement_visibility`](#adobe-sign-api_update_agreement_visibility) | Updates the visibility of an agreement. | | [`adobe-sign-api_update_form_fields`](#adobe-sign-api_update_form_fields) | Updates form fields of an agreement. | | [`adobe-sign-api_update_groups_of_user`](#adobe-sign-api_update_groups_of_user) | Updates the groups of the user. | | [`adobe-sign-api_update_library_document`](#adobe-sign-api_update_library_document) | Updates the library document. | | [`adobe-sign-api_update_library_document_state`](#adobe-sign-api_update_library_document_state) | Updates the library document's state. | | [`adobe-sign-api_update_library_document_visibility`](#adobe-sign-api_update_library_document_visibility) | Updates the visibility of library document. | | [`adobe-sign-api_update_participant_set`](#adobe-sign-api_update_participant_set) | Updates the participant set of an agreement identified by agreementId in the path. | | [`adobe-sign-api_update_webhook`](#adobe-sign-api_update_webhook) | Updates a webhook. | | [`adobe-sign-api_update_webhook_state`](#adobe-sign-api_update_webhook_state) | Updates the state of a webhook identified by webhookId in the path. | *** ## adobe-sign-api\_add\_template\_fields\_to\_agreement Adds template fields to an agreement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "body" ] } ``` *** ## adobe-sign-api\_create\_agreement Creates an agreement. Sends it out for signatures, and returns the agreementID in the response to the client. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## adobe-sign-api\_create\_agreement\_view Retrieves the latest state view url of agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "body" ] } ``` *** ## adobe-sign-api\_create\_delegated\_participant\_sets Creates a participantSet to which the agreement is forwarded for taking appropriate action. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `participantSetId` | string | Yes | — | The participant set identifier | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "participantSetId": { "type": "string", "description": "The participant set identifier" }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "participantSetId", "body" ] } ``` *** ## adobe-sign-api\_create\_library\_document Creates a template that is placed in the library of the user for reuse. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## adobe-sign-api\_create\_library\_document\_view Retrieves the latest state view url of a library document. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "libraryDocumentId", "body" ] } ``` *** ## adobe-sign-api\_create\_reminder\_on\_participant Creates a reminder on the specified participants of an agreement identified by agreementId in the path. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "body" ] } ``` *** ## adobe-sign-api\_create\_share\_on\_agreement Share an agreement with someone. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "body" ] } ``` *** ## adobe-sign-api\_create\_webhook Creates a webhook. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## adobe-sign-api\_delete\_documents Deletes all the documents of an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_delete\_webhook Deletes a webhook. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `webhookId` | string | Yes | — | The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks." } }, "required": [ "PCID", "webhookId" ] } ``` *** ## adobe-sign-api\_get\_agreement\_info Retrieves the current status of an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_agreement\_note\_for\_api\_user Retrieves the latest note associated with an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_agreement\_reminders Retrieves the reminders of an agreement, identified by agreementId in the path. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `status` | string | No | — | A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "status": { "type": "string", "description": "A comma-separated list of reminder statuses of the reminders which should be returned in the response. Currently supported values are ACTIVE, CANCELED, COMPLETE" } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_agreements Retrieves agreements for the user. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `externalId` | string | No | — | Case-sensitive ExternalID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API | | `showHiddenAgreements` | boolean | No | — | A query parameter to fetch all the hidden agreements along with the visible agreements. | | `cursor` | string | No | — | Used to navigate through the pages. If not provided, returns the first page. | | `pageSize` | integer | No | — | Number of intended items in the response page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "externalId": { "type": "string", "description": "Case-sensitive ExternalID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API" }, "showHiddenAgreements": { "type": "boolean", "description": "A query parameter to fetch all the hidden agreements along with the visible agreements." }, "cursor": { "type": "string", "description": "Used to navigate through the pages. If not provided, returns the first page." }, "pageSize": { "type": "integer", "description": "Number of intended items in the response page." } }, "required": [ "PCID" ] } ``` *** ## adobe-sign-api\_get\_all\_documents Retrieves the IDs of the documents of an agreement identified by agreementId. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `versionId` | string | No | — | The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. | | `participantId` | string | No | — | The participant identifier to be used to retrieve documents. | | `supportingDocumentContentFormat` | string | No | — | Content format of the supported documents. It can have two possible values ORIGINAL or CONVERTED\_PDF. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "versionId": { "type": "string", "description": "The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used." }, "participantId": { "type": "string", "description": "The participant identifier to be used to retrieve documents." }, "supportingDocumentContentFormat": { "type": "string", "description": "Content format of the supported documents. It can have two possible values ORIGINAL or CONVERTED_PDF." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_all\_documents\_image\_urls Retrieves image urls of all visible pages of all the documents associated with an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `versionId` | string | No | — | The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used. | | `participantId` | string | No | — | The participant identifier to be used to retrieve documents. | | `imageSizes` | string | No | — | A comma separated list of image sizes i.e. \{FIXED\_WIDTH\_50px, FIXED\_WIDTH\_250px, FIXED\_WIDTH\_675px, ZOOM\_50\_PERCENT, ZOOM\_75\_PERCENT, ZOOM\_100\_PERCENT, ZOOM\_125\_PERCENT, ZOOM\_150\_PERCENT, ZOOM\_200\_PERCENT}. Default sizes returned are \{FIXED\_WIDTH\_50px, FIXED\_WIDTH\_250px, FIXED\_WIDTH\_675px, ZOOM\_100\_PERCENT}. | | `includeSupportingDocumentsImageUrls` | boolean | No | — | When set to true, returns image urls of supporting documents as well. Else, returns image urls of only the original documents. | | `showImageAvailabilityOnly` | boolean | No | — | When set to true, returns only image availability. Else, returns both image urls and its availability. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "versionId": { "type": "string", "description": "The version identifier of agreement as provided by the API which retrieves information of a specific agreement. If not provided then latest version will be used." }, "participantId": { "type": "string", "description": "The participant identifier to be used to retrieve documents." }, "imageSizes": { "type": "string", "description": "A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}." }, "includeSupportingDocumentsImageUrls": { "type": "boolean", "description": "When set to true, returns image urls of supporting documents as well. Else, returns image urls of only the original documents." }, "showImageAvailabilityOnly": { "type": "boolean", "description": "When set to true, returns only image availability. Else, returns both image urls and its availability." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_all\_members Retrieves information of members of the agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `includeNextParticipantSet` | boolean | No | — | A query parameter to fetch next active participation members | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "includeNextParticipantSet": { "type": "boolean", "description": "A query parameter to fetch next active participation members" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_audit\_trail Retrieves the audit trail of an agreement identified by agreementId. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_combined\_document\_pages\_info Retrieves info of all pages of a combined PDF document for the documents associated with an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `includeSupportingDocumentsPagesInfo` | boolean | No | — | When set to true, returns info of all pages of supporting documents as well. Else, return the info of pages of only the original document. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "includeSupportingDocumentsPagesInfo": { "type": "boolean", "description": "When set to true, returns info of all pages of supporting documents as well. Else, return the info of pages of only the original document." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_document Retrieves the file stream of a document of an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `documentId` | string | Yes | — | The document identifier, as retrieved from the API which fetches the documents of a specified agreement | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "documentId": { "type": "string", "description": "The document identifier, as retrieved from the API which fetches the documents of a specified agreement" } }, "required": [ "PCID", "agreementId", "documentId" ] } ``` *** ## adobe-sign-api\_get\_document\_image\_urls Retrieves image urls of all visible pages of a document associated with an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `documentId` | string | Yes | — | The document identifier, as retrieved from the API which fetches the documents of a specified agreement | | `imageSizes` | string | No | — | A comma separated list of image sizes i.e. \{FIXED\_WIDTH\_50px, FIXED\_WIDTH\_250px, FIXED\_WIDTH\_675px, ZOOM\_50\_PERCENT, ZOOM\_75\_PERCENT, ZOOM\_100\_PERCENT, ZOOM\_125\_PERCENT, ZOOM\_150\_PERCENT, ZOOM\_200\_PERCENT}. Default sizes returned are \{FIXED\_WIDTH\_50px, FIXED\_WIDTH\_250px, FIXED\_WIDTH\_675px, ZOOM\_100\_PERCENT}. | | `showImageAvailabilityOnly` | boolean | No | — | When set to true, returns only image availability. Else, returns both image urls and its availability. | | `startPage` | integer | No | — | Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. | | `endPage` | integer | No | — | End of page number range for which imageUrls are requested. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "documentId": { "type": "string", "description": "The document identifier, as retrieved from the API which fetches the documents of a specified agreement" }, "imageSizes": { "type": "string", "description": "A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}." }, "showImageAvailabilityOnly": { "type": "boolean", "description": "When set to true, returns only image availability. Else, returns both image urls and its availability." }, "startPage": { "type": "integer", "description": "Start of page number range for which imageUrls are requested. Starting page number should be greater than 0." }, "endPage": { "type": "integer", "description": "End of page number range for which imageUrls are requested." } }, "required": [ "PCID", "agreementId", "documentId" ] } ``` *** ## adobe-sign-api\_get\_documents Retrieves the IDs of the documents associated with library document. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | | `versionId` | string | No | — | The version identifier of library\_document as provided by the API which retrieves information of a specific library document. If not provided then latest version will be used. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." }, "versionId": { "type": "string", "description": "The version identifier of library_document as provided by the API which retrieves information of a specific library document. If not provided then latest version will be used." } }, "required": [ "PCID", "libraryDocumentId" ] } ``` *** ## adobe-sign-api\_get\_events Retrieves the events information for an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_events\_2 Retrieves the events information for a library document. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." } }, "required": [ "PCID", "libraryDocumentId" ] } ``` *** ## adobe-sign-api\_get\_form\_data Retrieves data entered into the interactive form fields of the agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_form\_fields Retrieves details of form fields of an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `participantEmail` | string | No | — | The email address of the participant to be used to retrieve its associated form fields. | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "participantEmail": { "type": "string", "description": "The email address of the participant to be used to retrieve its associated form fields." }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_group\_details Retrieves detailed information about the group. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `groupId` | string | Yes | — | The group identifier, as returned by the group creation API or retrieved from the API to fetch groups | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group identifier, as returned by the group creation API or retrieved from the API to fetch groups" } }, "required": [ "PCID", "groupId" ] } ``` *** ## adobe-sign-api\_get\_groups Retrieves all the groups in an account. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cursor` | string | No | — | Used to navigate through the pages. If not provided, returns the first page. | | `pageSize` | integer | No | — | Number of intended items in the response page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Used to navigate through the pages. If not provided, returns the first page." }, "pageSize": { "type": "integer", "description": "Number of intended items in the response page." } }, "required": [ "PCID" ] } ``` *** ## adobe-sign-api\_get\_groups\_of\_user Retrieves the groups of the user. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user identifier, as returned by the user creation API or retrieved from the API to fetch users. To get the details for the token owner, UserId can be replaced by "me" without quotes. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user identifier, as returned by the user creation API or retrieved from the API to fetch users. To get the details for the token owner, UserId can be replaced by \"me\" without quotes." } }, "required": [ "PCID", "userId" ] } ``` *** ## adobe-sign-api\_get\_library\_document Retrieves the file stream of a document of library document. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | | `documentId` | string | Yes | — | The document identifier, as retrieved from the API which fetches the documents of a specified library document | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." }, "documentId": { "type": "string", "description": "The document identifier, as retrieved from the API which fetches the documents of a specified library document" } }, "required": [ "PCID", "libraryDocumentId", "documentId" ] } ``` *** ## adobe-sign-api\_get\_library\_document\_audit\_trail Retrieves the audit trail associated with a library document. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." } }, "required": [ "PCID", "libraryDocumentId" ] } ``` *** ## adobe-sign-api\_get\_library\_document\_image\_urls Retrieves image urls of all visible pages of a document associated with a library document. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | | `documentId` | string | Yes | — | The document identifier, as retrieved from the API which fetches the documents of a specified library document | | `imageSizes` | string | No | — | A comma separated list of image sizes i.e. \{FIXED\_WIDTH\_50px, FIXED\_WIDTH\_250px, FIXED\_WIDTH\_675px, ZOOM\_50\_PERCENT, ZOOM\_75\_PERCENT, ZOOM\_100\_PERCENT, ZOOM\_125\_PERCENT, ZOOM\_150\_PERCENT, ZOOM\_200\_PERCENT}. Default sizes returned are \{FIXED\_WIDTH\_50px, FIXED\_WIDTH\_250px, FIXED\_WIDTH\_675px, ZOOM\_100\_PERCENT}. | | `startPage` | integer | No | — | Start of page number range for which imageUrls are requested. Starting page number should be greater than 0. | | `endPage` | integer | No | — | End of page number range for which imageUrls are requested. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." }, "documentId": { "type": "string", "description": "The document identifier, as retrieved from the API which fetches the documents of a specified library document" }, "imageSizes": { "type": "string", "description": "A comma separated list of image sizes i.e. {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_50_PERCENT, ZOOM_75_PERCENT, ZOOM_100_PERCENT, ZOOM_125_PERCENT, ZOOM_150_PERCENT, ZOOM_200_PERCENT}. Default sizes returned are {FIXED_WIDTH_50px, FIXED_WIDTH_250px, FIXED_WIDTH_675px, ZOOM_100_PERCENT}." }, "startPage": { "type": "integer", "description": "Start of page number range for which imageUrls are requested. Starting page number should be greater than 0." }, "endPage": { "type": "integer", "description": "End of page number range for which imageUrls are requested." } }, "required": [ "PCID", "libraryDocumentId", "documentId" ] } ``` *** ## adobe-sign-api\_get\_library\_document\_info Retrieves the details of a library document. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." } }, "required": [ "PCID", "libraryDocumentId" ] } ``` *** ## adobe-sign-api\_get\_library\_document\_note\_for\_api\_user Retrieves the latest note of a library document for the API user. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." } }, "required": [ "PCID", "libraryDocumentId" ] } ``` *** ## adobe-sign-api\_get\_library\_documents Retrieves library documents for a user. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `showHiddenLibraryDocuments` | boolean | No | — | A query parameter to fetch all the hidden library documents along with the visible library documents. | | `cursor` | string | No | — | Used to navigate through the pages. If not provided, returns the first page. | | `pageSize` | integer | No | — | Number of intended items in the response page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "showHiddenLibraryDocuments": { "type": "boolean", "description": "A query parameter to fetch all the hidden library documents along with the visible library documents." }, "cursor": { "type": "string", "description": "Used to navigate through the pages. If not provided, returns the first page." }, "pageSize": { "type": "integer", "description": "Number of intended items in the response page." } }, "required": [ "PCID" ] } ``` *** ## adobe-sign-api\_get\_merge\_info Retrieves the merge info stored with an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_participant\_set Retrieves the participant set of an agreement identified by agreementId in the path. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `participantSetId` | string | Yes | — | The participant set identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "participantSetId": { "type": "string", "description": "The participant set identifier" } }, "required": [ "PCID", "agreementId", "participantSetId" ] } ``` *** ## adobe-sign-api\_get\_signing\_url Retrieves the URL for the e-sign page for the current signer(s) of an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." } }, "required": [ "PCID", "agreementId" ] } ``` *** ## adobe-sign-api\_get\_user\_detail Retrieves detailed information about the user in the caller account. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user identifier, as returned by the user creation API or retrieved from the API to fetch users. To get the details for the token owner, UserId can be replaced by "me" without quotes. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user identifier, as returned by the user creation API or retrieved from the API to fetch users. To get the details for the token owner, UserId can be replaced by \"me\" without quotes." } }, "required": [ "PCID", "userId" ] } ``` *** ## adobe-sign-api\_get\_user\_views Retrieves the URL of manage, account settings and user profile page. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user identifier, as returned by the user creation API or retrieved from the API to fetch users. To get the details for the token owner, UserId can be replaced by "me" without quotes. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user identifier, as returned by the user creation API or retrieved from the API to fetch users. To get the details for the token owner, UserId can be replaced by \"me\" without quotes." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "userId", "body" ] } ``` *** ## adobe-sign-api\_get\_users Retrieves all the users in an account. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cursor` | string | No | — | Used to navigate through the pages. If not provided, returns the first page. | | `pageSize` | integer | No | — | Number of intended items in the response page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Used to navigate through the pages. If not provided, returns the first page." }, "pageSize": { "type": "integer", "description": "Number of intended items in the response page." } }, "required": [ "PCID" ] } ``` *** ## adobe-sign-api\_get\_users\_in\_group Retrieves all the users in a group. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cursor` | string | No | — | Used to navigate through the pages. If not provided, returns the first page. | | `pageSize` | integer | No | — | Number of intended items in the response page. | | `groupId` | string | Yes | — | The group identifier, as returned by the group creation API or retrieved from the API to fetch groups | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Used to navigate through the pages. If not provided, returns the first page." }, "pageSize": { "type": "integer", "description": "Number of intended items in the response page." }, "groupId": { "type": "string", "description": "The group identifier, as returned by the group creation API or retrieved from the API to fetch groups" } }, "required": [ "PCID", "groupId" ] } ``` *** ## adobe-sign-api\_get\_webhook\_info Retrieves the details of a webhook. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `webhookId` | string | Yes | — | The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks." } }, "required": [ "PCID", "webhookId" ] } ``` *** ## adobe-sign-api\_get\_webhooks Retrieves webhooks for a user. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `showInActiveWebhooks` | boolean | No | — | A query parameter to fetch all the inactive webhooks along with the active webhooks. | | `scope` | string | No | — | Scope of webhook. The possible values are ACCOUNT, GROUP, USER or RESOURCE | | `resourceType` | string | No | — | The type of resource on which webhook was created. The possible values are AGREEMENT, WIDGET and MEGASIGN. | | `cursor` | string | No | — | Used to navigate through the pages. If not provided, returns the first page. | | `pageSize` | integer | No | — | Number of intended items in the response page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "showInActiveWebhooks": { "type": "boolean", "description": "A query parameter to fetch all the inactive webhooks along with the active webhooks." }, "scope": { "type": "string", "description": "Scope of webhook. The possible values are ACCOUNT, GROUP, USER or RESOURCE" }, "resourceType": { "type": "string", "description": "The type of resource on which webhook was created. The possible values are AGREEMENT, WIDGET and MEGASIGN." }, "cursor": { "type": "string", "description": "Used to navigate through the pages. If not provided, returns the first page." }, "pageSize": { "type": "integer", "description": "Number of intended items in the response page." } }, "required": [ "PCID" ] } ``` *** ## adobe-sign-api\_modify\_user Update an user. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user identifier, as provided by GET /users or POST /users | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user identifier, as provided by GET /users or POST /users" }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "userId", "body" ] } ``` *** ## adobe-sign-api\_modify\_user\_state Activate/Deactivate a given user. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user identifier, as returned by the user creation API or retrieved from the API to fetch users. To update the details for the token owner, UserId can be replaced by "me" without quotes. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user identifier, as returned by the user creation API or retrieved from the API to fetch users. To update the details for the token owner, UserId can be replaced by \"me\" without quotes." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "userId", "body" ] } ``` *** ## adobe-sign-api\_reject\_agreement\_for\_participation Rejects the agreement for a participant. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `participantSetId` | string | Yes | — | The participant set identifier | | `participantId` | string | Yes | — | The participant identifier | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "participantSetId": { "type": "string", "description": "The participant set identifier" }, "participantId": { "type": "string", "description": "The participant identifier" }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "participantSetId", "participantId", "body" ] } ``` *** ## adobe-sign-api\_update\_agreement Updates the agreement in draft state. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "body" ] } ``` *** ## adobe-sign-api\_update\_agreement\_merge\_info Set the merge info for an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "body" ] } ``` *** ## adobe-sign-api\_update\_agreement\_state Updates the state of an agreement identified by agreementId in the path. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "body" ] } ``` *** ## adobe-sign-api\_update\_agreement\_visibility Updates the visibility of an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "body" ] } ``` *** ## adobe-sign-api\_update\_form\_fields Updates form fields of an agreement. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "body" ] } ``` *** ## adobe-sign-api\_update\_groups\_of\_user Updates the groups of the user. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user identifier, as returned by the user creation API or retrieved from the API to fetch users. To update the details for the token owner, UserId can be replaced by "me" without quotes. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user identifier, as returned by the user creation API or retrieved from the API to fetch users. To update the details for the token owner, UserId can be replaced by \"me\" without quotes." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "userId", "body" ] } ``` *** ## adobe-sign-api\_update\_library\_document Updates the library document. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "libraryDocumentId", "body" ] } ``` *** ## adobe-sign-api\_update\_library\_document\_state Updates the library document's state. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "libraryDocumentId", "body" ] } ``` *** ## adobe-sign-api\_update\_library\_document\_visibility Updates the visibility of library document. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `libraryDocumentId` | string | Yes | — | The document identifier, as retrieved from the API to fetch library documents. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "libraryDocumentId": { "type": "string", "description": "The document identifier, as retrieved from the API to fetch library documents." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "libraryDocumentId", "body" ] } ``` *** ## adobe-sign-api\_update\_participant\_set Updates the participant set of an agreement identified by agreementId in the path. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `agreementId` | string | Yes | — | The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. | | `participantSetId` | string | Yes | — | The participant set identifier | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agreementId": { "type": "string", "description": "The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements." }, "participantSetId": { "type": "string", "description": "The participant set identifier" }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "agreementId", "participantSetId", "body" ] } ``` *** ## adobe-sign-api\_update\_webhook Updates a webhook. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `webhookId` | string | Yes | — | The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "webhookId", "body" ] } ``` *** ## adobe-sign-api\_update\_webhook\_state Updates the state of a webhook identified by webhookId in the path. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `webhookId` | string | Yes | — | The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "The webhook identifier, as returned by the webhook creation API or retrieved from the API to fetch webhooks." }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "webhookId", "body" ] } ``` # adobe-workfront Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/adobe-workfront Adobe Workfront - manage projects, tasks, issues, documents, users, portfolios, teams, and time tracking **Server path:** `/adobe-workfront` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`adobe_workfront_create_issue`](#adobe_workfront_create_issue) | Create a new issue in a project | | [`adobe_workfront_create_project`](#adobe_workfront_create_project) | Create a new project | | [`adobe_workfront_create_task`](#adobe_workfront_create_task) | Create a new task in a project | | [`adobe_workfront_delete_issue`](#adobe_workfront_delete_issue) | Delete an issue by ID | | [`adobe_workfront_delete_project`](#adobe_workfront_delete_project) | Delete a project by ID | | [`adobe_workfront_delete_task`](#adobe_workfront_delete_task) | Delete a task by ID | | [`adobe_workfront_get_current_user`](#adobe_workfront_get_current_user) | Get the currently authenticated user | | [`adobe_workfront_get_document`](#adobe_workfront_get_document) | Get a document by ID | | [`adobe_workfront_get_issue`](#adobe_workfront_get_issue) | Get an issue by ID | | [`adobe_workfront_get_portfolio`](#adobe_workfront_get_portfolio) | Get a portfolio by ID | | [`adobe_workfront_get_project`](#adobe_workfront_get_project) | Get a project by ID | | [`adobe_workfront_get_task`](#adobe_workfront_get_task) | Get a task by ID | | [`adobe_workfront_get_team`](#adobe_workfront_get_team) | Get a team by ID | | [`adobe_workfront_get_user`](#adobe_workfront_get_user) | Get a user by ID | | [`adobe_workfront_log_hours`](#adobe_workfront_log_hours) | Log hours against a task or project | | [`adobe_workfront_search_documents`](#adobe_workfront_search_documents) | Search for documents matching filter criteria | | [`adobe_workfront_search_hours`](#adobe_workfront_search_hours) | Search for hour entries matching filter criteria | | [`adobe_workfront_search_issues`](#adobe_workfront_search_issues) | Search for issues matching filter criteria | | [`adobe_workfront_search_portfolios`](#adobe_workfront_search_portfolios) | Search for portfolios matching filter criteria | | [`adobe_workfront_search_projects`](#adobe_workfront_search_projects) | Search for projects matching filter criteria | | [`adobe_workfront_search_tasks`](#adobe_workfront_search_tasks) | Search for tasks matching filter criteria | | [`adobe_workfront_search_teams`](#adobe_workfront_search_teams) | Search for teams matching filter criteria | | [`adobe_workfront_search_users`](#adobe_workfront_search_users) | Search for users matching filter criteria | | [`adobe_workfront_update_issue`](#adobe_workfront_update_issue) | Update an existing issue | | [`adobe_workfront_update_project`](#adobe_workfront_update_project) | Update an existing project | | [`adobe_workfront_update_task`](#adobe_workfront_update_task) | Update an existing task | *** ## adobe\_workfront\_create\_issue Create a new issue in a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Issue name | | `projectID` | string | Yes | — | ID of the project to create the issue in | | `status` | string | No | — | Status code (NEW=New, INP=In Progress, default NEW) | | `description` | string | No | — | Issue description | | `assignedToID` | string | No | — | User ID to assign the issue to | | `priority` | integer | No | — | Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent) | | `opTaskType` | string | No | — | Issue type (BUG=Bug Report, CHG=Change Order, ISU=Issue, REQ=Request) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Issue name" }, "projectID": { "type": "string", "description": "ID of the project to create the issue in" }, "status": { "type": "string", "description": "Status code (NEW=New, INP=In Progress, default NEW)" }, "description": { "type": "string", "description": "Issue description" }, "assignedToID": { "type": "string", "description": "User ID to assign the issue to" }, "priority": { "type": "integer", "description": "Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent)" }, "opTaskType": { "type": "string", "description": "Issue type (BUG=Bug Report, CHG=Change Order, ISU=Issue, REQ=Request)" } }, "required": [ "PCID", "name", "projectID" ] } ``` *** ## adobe\_workfront\_create\_project Create a new project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Project name | | `status` | string | No | — | Status code (CUR=Current, PLN=Planning, default PLN) | | `description` | string | No | — | Project description | | `plannedStartDate` | string | No | — | Planned start date (ISO 8601 format) | | `plannedCompletionDate` | string | No | — | Planned completion date (ISO 8601 format) | | `priority` | integer | No | — | Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent) | | `ownerID` | string | No | — | User ID to assign as project owner | | `portfolioID` | string | No | — | Portfolio ID to assign the project to | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Project name" }, "status": { "type": "string", "description": "Status code (CUR=Current, PLN=Planning, default PLN)" }, "description": { "type": "string", "description": "Project description" }, "plannedStartDate": { "type": "string", "description": "Planned start date (ISO 8601 format)" }, "plannedCompletionDate": { "type": "string", "description": "Planned completion date (ISO 8601 format)" }, "priority": { "type": "integer", "description": "Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent)" }, "ownerID": { "type": "string", "description": "User ID to assign as project owner" }, "portfolioID": { "type": "string", "description": "Portfolio ID to assign the project to" } }, "required": [ "PCID", "name" ] } ``` *** ## adobe\_workfront\_create\_task Create a new task in a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Task name | | `projectID` | string | Yes | — | ID of the project to create the task in | | `status` | string | No | — | Status code (NEW=New, INP=In Progress, default NEW) | | `description` | string | No | — | Task description | | `assignedToID` | string | No | — | User ID to assign the task to | | `plannedStartDate` | string | No | — | Planned start date (ISO 8601 format) | | `plannedCompletionDate` | string | No | — | Planned completion date (ISO 8601 format) | | `priority` | integer | No | — | Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent) | | `parentID` | string | No | — | Parent task ID (for creating subtasks) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Task name" }, "projectID": { "type": "string", "description": "ID of the project to create the task in" }, "status": { "type": "string", "description": "Status code (NEW=New, INP=In Progress, default NEW)" }, "description": { "type": "string", "description": "Task description" }, "assignedToID": { "type": "string", "description": "User ID to assign the task to" }, "plannedStartDate": { "type": "string", "description": "Planned start date (ISO 8601 format)" }, "plannedCompletionDate": { "type": "string", "description": "Planned completion date (ISO 8601 format)" }, "priority": { "type": "integer", "description": "Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent)" }, "parentID": { "type": "string", "description": "Parent task ID (for creating subtasks)" } }, "required": [ "PCID", "name", "projectID" ] } ``` *** ## adobe\_workfront\_delete\_issue Delete an issue by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The issue ID to delete | | `force` | boolean | No | — | Set to true to force delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The issue ID to delete" }, "force": { "type": "boolean", "description": "Set to true to force delete" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_delete\_project Delete a project by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The project ID to delete | | `force` | boolean | No | — | Set to true to force delete even if the project has tasks or issues | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The project ID to delete" }, "force": { "type": "boolean", "description": "Set to true to force delete even if the project has tasks or issues" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_delete\_task Delete a task by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The task ID to delete | | `force` | boolean | No | — | Set to true to force delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The task ID to delete" }, "force": { "type": "boolean", "description": "Set to true to force delete" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_get\_current\_user Get the currently authenticated user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,emailAddr,title,isActive,role:name,homeTeam:name) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,emailAddr,title,isActive,role:name,homeTeam:name)" } }, "required": [ "PCID" ] } ``` *** ## adobe\_workfront\_get\_document Get a document by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The document ID | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,description,docObjCode,objID,currentVersion:fileName,currentVersion:fileSize,owner:name) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The document ID" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,description,docObjCode,objID,currentVersion:fileName,currentVersion:fileSize,owner:name)" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_get\_issue Get an issue by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The issue ID | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,status,projectID,assignedTo:name,opTaskType,priority,description,resolveTask:name) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The issue ID" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,status,projectID,assignedTo:name,opTaskType,priority,description,resolveTask:name)" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_get\_portfolio Get a portfolio by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The portfolio ID | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,description,isActive,owner:name,budget) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The portfolio ID" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,description,isActive,owner:name,budget)" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_get\_project Get a project by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The project ID | | `fields` | string | No | — | Comma-separated list of fields to include (e.g., name,status,plannedStartDate,plannedCompletionDate,owner:name,percentComplete,budget) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The project ID" }, "fields": { "type": "string", "description": "Comma-separated list of fields to include (e.g., name,status,plannedStartDate,plannedCompletionDate,owner:name,percentComplete,budget)" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_get\_task Get a task by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The task ID | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,status,projectID,assignedTo:name,plannedStartDate,plannedCompletionDate,percentComplete) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The task ID" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,status,projectID,assignedTo:name,plannedStartDate,plannedCompletionDate,percentComplete)" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_get\_team Get a team by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The team ID | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,description,teamMembers:name) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The team ID" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,description,teamMembers:name)" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_get\_user Get a user by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The user ID | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,emailAddr,title,isActive,role:name,homeTeam:name,phoneNumber) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The user ID" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,emailAddr,title,isActive,role:name,homeTeam:name,phoneNumber)" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_log\_hours Log hours against a task or project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `hours` | number | Yes | — | Number of hours to log | | `entryDate` | string | Yes | — | Date for the hour entry (ISO 8601 format) | | `taskID` | string | No | — | Task ID to log hours against (provide taskID or projectID) | | `projectID` | string | No | — | Project ID to log hours against (provide taskID or projectID) | | `hourTypeID` | string | No | — | Hour type ID (e.g., for billable, non-billable categories) | | `description` | string | No | — | Description of the work performed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "hours": { "type": "number", "description": "Number of hours to log" }, "entryDate": { "type": "string", "description": "Date for the hour entry (ISO 8601 format)" }, "taskID": { "type": "string", "description": "Task ID to log hours against (provide taskID or projectID)" }, "projectID": { "type": "string", "description": "Project ID to log hours against (provide taskID or projectID)" }, "hourTypeID": { "type": "string", "description": "Hour type ID (e.g., for billable, non-billable categories)" }, "description": { "type": "string", "description": "Description of the work performed" } }, "required": [ "PCID", "hours", "entryDate" ] } ``` *** ## adobe\_workfront\_search\_documents Search for documents matching filter criteria **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | No | — | Filter by document name | | `name_Mod` | string | No | — | Modifier for name filter: contains, cicontains, eq, ne | | `projectID` | string | No | — | Filter by project ID | | `taskID` | string | No | — | Filter by task ID | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,description,docObjCode,objID,currentVersion:fileName,owner:name) | | `$$LIMIT` | integer | No | — | Maximum number of results (default 100, max 2000) | | `$$FIRST` | integer | No | — | Number of results to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Filter by document name" }, "name_Mod": { "type": "string", "description": "Modifier for name filter: contains, cicontains, eq, ne" }, "projectID": { "type": "string", "description": "Filter by project ID" }, "taskID": { "type": "string", "description": "Filter by task ID" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,description,docObjCode,objID,currentVersion:fileName,owner:name)" }, "$$LIMIT": { "type": "integer", "description": "Maximum number of results (default 100, max 2000)" }, "$$FIRST": { "type": "integer", "description": "Number of results to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## adobe\_workfront\_search\_hours Search for hour entries matching filter criteria **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectID` | string | No | — | Filter by project ID | | `taskID` | string | No | — | Filter by task ID | | `ownerID` | string | No | — | Filter by the user who logged the hours | | `entryDate` | string | No | — | Filter by entry date (ISO 8601 format) | | `entryDate_Mod` | string | No | — | Modifier for entryDate filter: between, gte, lte, eq | | `entryDate_Range` | string | No | — | Date range for between modifier (e.g., 2024-01-01T00:00:00,2024-12-31T23:59:59) | | `fields` | string | No | — | Comma-separated fields to include (e.g., hours,entryDate,owner:name,project:name,task:name,hourType:name) | | `$$LIMIT` | integer | No | — | Maximum number of results (default 100, max 2000) | | `$$FIRST` | integer | No | — | Number of results to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectID": { "type": "string", "description": "Filter by project ID" }, "taskID": { "type": "string", "description": "Filter by task ID" }, "ownerID": { "type": "string", "description": "Filter by the user who logged the hours" }, "entryDate": { "type": "string", "description": "Filter by entry date (ISO 8601 format)" }, "entryDate_Mod": { "type": "string", "description": "Modifier for entryDate filter: between, gte, lte, eq" }, "entryDate_Range": { "type": "string", "description": "Date range for between modifier (e.g., 2024-01-01T00:00:00,2024-12-31T23:59:59)" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., hours,entryDate,owner:name,project:name,task:name,hourType:name)" }, "$$LIMIT": { "type": "integer", "description": "Maximum number of results (default 100, max 2000)" }, "$$FIRST": { "type": "integer", "description": "Number of results to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## adobe\_workfront\_search\_issues Search for issues matching filter criteria **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | No | — | Filter by issue name | | `name_Mod` | string | No | — | Modifier for name filter: contains, cicontains, eq, ne | | `projectID` | string | No | — | Filter by project ID | | `status` | string | No | — | Filter by issue status (NEW=New, INP=In Progress, CPL=Complete, CLS=Closed) | | `assignedToID` | string | No | — | Filter by assigned user ID | | `opTaskType` | string | No | — | Filter by issue type (BUG=Bug Report, CHG=Change Order, ISU=Issue, REQ=Request) | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,status,projectID,assignedTo:name,opTaskType,priority,description) | | `$$LIMIT` | integer | No | — | Maximum number of results (default 100, max 2000) | | `$$FIRST` | integer | No | — | Number of results to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Filter by issue name" }, "name_Mod": { "type": "string", "description": "Modifier for name filter: contains, cicontains, eq, ne" }, "projectID": { "type": "string", "description": "Filter by project ID" }, "status": { "type": "string", "description": "Filter by issue status (NEW=New, INP=In Progress, CPL=Complete, CLS=Closed)" }, "assignedToID": { "type": "string", "description": "Filter by assigned user ID" }, "opTaskType": { "type": "string", "description": "Filter by issue type (BUG=Bug Report, CHG=Change Order, ISU=Issue, REQ=Request)" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,status,projectID,assignedTo:name,opTaskType,priority,description)" }, "$$LIMIT": { "type": "integer", "description": "Maximum number of results (default 100, max 2000)" }, "$$FIRST": { "type": "integer", "description": "Number of results to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## adobe\_workfront\_search\_portfolios Search for portfolios matching filter criteria **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | No | — | Filter by portfolio name | | `name_Mod` | string | No | — | Modifier for name filter: contains, cicontains, eq, ne | | `isActive` | boolean | No | — | Filter by active status | | `ownerID` | string | No | — | Filter by portfolio owner user ID | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,description,isActive,owner:name,budget) | | `$$LIMIT` | integer | No | — | Maximum number of results (default 100, max 2000) | | `$$FIRST` | integer | No | — | Number of results to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Filter by portfolio name" }, "name_Mod": { "type": "string", "description": "Modifier for name filter: contains, cicontains, eq, ne" }, "isActive": { "type": "boolean", "description": "Filter by active status" }, "ownerID": { "type": "string", "description": "Filter by portfolio owner user ID" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,description,isActive,owner:name,budget)" }, "$$LIMIT": { "type": "integer", "description": "Maximum number of results (default 100, max 2000)" }, "$$FIRST": { "type": "integer", "description": "Number of results to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## adobe\_workfront\_search\_projects Search for projects matching filter criteria **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | No | — | Filter by project name (exact match or use name\_Mod=contains for partial) | | `name_Mod` | string | No | — | Modifier for name filter: contains, cicontains, between, eq, ne, gte, lte | | `status` | string | No | — | Filter by project status code (CUR=Current, PLN=Planning, CPL=Complete, DED=Dead, ONH=On Hold) | | `ownerID` | string | No | — | Filter by project owner user ID | | `portfolioID` | string | No | — | Filter by portfolio ID | | `fields` | string | No | — | Comma-separated list of fields to include in response (e.g., name,status,plannedStartDate,plannedCompletionDate,owner:name,percentComplete) | | `$$LIMIT` | integer | No | — | Maximum number of results to return (default 100, max 2000) | | `$$FIRST` | integer | No | — | Number of results to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Filter by project name (exact match or use name_Mod=contains for partial)" }, "name_Mod": { "type": "string", "description": "Modifier for name filter: contains, cicontains, between, eq, ne, gte, lte" }, "status": { "type": "string", "description": "Filter by project status code (CUR=Current, PLN=Planning, CPL=Complete, DED=Dead, ONH=On Hold)" }, "ownerID": { "type": "string", "description": "Filter by project owner user ID" }, "portfolioID": { "type": "string", "description": "Filter by portfolio ID" }, "fields": { "type": "string", "description": "Comma-separated list of fields to include in response (e.g., name,status,plannedStartDate,plannedCompletionDate,owner:name,percentComplete)" }, "$$LIMIT": { "type": "integer", "description": "Maximum number of results to return (default 100, max 2000)" }, "$$FIRST": { "type": "integer", "description": "Number of results to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## adobe\_workfront\_search\_tasks Search for tasks matching filter criteria **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | No | — | Filter by task name | | `name_Mod` | string | No | — | Modifier for name filter: contains, cicontains, eq, ne | | `projectID` | string | No | — | Filter by project ID | | `status` | string | No | — | Filter by task status (NEW=New, INP=In Progress, CPL=Complete, DED=Dead) | | `assignedToID` | string | No | — | Filter by assigned user ID | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,status,projectID,assignedTo:name,plannedStartDate,plannedCompletionDate,percentComplete,priority) | | `$$LIMIT` | integer | No | — | Maximum number of results (default 100, max 2000) | | `$$FIRST` | integer | No | — | Number of results to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Filter by task name" }, "name_Mod": { "type": "string", "description": "Modifier for name filter: contains, cicontains, eq, ne" }, "projectID": { "type": "string", "description": "Filter by project ID" }, "status": { "type": "string", "description": "Filter by task status (NEW=New, INP=In Progress, CPL=Complete, DED=Dead)" }, "assignedToID": { "type": "string", "description": "Filter by assigned user ID" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,status,projectID,assignedTo:name,plannedStartDate,plannedCompletionDate,percentComplete,priority)" }, "$$LIMIT": { "type": "integer", "description": "Maximum number of results (default 100, max 2000)" }, "$$FIRST": { "type": "integer", "description": "Number of results to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## adobe\_workfront\_search\_teams Search for teams matching filter criteria **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | No | — | Filter by team name | | `name_Mod` | string | No | — | Modifier for name filter: contains, cicontains, eq, ne | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,description,teamMembers:name) | | `$$LIMIT` | integer | No | — | Maximum number of results (default 100, max 2000) | | `$$FIRST` | integer | No | — | Number of results to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Filter by team name" }, "name_Mod": { "type": "string", "description": "Modifier for name filter: contains, cicontains, eq, ne" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,description,teamMembers:name)" }, "$$LIMIT": { "type": "integer", "description": "Maximum number of results (default 100, max 2000)" }, "$$FIRST": { "type": "integer", "description": "Number of results to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## adobe\_workfront\_search\_users Search for users matching filter criteria **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | No | — | Filter by user display name | | `name_Mod` | string | No | — | Modifier for name filter: contains, cicontains, eq, ne | | `emailAddr` | string | No | — | Filter by email address | | `isActive` | boolean | No | — | Filter by active status (true/false) | | `roleID` | string | No | — | Filter by job role ID | | `fields` | string | No | — | Comma-separated fields to include (e.g., name,emailAddr,title,isActive,role:name,homeTeam:name) | | `$$LIMIT` | integer | No | — | Maximum number of results (default 100, max 2000) | | `$$FIRST` | integer | No | — | Number of results to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Filter by user display name" }, "name_Mod": { "type": "string", "description": "Modifier for name filter: contains, cicontains, eq, ne" }, "emailAddr": { "type": "string", "description": "Filter by email address" }, "isActive": { "type": "boolean", "description": "Filter by active status (true/false)" }, "roleID": { "type": "string", "description": "Filter by job role ID" }, "fields": { "type": "string", "description": "Comma-separated fields to include (e.g., name,emailAddr,title,isActive,role:name,homeTeam:name)" }, "$$LIMIT": { "type": "integer", "description": "Maximum number of results (default 100, max 2000)" }, "$$FIRST": { "type": "integer", "description": "Number of results to skip for pagination" } }, "required": [ "PCID" ] } ``` *** ## adobe\_workfront\_update\_issue Update an existing issue **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The issue ID to update | | `name` | string | No | — | New issue name | | `status` | string | No | — | New status code (NEW=New, INP=In Progress, CPL=Complete, CLS=Closed) | | `description` | string | No | — | New issue description | | `assignedToID` | string | No | — | User ID to assign the issue to | | `priority` | integer | No | — | Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The issue ID to update" }, "name": { "type": "string", "description": "New issue name" }, "status": { "type": "string", "description": "New status code (NEW=New, INP=In Progress, CPL=Complete, CLS=Closed)" }, "description": { "type": "string", "description": "New issue description" }, "assignedToID": { "type": "string", "description": "User ID to assign the issue to" }, "priority": { "type": "integer", "description": "Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent)" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_update\_project Update an existing project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The project ID to update | | `name` | string | No | — | New project name | | `status` | string | No | — | New status code (CUR=Current, PLN=Planning, CPL=Complete, DED=Dead, ONH=On Hold) | | `description` | string | No | — | New project description | | `plannedStartDate` | string | No | — | Planned start date (ISO 8601 format) | | `plannedCompletionDate` | string | No | — | Planned completion date (ISO 8601 format) | | `priority` | integer | No | — | Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent) | | `ownerID` | string | No | — | User ID to assign as project owner | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The project ID to update" }, "name": { "type": "string", "description": "New project name" }, "status": { "type": "string", "description": "New status code (CUR=Current, PLN=Planning, CPL=Complete, DED=Dead, ONH=On Hold)" }, "description": { "type": "string", "description": "New project description" }, "plannedStartDate": { "type": "string", "description": "Planned start date (ISO 8601 format)" }, "plannedCompletionDate": { "type": "string", "description": "Planned completion date (ISO 8601 format)" }, "priority": { "type": "integer", "description": "Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent)" }, "ownerID": { "type": "string", "description": "User ID to assign as project owner" } }, "required": [ "PCID", "id" ] } ``` *** ## adobe\_workfront\_update\_task Update an existing task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The task ID to update | | `name` | string | No | — | New task name | | `status` | string | No | — | New status code (NEW=New, INP=In Progress, CPL=Complete, DED=Dead) | | `description` | string | No | — | New task description | | `assignedToID` | string | No | — | User ID to assign the task to | | `plannedStartDate` | string | No | — | Planned start date (ISO 8601 format) | | `plannedCompletionDate` | string | No | — | Planned completion date (ISO 8601 format) | | `priority` | integer | No | — | Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent) | | `percentComplete` | number | No | — | Percent complete (0-100) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The task ID to update" }, "name": { "type": "string", "description": "New task name" }, "status": { "type": "string", "description": "New status code (NEW=New, INP=In Progress, CPL=Complete, DED=Dead)" }, "description": { "type": "string", "description": "New task description" }, "assignedToID": { "type": "string", "description": "User ID to assign the task to" }, "plannedStartDate": { "type": "string", "description": "Planned start date (ISO 8601 format)" }, "plannedCompletionDate": { "type": "string", "description": "Planned completion date (ISO 8601 format)" }, "priority": { "type": "integer", "description": "Priority level (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent)" }, "percentComplete": { "type": "number", "description": "Percent complete (0-100)" } }, "required": [ "PCID", "id" ] } ``` # affinda Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/affinda Affinda API **PinkConnect service:** `affinda` | **Type:** Application (parent with child servers) | **PCID required:** Yes affinda is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [affinda-documents](/api-reference/mcp-servers/application/affinda/affinda-documents) | `/affinda-documents` | 28 | Affinda Documents - upload, extract, annotate, and validate documents | | [affinda-search](/api-reference/mcp-servers/application/affinda/affinda-search) | `/affinda-search` | 23 | Affinda Search - resume and job description search and matching | | [affinda-workspace](/api-reference/mcp-servers/application/affinda/affinda-workspace) | `/affinda-workspace` | 44 | Affinda Workspace - organizations, workspaces, data sources, tags, and webhooks | # affinda-documents Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/affinda/affinda-documents Affinda Documents - upload, extract, annotate, and validate documents **Server path:** `/affinda-documents` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`affinda_documents_batch_create_annotations`](#affinda_documents_batch_create_annotations) | Batch create annotations | | [`affinda_documents_batch_create_validation_results`](#affinda_documents_batch_create_validation_results) | Batch create validation results | | [`affinda_documents_batch_delete_annotations`](#affinda_documents_batch_delete_annotations) | Batch delete annotations | | [`affinda_documents_batch_delete_validation_results`](#affinda_documents_batch_delete_validation_results) | Batch delete validation results | | [`affinda_documents_batch_update_annotations`](#affinda_documents_batch_update_annotations) | Batch update annotations | | [`affinda_documents_create_annotation`](#affinda_documents_create_annotation) | Create a annotation | | [`affinda_documents_create_document`](#affinda_documents_create_document) | Upload a document for parsing | | [`affinda_documents_create_document_type`](#affinda_documents_create_document_type) | Create a document type | | [`affinda_documents_create_validation_result`](#affinda_documents_create_validation_result) | Create a validation result | | [`affinda_documents_delete_annotation`](#affinda_documents_delete_annotation) | Delete an annotation | | [`affinda_documents_delete_document`](#affinda_documents_delete_document) | Delete a document | | [`affinda_documents_delete_document_type`](#affinda_documents_delete_document_type) | Delete a document type | | [`affinda_documents_delete_validation_result`](#affinda_documents_delete_validation_result) | Delete a validation result | | [`affinda_documents_get_all_annotations`](#affinda_documents_get_all_annotations) | Get list of all annotations | | [`affinda_documents_get_all_documents`](#affinda_documents_get_all_documents) | Get list of all documents | | [`affinda_documents_get_all_validation_results`](#affinda_documents_get_all_validation_results) | Get list of all validation results | | [`affinda_documents_get_annotation`](#affinda_documents_get_annotation) | Get specific annotation | | [`affinda_documents_get_document`](#affinda_documents_get_document) | Get specific document | | [`affinda_documents_get_document_type`](#affinda_documents_get_document_type) | Get a document type | | [`affinda_documents_get_document_types`](#affinda_documents_get_document_types) | List document types | | [`affinda_documents_get_redacted_document`](#affinda_documents_get_redacted_document) | Get redacted document | | [`affinda_documents_get_validation_result`](#affinda_documents_get_validation_result) | Get specific validation result | | [`affinda_documents_json_schema_from_document_type`](#affinda_documents_json_schema_from_document_type) | Generate JSON schema from a document type | | [`affinda_documents_pydantic_models_from_document_type`](#affinda_documents_pydantic_models_from_document_type) | Generate Pydantic models from a document type | | [`affinda_documents_update_annotation`](#affinda_documents_update_annotation) | Update an annotation | | [`affinda_documents_update_document`](#affinda_documents_update_document) | Update a document | | [`affinda_documents_update_document_type`](#affinda_documents_update_document_type) | Update a document type | | [`affinda_documents_update_validation_result`](#affinda_documents_update_validation_result) | Update a validation result | *** ## affinda\_documents\_batch\_create\_annotations Batch create annotations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "rectangles": { "type": "array", "items": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "x0": { "type": "number" }, "y0": { "type": "number" }, "x1": { "type": "number" }, "y1": { "type": "number" } } }, "description": "x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles." }, "document": { "type": "string", "description": "Unique identifier for the document" }, "pageIndex": { "type": "integer", "description": "The page number within the document, starting from 0." }, "dataPoint": { "type": "string", "description": "Data point's identifier" }, "field": { "type": "string", "description": "Field's identifier" }, "raw": { "type": "string", "description": "Raw data extracted from the before any post-processing" }, "parsed": { "description": "The parsed value" }, "isClientVerified": { "type": "boolean", "description": "Indicates whether the data has been validated by a human" }, "parent": { "type": "integer", "description": "The parent annotation's ID" }, "validationResults": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "array", "description": "List of validation results created during this operation." }, "updated": { "type": "array", "description": "List of validation results updated during this operation." }, "deleted": { "type": "array", "description": "List of validation results deleted during this operation." } } }, "description": "The validation results created, changed or deleted as a result of creating the annotation." } }, "required": [ "document", "pageIndex" ] }, "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## affinda\_documents\_batch\_create\_validation\_results Batch create validation results **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "annotations": { "type": "array", "items": { "type": "integer" }, "description": "List of annotation ids that were validated" }, "passed": { "type": "boolean", "description": "Whether the validation passed or not, null if the validation was not applicable" }, "ruleSlug": { "type": "string", "description": "The kebab-case slug of the validation rule that was applied" }, "message": { "type": "string", "description": "Message explaining why the validation failed" }, "document": { "type": "string", "description": "Unique identifier for the document" } }, "required": [ "annotations", "ruleSlug", "message", "document" ] }, "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## affinda\_documents\_batch\_delete\_annotations Batch delete annotations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | integer\[] | Yes | — | Array of annotation IDs to be deleted | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "integer" }, "description": "Array of annotation IDs to be deleted" } }, "required": [ "PCID", "body" ] } ``` *** ## affinda\_documents\_batch\_delete\_validation\_results Batch delete validation results **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ids` | integer\[] | Yes | — | List of validation result IDs to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "List of validation result IDs to delete." } }, "required": [ "PCID", "ids" ] } ``` *** ## affinda\_documents\_batch\_update\_annotations Batch update annotations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Annotation's ID" }, "rectangles": { "type": "array", "items": { "type": "object", "properties": { "pageIndex": { "type": "integer" }, "x0": { "type": "number" }, "y0": { "type": "number" }, "x1": { "type": "number" }, "y1": { "type": "number" } } }, "description": "x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles." }, "document": { "type": "string", "description": "Unique identifier for the document" }, "pageIndex": { "type": "integer", "description": "The page number within the document, starting from 0." }, "raw": { "type": "string", "description": "Raw data extracted from the before any post-processing" }, "parsed": { "description": "The parsed value" }, "isClientVerified": { "type": "boolean", "description": "Indicates whether the data has been validated by a human" }, "dataPoint": { "type": "string", "description": "Data point's identifier" }, "parent": { "type": "integer", "description": "The parent annotation's ID" }, "validationResults": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "array", "description": "List of validation results created during this operation." }, "updated": { "type": "array", "description": "List of validation results updated during this operation." }, "deleted": { "type": "array", "description": "List of validation results deleted during this operation." } } }, "description": "The validation results created, changed or deleted as a result of updating the annotation." } }, "required": [ "id" ] }, "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## affinda\_documents\_create\_annotation Create a annotation **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `dataPoint` | string | No | — | Data point's identifier | | | `document` | string | Yes | — | Unique identifier for the document | | | `field` | string | null | No | — | Field's identifier | | `isClientVerified` | boolean | No | — | Indicates whether the data has been validated by a human | | | `pageIndex` | integer | null | Yes | — | The page number within the document, starting from 0. | | `parent` | integer | null | No | — | The parent annotation's ID | | `parsed` | object | No | — | The parsed value | | | `raw` | string | null | No | — | Raw data extracted from the before any post-processing | | `rectangles` | object\[] | No | — | x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles. | | | `validationResults` | object\[] | No | — | The validation results created, changed or deleted as a result of creating the annotation. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dataPoint": { "type": "string", "description": "Data point's identifier" }, "document": { "type": "string", "description": "Unique identifier for the document" }, "field": { "type": [ "string", "null" ], "description": "Field's identifier" }, "isClientVerified": { "type": "boolean", "description": "Indicates whether the data has been validated by a human" }, "pageIndex": { "type": [ "integer", "null" ], "description": "The page number within the document, starting from 0." }, "parent": { "type": [ "integer", "null" ], "description": "The parent annotation's ID" }, "parsed": { "description": "The parsed value" }, "raw": { "type": [ "string", "null" ], "description": "Raw data extracted from the before any post-processing" }, "rectangles": { "type": "array", "items": { "type": "object", "properties": { "pageIndex": { "type": "integer", "description": "Page Index" }, "x0": { "type": "number", "description": "The x0 value" }, "y0": { "type": "number", "description": "The y0 value" }, "x1": { "type": "number", "description": "The x1 value" }, "y1": { "type": "number", "description": "The y1 value" } }, "required": [ "x0", "y0", "x1", "y1" ] }, "description": "x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles." }, "validationResults": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Validation Result's ID" }, "annotations": { "type": "array", "description": "List of annotation ids that were validated" }, "passed": { "type": "boolean", "description": "Whether the validation passed or not, null if the validation was not applicable" }, "ruleSlug": { "type": "string", "description": "The kebab-case slug of the validation rule that was applied" }, "message": { "type": "string", "description": "Message explaining why the validation failed" }, "document": { "type": "string", "description": "Unique identifier for the document" } } }, "description": "List of validation results created during this operation." }, "updated": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Validation Result's ID" }, "annotations": { "type": "array", "description": "List of annotation ids that were validated" }, "passed": { "type": "boolean", "description": "Whether the validation passed or not, null if the validation was not applicable" }, "ruleSlug": { "type": "string", "description": "The kebab-case slug of the validation rule that was applied" }, "message": { "type": "string", "description": "Message explaining why the validation failed" }, "document": { "type": "string", "description": "Unique identifier for the document" } } }, "description": "List of validation results updated during this operation." }, "deleted": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Validation Result's ID" }, "annotations": { "type": "array", "description": "List of annotation ids that were validated" }, "passed": { "type": "boolean", "description": "Whether the validation passed or not, null if the validation was not applicable" }, "ruleSlug": { "type": "string", "description": "The kebab-case slug of the validation rule that was applied" }, "message": { "type": "string", "description": "Message explaining why the validation failed" }, "document": { "type": "string", "description": "Unique identifier for the document" } } }, "description": "List of validation results deleted during this operation." } } }, "description": "The validation results created, changed or deleted as a result of creating the annotation." } }, "required": [ "PCID", "document", "pageIndex" ] } ``` *** ## affinda\_documents\_create\_document Upload a document for parsing **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `snake_case` | boolean | No | — | Whether to return the response in snake\_case instead of camelCase. Default is false. | | | `collection` | string | No | — | Uniquely identify a collection. | | | `compact` | boolean | No | — | If true, the returned parse result (assuming `wait` is also true) will be a compact version of the full result. | | | `customIdentifier` | string | No | — | Specify a custom identifier for the document if you need one, not required to be unique. | | | `deleteAfterParse` | boolean | No | — | If true, no data will be stored after parsing. Only compatible with requests where wait: True. | | | `documentType` | string | null | No | — | The document type's identifier. Provide if you already know the document type. | | `enableValidationTool` | boolean | No | — | If true, the document will be viewable in the Affinda Validation Tool. Set to False to optimize parsing speed. | | | `expiryTime` | string | null | No | — | The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry. | | `file` | string | No | — | File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG, TIFF, ODT, XLS, XLSX | | | `fileName` | string | null | No | — | Optional filename of the file | | `identifier` | string | No | — | Deprecated in favor of `customIdentifier`. | | | `language` | string | null | No | — | Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese. | | `limitToExamples` | string\[] | No | — | Restrict LLM example selection to the specified document identifiers. | | | `llmHint` | string | null | No | — | Optional hint inserted into the LLM prompt when processing this document. | | `lowPriority` | boolean | No | — | Explicitly mark this document as low priority. | | | `regionBias` | string | No | — | A JSON representation of the RegionBias object. | | | `rejectDuplicates` | boolean | null | No | — | If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings. | | `url` | string | null | No | — | URL to download the document. | | `useOcr` | boolean | null | No | — | If true, the document will be treated like an image, and the text will be extracted using OCR. If false, the document will be treated like a PDF, and the text will be extracted using the parser. If not set, we will determine whether to use OCR based on whether words are found in the document. | | `wait` | boolean | No | — | If "true" (default), will return a response only after processing has completed. If "false", will return an empty data object which can be polled at the GET endpoint until processing is complete. | | | `warningMessages` | object\[] | No | — | Warning Messages | | | `workspace` | string | No | — | Uniquely identify a workspace. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "snake_case": { "type": "boolean", "description": "Whether to return the response in snake_case instead of camelCase. Default is false." }, "collection": { "type": "string", "description": "Uniquely identify a collection." }, "compact": { "type": "boolean", "description": "If true, the returned parse result (assuming `wait` is also true) will be a compact version of the full result." }, "customIdentifier": { "type": "string", "description": "Specify a custom identifier for the document if you need one, not required to be unique." }, "deleteAfterParse": { "type": "boolean", "description": "If true, no data will be stored after parsing. Only compatible with requests where wait: True." }, "documentType": { "type": [ "string", "null" ], "description": "The document type's identifier. Provide if you already know the document type." }, "enableValidationTool": { "type": "boolean", "description": "If true, the document will be viewable in the Affinda Validation Tool. Set to False to optimize parsing speed." }, "expiryTime": { "type": [ "string", "null" ], "description": "The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry." }, "file": { "type": "string", "description": "File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG, TIFF, ODT, XLS, XLSX" }, "fileName": { "type": [ "string", "null" ], "description": "Optional filename of the file" }, "identifier": { "type": "string", "description": "Deprecated in favor of `customIdentifier`." }, "language": { "type": [ "string", "null" ], "description": "Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese." }, "limitToExamples": { "type": "array", "items": { "type": "string" }, "description": "Restrict LLM example selection to the specified document identifiers." }, "llmHint": { "type": [ "string", "null" ], "description": "Optional hint inserted into the LLM prompt when processing this document." }, "lowPriority": { "type": "boolean", "description": "Explicitly mark this document as low priority." }, "regionBias": { "type": "string", "description": "A JSON representation of the RegionBias object." }, "rejectDuplicates": { "type": [ "boolean", "null" ], "description": "If \"true\", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If \"false\", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings." }, "url": { "type": [ "string", "null" ], "description": "URL to download the document." }, "useOcr": { "type": [ "boolean", "null" ], "description": "If true, the document will be treated like an image, and the text will be extracted using OCR. If false, the document will be treated like a PDF, and the text will be extracted using the parser. If not set, we will determine whether to use OCR based on whether words are found in the document." }, "wait": { "type": "boolean", "description": "If \"true\" (default), will return a response only after processing has completed. If \"false\", will return an empty data object which can be polled at the GET endpoint until processing is complete." }, "warningMessages": { "type": "array", "items": { "type": "object", "properties": { "warningCode": { "type": "string", "description": "Warning Code" }, "warningDetail": { "type": "string", "description": "Warning Detail" } } }, "description": "Warning Messages" }, "workspace": { "type": "string", "description": "Uniquely identify a workspace." } }, "required": [ "PCID" ] } ``` *** ## affinda\_documents\_create\_document\_type Create a document type **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `description` | string | null | No | — | A description of the document type. | | `name` | string | Yes | — | The name of the document type. | | | `organization` | string | Yes | — | The identifier of the organization this document type belongs to. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": [ "string", "null" ], "description": "A description of the document type." }, "name": { "type": "string", "description": "The name of the document type." }, "organization": { "type": "string", "description": "The identifier of the organization this document type belongs to." } }, "required": [ "PCID", "name", "organization" ] } ``` *** ## affinda\_documents\_create\_validation\_result Create a validation result **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `annotations` | integer\[] | Yes | — | List of annotation ids that were validated | | | `document` | string | Yes | — | Unique identifier for the document | | | `message` | string | Yes | — | Message explaining why the validation failed | | | `passed` | boolean | null | No | — | Whether the validation passed or not, null if the validation was not applicable | | `ruleSlug` | string | Yes | — | The kebab-case slug of the validation rule that was applied | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "annotations": { "type": "array", "items": { "type": "integer" }, "description": "List of annotation ids that were validated" }, "document": { "type": "string", "description": "Unique identifier for the document" }, "message": { "type": "string", "description": "Message explaining why the validation failed" }, "passed": { "type": [ "boolean", "null" ], "description": "Whether the validation passed or not, null if the validation was not applicable" }, "ruleSlug": { "type": "string", "description": "The kebab-case slug of the validation rule that was applied" } }, "required": [ "PCID", "annotations", "document", "message", "ruleSlug" ] } ``` *** ## affinda\_documents\_delete\_annotation Delete an annotation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Annotation's ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Annotation's ID" } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_documents\_delete\_document Delete a document **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Document's identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Document's identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_documents\_delete\_document\_type Delete a document type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Document type identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Document type identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_documents\_delete\_validation\_result Delete a validation result **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Validation result's ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Validation result's ID." } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_documents\_get\_all\_annotations Get list of all annotations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `document` | string | Yes | — | Filter by document. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "document": { "type": "string", "description": "Filter by document." } }, "required": [ "PCID", "document" ] } ``` *** ## affinda\_documents\_get\_all\_documents Get list of all documents **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `limit` | integer | No | — | The numbers of results to return. | | `workspace` | string | No | — | Filter by workspace. | | `collection` | string | No | — | Filter by collection. | | `state` | string | No | — | Filter by the document's state. | | `tags` | integer\[] | No | — | Filter by tag's IDs. | | `created_dt` | string | No | — | Filter by created datetime. | | `search` | string | No | — | Partial, case-insensitive match with file name or tag name. | | `ordering` | string\[] | No | — | Sort the result set. A "-" at the beginning denotes DESC sort, e.g. -created\_dt. Sort by multiple fields is supported. Supported values include: 'file\_name', 'extractor', 'created\_dt', 'validated\_dt', 'archived\_dt' and 'parsed\_\_\'. | | `include_data` | boolean | No | — | By default, this endpoint returns only the meta data of the documents. Set this to `true` will return a summary of the data that was parsed. If you want to retrieve the full set of data for a document, use the `GET /documents/{identifier}` endpoint. | | `exclude` | string\[] | No | — | Exclude some documents from the result. | | `in_review` | boolean | No | — | Exclude documents that are currently being reviewed. | | `failed` | boolean | No | — | Filter by failed status. | | `ready` | boolean | No | — | Filter by ready status. | | `validatable` | boolean | No | — | Filter for validatable documents. | | `has_challenges` | boolean | No | — | Filter for documents with challenges. | | `custom_identifier` | string | No | — | Filter for documents with this custom identifier. | | `compact` | boolean | No | — | If "true", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is "false". | | `count` | boolean | No | — | If "false", the documents count is not computed, thus saving time for large collections. Default is "true". | | `snake_case` | boolean | No | — | Whether to return the response in snake\_case instead of camelCase. Default is false. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "workspace": { "type": "string", "description": "Filter by workspace." }, "collection": { "type": "string", "description": "Filter by collection." }, "state": { "type": "string", "description": "Filter by the document's state.", "enum": [ "uploaded", "review", "validated", "archived", "rejected" ] }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "Filter by tag's IDs." }, "created_dt": { "type": "string", "description": "Filter by created datetime.", "enum": [ "today", "yesterday", "week", "month", "year" ] }, "search": { "type": "string", "description": "Partial, case-insensitive match with file name or tag name." }, "ordering": { "type": "array", "items": { "type": "string" }, "description": "Sort the result set. A \"-\" at the beginning denotes DESC sort, e.g. -created_dt. Sort by multiple fields is supported. Supported values include: 'file_name', 'extractor', 'created_dt', 'validated_dt', 'archived_dt' and 'parsed__'." }, "include_data": { "type": "boolean", "description": "By default, this endpoint returns only the meta data of the documents. Set this to `true` will return a summary of the data that was parsed. If you want to retrieve the full set of data for a document, use the `GET /documents/{identifier}` endpoint." }, "exclude": { "type": "array", "items": { "type": "string" }, "description": "Exclude some documents from the result." }, "in_review": { "type": "boolean", "description": "Exclude documents that are currently being reviewed." }, "failed": { "type": "boolean", "description": "Filter by failed status." }, "ready": { "type": "boolean", "description": "Filter by ready status." }, "validatable": { "type": "boolean", "description": "Filter for validatable documents." }, "has_challenges": { "type": "boolean", "description": "Filter for documents with challenges." }, "custom_identifier": { "type": "string", "description": "Filter for documents with this custom identifier." }, "compact": { "type": "boolean", "description": "If \"true\", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is \"false\"." }, "count": { "type": "boolean", "description": "If \"false\", the documents count is not computed, thus saving time for large collections. Default is \"true\"." }, "snake_case": { "type": "boolean", "description": "Whether to return the response in snake_case instead of camelCase. Default is false." } }, "required": [ "PCID" ] } ``` *** ## affinda\_documents\_get\_all\_validation\_results Get list of all validation results **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `limit` | integer | No | — | The numbers of results to return. | | `document` | string | Yes | — | Filter by document. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "document": { "type": "string", "description": "Filter by document." } }, "required": [ "PCID", "document" ] } ``` *** ## affinda\_documents\_get\_annotation Get specific annotation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Annotation's ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Annotation's ID" } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_documents\_get\_document Get specific document **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Document's identifier | | `format` | string | No | — | Specify which format you want the response to be. Default is "json" | | `compact` | boolean | No | — | If "true", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is "false". | | `snake_case` | boolean | No | — | Whether to return the response in snake\_case instead of camelCase. Default is false. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Document's identifier" }, "format": { "type": "string", "description": "Specify which format you want the response to be. Default is \"json\"", "enum": [ "json", "xml", "hr-xml" ] }, "compact": { "type": "boolean", "description": "If \"true\", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is \"false\"." }, "snake_case": { "type": "boolean", "description": "Whether to return the response in snake_case instead of camelCase. Default is false." } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_documents\_get\_document\_type Get a document type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Document type identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Document type identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_documents\_get\_document\_types List document types **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `organization` | string | No | — | Filter by organization identifier | | `workspace` | string | No | — | Filter by workspace identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization": { "type": "string", "description": "Filter by organization identifier" }, "workspace": { "type": "string", "description": "Filter by workspace identifier" } }, "required": [ "PCID" ] } ``` *** ## affinda\_documents\_get\_redacted\_document Get redacted document **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Document identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Document identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_documents\_get\_validation\_result Get specific validation result **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Validation result's ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Validation result's ID." } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_documents\_json\_schema\_from\_document\_type Generate JSON schema from a document type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Document type's identifier | | `title` | string | No | — | Title for the JSON schema | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Document type's identifier" }, "title": { "type": "string", "description": "Title for the JSON schema" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_documents\_pydantic\_models\_from\_document\_type Generate Pydantic models from a document type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Document type's identifier | | `model_name` | string | No | — | Name for the Pydantic model | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Document type's identifier" }, "model_name": { "type": "string", "description": "Name for the Pydantic model" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_documents\_update\_annotation Update an annotation **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `id` | integer | Yes | — | Annotation's ID | | | `dataPoint` | string | No | — | Data point's identifier | | | `document` | string | No | — | Unique identifier for the document | | | `field` | string | null | No | — | Field's identifier | | `isClientVerified` | boolean | No | — | Indicates whether the data has been validated by a human | | | `pageIndex` | integer | null | No | — | The page number within the document, starting from 0. | | `parent` | integer | null | No | — | The parent annotation's ID | | `parsed` | object | No | — | The parsed value | | | `raw` | string | null | No | — | Raw data extracted from the before any post-processing | | `rectangles` | object\[] | No | — | x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles. | | | `validationResults` | object\[] | No | — | The validation results created, changed or deleted as a result of updating the annotation. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Annotation's ID" }, "dataPoint": { "type": "string", "description": "Data point's identifier" }, "document": { "type": "string", "description": "Unique identifier for the document" }, "field": { "type": [ "string", "null" ], "description": "Field's identifier" }, "isClientVerified": { "type": "boolean", "description": "Indicates whether the data has been validated by a human" }, "pageIndex": { "type": [ "integer", "null" ], "description": "The page number within the document, starting from 0." }, "parent": { "type": [ "integer", "null" ], "description": "The parent annotation's ID" }, "parsed": { "description": "The parsed value" }, "raw": { "type": [ "string", "null" ], "description": "Raw data extracted from the before any post-processing" }, "rectangles": { "type": "array", "items": { "type": "object", "properties": { "pageIndex": { "type": "integer", "description": "Page Index" }, "x0": { "type": "number", "description": "The x0 value" }, "y0": { "type": "number", "description": "The y0 value" }, "x1": { "type": "number", "description": "The x1 value" }, "y1": { "type": "number", "description": "The y1 value" } }, "required": [ "x0", "y0", "x1", "y1" ] }, "description": "x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles." }, "validationResults": { "type": "array", "items": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Validation Result's ID" }, "annotations": { "type": "array", "description": "List of annotation ids that were validated" }, "passed": { "type": "boolean", "description": "Whether the validation passed or not, null if the validation was not applicable" }, "ruleSlug": { "type": "string", "description": "The kebab-case slug of the validation rule that was applied" }, "message": { "type": "string", "description": "Message explaining why the validation failed" }, "document": { "type": "string", "description": "Unique identifier for the document" } } }, "description": "List of validation results created during this operation." }, "updated": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Validation Result's ID" }, "annotations": { "type": "array", "description": "List of annotation ids that were validated" }, "passed": { "type": "boolean", "description": "Whether the validation passed or not, null if the validation was not applicable" }, "ruleSlug": { "type": "string", "description": "The kebab-case slug of the validation rule that was applied" }, "message": { "type": "string", "description": "Message explaining why the validation failed" }, "document": { "type": "string", "description": "Unique identifier for the document" } } }, "description": "List of validation results updated during this operation." }, "deleted": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Validation Result's ID" }, "annotations": { "type": "array", "description": "List of annotation ids that were validated" }, "passed": { "type": "boolean", "description": "Whether the validation passed or not, null if the validation was not applicable" }, "ruleSlug": { "type": "string", "description": "The kebab-case slug of the validation rule that was applied" }, "message": { "type": "string", "description": "Message explaining why the validation failed" }, "document": { "type": "string", "description": "Unique identifier for the document" } } }, "description": "List of validation results deleted during this operation." } } }, "description": "The validation results created, changed or deleted as a result of updating the annotation." } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_documents\_update\_document Update a document **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `identifier` | string | Yes | — | Document's identifier | | | `compact` | boolean | No | — | If "true", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is "false". | | | `snake_case` | boolean | No | — | Whether to return the response in snake\_case instead of camelCase. Default is false. | | | `collection` | string | No | — | Uniquely identify a collection. | | | `customIdentifier` | string | No | — | Specify a custom identifier for the document if you need one, not required to be unique. | | | `documentType` | string | null | No | — | The document type's identifier. Provide if you already know the document type. | | `expiryTime` | string | null | No | — | The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry. | | `fileName` | string | null | No | — | Optional filename of the file | | `isArchived` | boolean | No | — | Is Archived | | | `isConfirmed` | boolean | No | — | Is Confirmed | | | `isRejected` | boolean | No | — | Is Rejected | | | `language` | string | null | No | — | Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese. | | `llmHint` | string | null | No | — | Optional hint inserted into the LLM prompt when processing this document. | | `skipParse` | boolean | No | — | Skip Parse | | | `warningMessages` | object\[] | No | — | Warning Messages | | | `workspace` | string | No | — | Uniquely identify a workspace. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Document's identifier" }, "compact": { "type": "boolean", "description": "If \"true\", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is \"false\"." }, "snake_case": { "type": "boolean", "description": "Whether to return the response in snake_case instead of camelCase. Default is false." }, "collection": { "type": "string", "description": "Uniquely identify a collection." }, "customIdentifier": { "type": "string", "description": "Specify a custom identifier for the document if you need one, not required to be unique." }, "documentType": { "type": [ "string", "null" ], "description": "The document type's identifier. Provide if you already know the document type." }, "expiryTime": { "type": [ "string", "null" ], "description": "The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry." }, "fileName": { "type": [ "string", "null" ], "description": "Optional filename of the file" }, "isArchived": { "type": "boolean", "description": "Is Archived" }, "isConfirmed": { "type": "boolean", "description": "Is Confirmed" }, "isRejected": { "type": "boolean", "description": "Is Rejected" }, "language": { "type": [ "string", "null" ], "description": "Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese." }, "llmHint": { "type": [ "string", "null" ], "description": "Optional hint inserted into the LLM prompt when processing this document." }, "skipParse": { "type": "boolean", "description": "Skip Parse" }, "warningMessages": { "type": "array", "items": { "type": "object", "properties": { "warningCode": { "type": "string", "description": "Warning Code" }, "warningDetail": { "type": "string", "description": "Warning Detail" } } }, "description": "Warning Messages" }, "workspace": { "type": "string", "description": "Uniquely identify a workspace." } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_documents\_update\_document\_type Update a document type **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `identifier` | string | Yes | — | Document type identifier | | | `description` | string | null | No | — | A new description of the document type. | | `name` | string | No | — | The new name of the document type. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Document type identifier" }, "description": { "type": [ "string", "null" ], "description": "A new description of the document type." }, "name": { "type": "string", "description": "The new name of the document type." } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_documents\_update\_validation\_result Update a validation result **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `id` | integer | Yes | — | Validation result's ID. | | | `annotations` | integer\[] | No | — | List of annotation ids that were validated | | | `document` | string | No | — | Unique identifier for the document | | | `message` | string | No | — | Message explaining why the validation failed | | | `passed` | boolean | null | No | — | Whether the validation passed or not, null if the validation was not applicable | | `ruleSlug` | string | No | — | The kebab-case slug of the validation rule that was applied | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Validation result's ID." }, "annotations": { "type": "array", "items": { "type": "integer" }, "description": "List of annotation ids that were validated" }, "document": { "type": "string", "description": "Unique identifier for the document" }, "message": { "type": "string", "description": "Message explaining why the validation failed" }, "passed": { "type": [ "boolean", "null" ], "description": "Whether the validation passed or not, null if the validation was not applicable" }, "ruleSlug": { "type": "string", "description": "The kebab-case slug of the validation rule that was applied" } }, "required": [ "PCID", "id" ] } ``` # affinda-search Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/affinda/affinda-search Affinda Search - resume and job description search and matching **Server path:** `/affinda-search` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`affinda_search_create_document_from_data`](#affinda_search_create_document_from_data) | Create a document from raw data | | [`affinda_search_create_index`](#affinda_search_create_index) | Create a new index | | [`affinda_search_create_index_document`](#affinda_search_create_index_document) | Index a new document | | [`affinda_search_create_job_description_search`](#affinda_search_create_job_description_search) | Search through parsed job descriptions | | [`affinda_search_create_job_description_search_embed_url`](#affinda_search_create_job_description_search_embed_url) | Create a signed URL for the embeddable job description search tool | | [`affinda_search_create_resume_search`](#affinda_search_create_resume_search) | Search through parsed resumes | | [`affinda_search_create_resume_search_embed_url`](#affinda_search_create_resume_search_embed_url) | Create a signed URL for the embeddable resume search tool | | [`affinda_search_delete_index`](#affinda_search_delete_index) | Delete an index | | [`affinda_search_delete_index_document`](#affinda_search_delete_index_document) | Delete an indexed document | | [`affinda_search_get_all_index_documents`](#affinda_search_get_all_index_documents) | Get indexed documents for a specific index | | [`affinda_search_get_all_indexes`](#affinda_search_get_all_indexes) | Get list of all indexes | | [`affinda_search_get_job_description_search_config`](#affinda_search_get_job_description_search_config) | Get the config for the logged in user's embeddable job description search tool | | [`affinda_search_get_job_description_search_detail`](#affinda_search_get_job_description_search_detail) | Get search result of specific job description | | [`affinda_search_get_resume_search_config`](#affinda_search_get_resume_search_config) | Get the config for the logged in user's embeddable resume search tool | | [`affinda_search_get_resume_search_detail`](#affinda_search_get_resume_search_detail) | Get search result of specific resume | | [`affinda_search_get_resume_search_match`](#affinda_search_get_resume_search_match) | Match a single resume and job description | | [`affinda_search_get_resume_search_suggestion_job_title`](#affinda_search_get_resume_search_suggestion_job_title) | Get job title suggestions based on provided job title(s) | | [`affinda_search_get_resume_search_suggestion_skill`](#affinda_search_get_resume_search_suggestion_skill) | Get skill suggestions based on provided skill(s) | | [`affinda_search_list_occupation_groups`](#affinda_search_list_occupation_groups) | List occupation groups | | [`affinda_search_re_index_document`](#affinda_search_re_index_document) | Re-index a document | | [`affinda_search_update_document_data`](#affinda_search_update_document_data) | Update a document's data | | [`affinda_search_update_job_description_search_config`](#affinda_search_update_job_description_search_config) | Update the config for the logged in user's embeddable job description search tool | | [`affinda_search_update_resume_search_config`](#affinda_search_update_resume_search_config) | Update the config for the logged in user's embeddable resume search tool | *** ## affinda\_search\_create\_document\_from\_data Create a document from raw data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `snake_case` | boolean | No | — | Whether to return the response in snake\_case instead of camelCase. Default is false. | | `data` | object | Yes | — | Create resume or job description directly from data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "snake_case": { "type": "boolean", "description": "Whether to return the response in snake_case instead of camelCase. Default is false." }, "data": { "description": "Create resume or job description directly from data." } }, "required": [ "PCID", "data" ] } ``` *** ## affinda\_search\_create\_index Create a new index **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `docType` | string | No | — | Doc Type | | `name` | string | Yes | — | Unique index name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "docType": { "type": "string", "description": "Doc Type", "enum": [ "resumes", "job_descriptions" ] }, "name": { "type": "string", "description": "Unique index name" } }, "required": [ "PCID", "name" ] } ``` *** ## affinda\_search\_create\_index\_document Index a new document **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Index name | | `document` | string | No | — | The document value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Index name" }, "document": { "type": "string", "description": "The document value" } }, "required": [ "PCID", "name" ] } ``` *** ## affinda\_search\_create\_job\_description\_search Search through parsed job descriptions **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | | `limit` | integer | No | — | The numbers of results to return. | | | `customData` | object\[] | No | — | Custom Data | | | `degrees` | string\[] | No | — | The degrees value | | | `degreesRequired` | boolean | No | — | Degrees Required | | | `degreeTypes` | string\[] | No | — | Degree Types | | | `degreeTypesRequired` | boolean | No | — | Degree Types Required | | | `educationWeight` | number | No | — | Education Weight | | | `indices` | string\[] | Yes | — | The indices value | | | `jobTitles` | string\[] | No | — | Job Titles | | | `jobTitlesRequired` | boolean | No | — | Job Titles Required | | | `jobTitlesWeight` | number | No | — | Job Titles Weight | | | `languages` | object\[] | No | — | The languages value | | | `languagesWeight` | number | No | — | Languages Weight | | | `locations` | object\[] | No | — | The locations value | | | `locationsRequired` | boolean | No | — | Locations Required | | | `locationsWeight` | number | No | — | Locations Weight | | | `managementLevel` | string | null | No | — | Management Level | | `managementLevelRequired` | boolean | No | — | Management Level Required | | | `managementLevelWeight` | number | No | — | Management Level Weight | | | `resume` | string | No | — | A random string that uniquely identify the resource. | | | `searchExpression` | string | null | No | — | Search Expression | | `searchExpressionRequired` | boolean | No | — | Search Expression Required | | | `searchExpressionWeight` | number | No | — | Search Expression Weight | | | `skills` | object\[] | No | — | The skills value | | | `skillsWeight` | number | No | — | Skills Weight | | | `socCodes` | integer\[] | No | — | Soc Codes | | | `socCodesRequired` | boolean | No | — | Soc Codes Required | | | `socCodesWeight` | number | No | — | Soc Codes Weight | | | `totalYearsExperience` | number | null | No | — | Total Years Experience | | `yearsExperienceRequired` | boolean | No | — | Years Experience Required | | | `yearsExperienceWeight` | number | No | — | Years Experience Weight | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "customData": { "type": "array", "items": { "type": "object", "properties": { "filterType": { "type": "string", "enum": [ "equals", "range" ], "description": "Data points of \"text\" type support only \"equals\" filterType, others support both \"equals\" and \"range\"" }, "dataPoint": { "type": "string", "description": "The data point's slug, used for portal v2 (deprecated)" }, "field": { "type": "string", "description": "The field's slug" }, "query": { "type": "object", "description": "\"equals\" searches require the \"value\" key inside the query, and \"range\" searches require at least one of \"gte\" (greater than or equal) and \"lte\" (less than or equal)" }, "required": { "type": "boolean", "description": "The required value" }, "weight": { "type": "number", "description": "The weight value" } }, "required": [ "filterType", "query" ] }, "description": "Custom Data" }, "degrees": { "type": "array", "items": { "type": "string" }, "description": "The degrees value" }, "degreesRequired": { "type": "boolean", "description": "Degrees Required" }, "degreeTypes": { "type": "array", "items": { "type": "string", "enum": [ "school", "certificate", "bachelors", "masters", "doctoral" ] }, "description": "Degree Types" }, "degreeTypesRequired": { "type": "boolean", "description": "Degree Types Required" }, "educationWeight": { "type": "number", "description": "Education Weight" }, "indices": { "type": "array", "items": { "type": "string" }, "description": "The indices value" }, "jobTitles": { "type": "array", "items": { "type": "string" }, "description": "Job Titles" }, "jobTitlesRequired": { "type": "boolean", "description": "Job Titles Required" }, "jobTitlesWeight": { "type": "number", "description": "Job Titles Weight" }, "languages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "required": { "type": "boolean", "description": "The required value" } } }, "description": "The languages value" }, "languagesWeight": { "type": "number", "description": "Languages Weight" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "coordinates": { "type": "object", "description": "The coordinates value" }, "distance": { "type": "integer", "description": "The distance value" }, "unit": { "type": "string", "enum": [ "km", "mi" ], "description": "The unit value" } } }, "description": "The locations value" }, "locationsRequired": { "type": "boolean", "description": "Locations Required" }, "locationsWeight": { "type": "number", "description": "Locations Weight" }, "managementLevel": { "type": [ "string", "null" ], "description": "Management Level", "enum": [ "None", "Low", "Mid", "Upper" ] }, "managementLevelRequired": { "type": "boolean", "description": "Management Level Required" }, "managementLevelWeight": { "type": "number", "description": "Management Level Weight" }, "resume": { "type": "string", "description": "A random string that uniquely identify the resource." }, "searchExpression": { "type": [ "string", "null" ], "description": "Search Expression" }, "searchExpressionRequired": { "type": "boolean", "description": "Search Expression Required" }, "searchExpressionWeight": { "type": "number", "description": "Search Expression Weight" }, "skills": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "required": { "type": "boolean", "description": "The required value" } } }, "description": "The skills value" }, "skillsWeight": { "type": "number", "description": "Skills Weight" }, "socCodes": { "type": "array", "items": { "type": "integer" }, "description": "Soc Codes" }, "socCodesRequired": { "type": "boolean", "description": "Soc Codes Required" }, "socCodesWeight": { "type": "number", "description": "Soc Codes Weight" }, "totalYearsExperience": { "type": [ "number", "null" ], "description": "Total Years Experience" }, "yearsExperienceRequired": { "type": "boolean", "description": "Years Experience Required" }, "yearsExperienceWeight": { "type": "number", "description": "Years Experience Weight" } }, "required": [ "PCID", "indices" ] } ``` *** ## affinda\_search\_create\_job\_description\_search\_embed\_url Create a signed URL for the embeddable job description search tool **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `configOverride` | object | No | — | Config Override | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "configOverride": { "type": "object", "description": "Config Override", "properties": { "allowPdfDownload": { "type": "boolean", "description": "Allow Pdf Download" }, "maxResults": { "type": "integer", "description": "Maximum number of results that can be returned. Setting to \"null\" means no limitation." }, "displayJobTitle": { "type": "boolean", "description": "Display Job Title" }, "displayLocation": { "type": "boolean", "description": "Display Location" }, "displayYearsExperience": { "type": "boolean", "description": "Display Years Experience" }, "displayOccupationGroup": { "type": "boolean", "description": "Display Occupation Group" }, "displayEducation": { "type": "boolean", "description": "Display Education" }, "displaySkills": { "type": "boolean", "description": "Display Skills" }, "displayLanguages": { "type": "boolean", "description": "Display Languages" }, "displayManagementLevel": { "type": "boolean", "description": "Display Management Level" }, "displayKeywords": { "type": "boolean", "description": "Display Keywords" }, "weightJobTitle": { "type": "number", "description": "Weight Job Title" }, "weightLocation": { "type": "number", "description": "Weight Location" }, "weightYearsExperience": { "type": "number", "description": "Weight Years Experience" }, "weightOccupationGroup": { "type": "number", "description": "Weight Occupation Group" }, "weightEducation": { "type": "number", "description": "Weight Education" }, "weightSkills": { "type": "number", "description": "Weight Skills" }, "weightLanguages": { "type": "number", "description": "Weight Languages" }, "weightManagementLevel": { "type": "number", "description": "Weight Management Level" }, "weightKeywords": { "type": "number", "description": "Weight Keywords" }, "indices": { "type": "array", "items": { "type": "string" }, "description": "List of index names." }, "showIndexDropdown": { "type": "boolean", "description": "Controls whether or not the index dropdown is displayed to the user" }, "searchToolTheme": { "type": "object", "description": "Customize the theme of the embeded search tool." }, "userId": { "type": "integer", "description": "ID of the logged in user." }, "username": { "type": "string", "description": "Username of the logged in user." }, "actions": { "type": "array", "items": { "type": "object" }, "description": "A list of actions to show in the dropdown in the embedded search tool" }, "hideToolbar": { "type": "boolean", "description": "Hide the reset/import toolbar." }, "hideSidePanel": { "type": "boolean", "description": "Hide the entire side panel." }, "customFieldsConfig": { "type": "array", "items": { "type": "object" }, "description": "Custom Fields Config" }, "distanceUnit": { "type": "string", "description": "The unit of distance to use for location based searches", "enum": [ "mi", "km" ] } } } }, "required": [ "PCID" ] } ``` *** ## affinda\_search\_create\_resume\_search Search through parsed resumes **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | | `limit` | integer | No | — | The numbers of results to return. | | | `customData` | object\[] | No | — | Custom Data | | | `degrees` | string\[] | No | — | The degrees value | | | `degreesRequired` | boolean | No | — | Degrees Required | | | `educationWeight` | number | No | — | Education Weight | | | `highestDegreeTypes` | string\[] | No | — | Highest Degree Types | | | `highestDegreeTypesRequired` | boolean | No | — | Highest Degree Types Required | | | `indices` | string\[] | Yes | — | The indices value | | | `institutions` | string\[] | No | — | The institutions value | | | `institutionsRequired` | boolean | No | — | Institutions Required | | | `isCurrentStudent` | boolean | No | — | Search for student canditates | | | `isCurrentStudentRequired` | boolean | No | — | Is Current Student Required | | | `isRecentGraduate` | boolean | No | — | Search for canditates that graduated less than a year ago | | | `isRecentGraduateRequired` | boolean | No | — | Is Recent Graduate Required | | | `jobDescription` | string | No | — | A random string that uniquely identify the resource. | | | `jobTitles` | string\[] | No | — | Job Titles | | | `jobTitlesCurrentOnly` | boolean | No | — | Search only through the canditate's current job | | | `jobTitlesRequired` | boolean | No | — | Job Titles Required | | | `jobTitlesWeight` | number | No | — | Job Titles Weight | | | `languages` | object\[] | No | — | The languages value | | | `languagesWeight` | number | No | — | Languages Weight | | | `locations` | object\[] | No | — | Search by location name or by coordinates | | | `locationsRequired` | boolean | No | — | Locations Required | | | `locationsWeight` | number | No | — | Locations Weight | | | `managementLevel` | string | null | No | — | Management Level | | `managementLevelRequired` | boolean | No | — | Management Level Required | | | `managementLevelWeight` | number | No | — | Management Level Weight | | | `resume` | string | No | — | A random string that uniquely identify the resource. | | | `searchExpression` | string | null | No | — | Search through resumes' raw text | | `searchExpressionRequired` | boolean | No | — | Search Expression Required | | | `searchExpressionWeight` | number | No | — | Search Expression Weight | | | `skills` | object\[] | No | — | The skills value | | | `skillsWeight` | number | No | — | Skills Weight | | | `socCodes` | integer\[] | No | — | Soc Codes | | | `socCodesRequired` | boolean | No | — | Soc Codes Required | | | `socCodesWeight` | number | No | — | Soc Codes Weight | | | `yearsExperienceMax` | integer | null | No | — | Maximum years of total work experience | | `yearsExperienceMin` | integer | null | No | — | Minimum years of total work experience | | `yearsExperienceRequired` | boolean | No | — | Years Experience Required | | | `yearsExperienceWeight` | number | No | — | Years Experience Weight | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "customData": { "type": "array", "items": { "type": "object" }, "description": "Custom Data" }, "degrees": { "type": "array", "items": { "type": "string" }, "description": "The degrees value" }, "degreesRequired": { "type": "boolean", "description": "Degrees Required" }, "educationWeight": { "type": "number", "description": "Education Weight" }, "highestDegreeTypes": { "type": "array", "items": { "type": "string", "enum": [ "school", "certificate", "bachelors", "masters", "doctoral" ] }, "description": "Highest Degree Types" }, "highestDegreeTypesRequired": { "type": "boolean", "description": "Highest Degree Types Required" }, "indices": { "type": "array", "items": { "type": "string" }, "description": "The indices value" }, "institutions": { "type": "array", "items": { "type": "string" }, "description": "The institutions value" }, "institutionsRequired": { "type": "boolean", "description": "Institutions Required" }, "isCurrentStudent": { "type": "boolean", "description": "Search for student canditates" }, "isCurrentStudentRequired": { "type": "boolean", "description": "Is Current Student Required" }, "isRecentGraduate": { "type": "boolean", "description": "Search for canditates that graduated less than a year ago" }, "isRecentGraduateRequired": { "type": "boolean", "description": "Is Recent Graduate Required" }, "jobDescription": { "type": "string", "description": "A random string that uniquely identify the resource." }, "jobTitles": { "type": "array", "items": { "type": "string" }, "description": "Job Titles" }, "jobTitlesCurrentOnly": { "type": "boolean", "description": "Search only through the canditate's current job" }, "jobTitlesRequired": { "type": "boolean", "description": "Job Titles Required" }, "jobTitlesWeight": { "type": "number", "description": "Job Titles Weight" }, "languages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "required": { "type": "boolean", "description": "The required value" } } }, "description": "The languages value" }, "languagesWeight": { "type": "number", "description": "Languages Weight" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "coordinates": { "type": "object", "description": "The coordinates value" }, "distance": { "type": "integer", "description": "The distance value" }, "unit": { "type": "string", "enum": [ "km", "mi" ], "description": "The unit value" } } }, "description": "Search by location name or by coordinates" }, "locationsRequired": { "type": "boolean", "description": "Locations Required" }, "locationsWeight": { "type": "number", "description": "Locations Weight" }, "managementLevel": { "type": [ "string", "null" ], "description": "Management Level", "enum": [ "None", "Low", "Mid", "Upper" ] }, "managementLevelRequired": { "type": "boolean", "description": "Management Level Required" }, "managementLevelWeight": { "type": "number", "description": "Management Level Weight" }, "resume": { "type": "string", "description": "A random string that uniquely identify the resource." }, "searchExpression": { "type": [ "string", "null" ], "description": "Search through resumes' raw text" }, "searchExpressionRequired": { "type": "boolean", "description": "Search Expression Required" }, "searchExpressionWeight": { "type": "number", "description": "Search Expression Weight" }, "skills": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "required": { "type": "boolean", "description": "The required value" } } }, "description": "The skills value" }, "skillsWeight": { "type": "number", "description": "Skills Weight" }, "socCodes": { "type": "array", "items": { "type": "integer" }, "description": "Soc Codes" }, "socCodesRequired": { "type": "boolean", "description": "Soc Codes Required" }, "socCodesWeight": { "type": "number", "description": "Soc Codes Weight" }, "yearsExperienceMax": { "type": [ "integer", "null" ], "description": "Maximum years of total work experience" }, "yearsExperienceMin": { "type": [ "integer", "null" ], "description": "Minimum years of total work experience" }, "yearsExperienceRequired": { "type": "boolean", "description": "Years Experience Required" }, "yearsExperienceWeight": { "type": "number", "description": "Years Experience Weight" } }, "required": [ "PCID", "indices" ] } ``` *** ## affinda\_search\_create\_resume\_search\_embed\_url Create a signed URL for the embeddable resume search tool **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `configOverride` | object | No | — | Config Override | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "configOverride": { "type": "object", "description": "Config Override", "properties": { "allowPdfDownload": { "type": "boolean", "description": "Allow Pdf Download" }, "maxResults": { "type": "integer", "description": "Maximum number of results that can be returned. Setting to \"null\" means no limitation." }, "displayJobTitle": { "type": "boolean", "description": "Display Job Title" }, "displayLocation": { "type": "boolean", "description": "Display Location" }, "displayYearsExperience": { "type": "boolean", "description": "Display Years Experience" }, "displayOccupationGroup": { "type": "boolean", "description": "Display Occupation Group" }, "displayEducation": { "type": "boolean", "description": "Display Education" }, "displaySkills": { "type": "boolean", "description": "Display Skills" }, "displayLanguages": { "type": "boolean", "description": "Display Languages" }, "displayManagementLevel": { "type": "boolean", "description": "Display Management Level" }, "displayKeywords": { "type": "boolean", "description": "Display Keywords" }, "weightJobTitle": { "type": "number", "description": "Weight Job Title" }, "weightLocation": { "type": "number", "description": "Weight Location" }, "weightYearsExperience": { "type": "number", "description": "Weight Years Experience" }, "weightOccupationGroup": { "type": "number", "description": "Weight Occupation Group" }, "weightEducation": { "type": "number", "description": "Weight Education" }, "weightSkills": { "type": "number", "description": "Weight Skills" }, "weightLanguages": { "type": "number", "description": "Weight Languages" }, "weightManagementLevel": { "type": "number", "description": "Weight Management Level" }, "weightKeywords": { "type": "number", "description": "Weight Keywords" }, "indices": { "type": "array", "items": { "type": "string" }, "description": "List of index names." }, "showIndexDropdown": { "type": "boolean", "description": "Controls whether or not the index dropdown is displayed to the user" }, "searchToolTheme": { "type": "object", "description": "Customize the theme of the embeded search tool." }, "userId": { "type": "integer", "description": "ID of the logged in user." }, "username": { "type": "string", "description": "Username of the logged in user." }, "actions": { "type": "array", "items": { "type": "object" }, "description": "A list of actions to show in the dropdown in the embedded search tool" }, "hideToolbar": { "type": "boolean", "description": "Hide the reset/import toolbar." }, "hideSidePanel": { "type": "boolean", "description": "Hide the entire side panel." }, "customFieldsConfig": { "type": "array", "items": { "type": "object" }, "description": "Custom Fields Config" }, "distanceUnit": { "type": "string", "description": "The unit of distance to use for location based searches", "enum": [ "mi", "km" ] } } } }, "required": [ "PCID" ] } ``` *** ## affinda\_search\_delete\_index Delete an index **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Index name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Index name" } }, "required": [ "PCID", "name" ] } ``` *** ## affinda\_search\_delete\_index\_document Delete an indexed document **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Index name | | `identifier` | string | Yes | — | Document identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Index name" }, "identifier": { "type": "string", "description": "Document identifier" } }, "required": [ "PCID", "name", "identifier" ] } ``` *** ## affinda\_search\_get\_all\_index\_documents Get indexed documents for a specific index **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `limit` | integer | No | — | The numbers of results to return. | | `name` | string | Yes | — | Index name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "name": { "type": "string", "description": "Index name" } }, "required": [ "PCID", "name" ] } ``` *** ## affinda\_search\_get\_all\_indexes Get list of all indexes **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `limit` | integer | No | — | The numbers of results to return. | | `document_type` | string | No | — | Filter indices by a document type | | `name` | string | No | — | Filter indices by name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "document_type": { "type": "string", "description": "Filter indices by a document type", "enum": [ "resumes", "job_descriptions" ] }, "name": { "type": "string", "description": "Filter indices by name" } }, "required": [ "PCID" ] } ``` *** ## affinda\_search\_get\_job\_description\_search\_config Get the config for the logged in user's embeddable job description search tool ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## affinda\_search\_get\_job\_description\_search\_detail Get search result of specific job description **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `identifier` | string | Yes | — | Job Description identifier | | | `customData` | object\[] | No | — | Custom Data | | | `degrees` | string\[] | No | — | The degrees value | | | `degreesRequired` | boolean | No | — | Degrees Required | | | `degreeTypes` | string\[] | No | — | Degree Types | | | `degreeTypesRequired` | boolean | No | — | Degree Types Required | | | `educationWeight` | number | No | — | Education Weight | | | `indices` | string\[] | Yes | — | The indices value | | | `jobTitles` | string\[] | No | — | Job Titles | | | `jobTitlesRequired` | boolean | No | — | Job Titles Required | | | `jobTitlesWeight` | number | No | — | Job Titles Weight | | | `languages` | object\[] | No | — | The languages value | | | `languagesWeight` | number | No | — | Languages Weight | | | `locations` | object\[] | No | — | The locations value | | | `locationsRequired` | boolean | No | — | Locations Required | | | `locationsWeight` | number | No | — | Locations Weight | | | `managementLevel` | string | null | No | — | Management Level | | `managementLevelRequired` | boolean | No | — | Management Level Required | | | `managementLevelWeight` | number | No | — | Management Level Weight | | | `resume` | string | No | — | A random string that uniquely identify the resource. | | | `searchExpression` | string | null | No | — | Search Expression | | `searchExpressionRequired` | boolean | No | — | Search Expression Required | | | `searchExpressionWeight` | number | No | — | Search Expression Weight | | | `skills` | object\[] | No | — | The skills value | | | `skillsWeight` | number | No | — | Skills Weight | | | `socCodes` | integer\[] | No | — | Soc Codes | | | `socCodesRequired` | boolean | No | — | Soc Codes Required | | | `socCodesWeight` | number | No | — | Soc Codes Weight | | | `totalYearsExperience` | number | null | No | — | Total Years Experience | | `yearsExperienceRequired` | boolean | No | — | Years Experience Required | | | `yearsExperienceWeight` | number | No | — | Years Experience Weight | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Job Description identifier" }, "customData": { "type": "array", "items": { "type": "object", "properties": { "filterType": { "type": "string", "enum": [ "equals", "range" ], "description": "Data points of \"text\" type support only \"equals\" filterType, others support both \"equals\" and \"range\"" }, "dataPoint": { "type": "string", "description": "The data point's slug, used for portal v2 (deprecated)" }, "field": { "type": "string", "description": "The field's slug" }, "query": { "type": "object", "description": "\"equals\" searches require the \"value\" key inside the query, and \"range\" searches require at least one of \"gte\" (greater than or equal) and \"lte\" (less than or equal)" }, "required": { "type": "boolean", "description": "The required value" }, "weight": { "type": "number", "description": "The weight value" } }, "required": [ "filterType", "query" ] }, "description": "Custom Data" }, "degrees": { "type": "array", "items": { "type": "string" }, "description": "The degrees value" }, "degreesRequired": { "type": "boolean", "description": "Degrees Required" }, "degreeTypes": { "type": "array", "items": { "type": "string", "enum": [ "school", "certificate", "bachelors", "masters", "doctoral" ] }, "description": "Degree Types" }, "degreeTypesRequired": { "type": "boolean", "description": "Degree Types Required" }, "educationWeight": { "type": "number", "description": "Education Weight" }, "indices": { "type": "array", "items": { "type": "string" }, "description": "The indices value" }, "jobTitles": { "type": "array", "items": { "type": "string" }, "description": "Job Titles" }, "jobTitlesRequired": { "type": "boolean", "description": "Job Titles Required" }, "jobTitlesWeight": { "type": "number", "description": "Job Titles Weight" }, "languages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "required": { "type": "boolean", "description": "The required value" } } }, "description": "The languages value" }, "languagesWeight": { "type": "number", "description": "Languages Weight" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "coordinates": { "type": "object", "description": "The coordinates value" }, "distance": { "type": "integer", "description": "The distance value" }, "unit": { "type": "string", "enum": [ "km", "mi" ], "description": "The unit value" } } }, "description": "The locations value" }, "locationsRequired": { "type": "boolean", "description": "Locations Required" }, "locationsWeight": { "type": "number", "description": "Locations Weight" }, "managementLevel": { "type": [ "string", "null" ], "description": "Management Level", "enum": [ "None", "Low", "Mid", "Upper" ] }, "managementLevelRequired": { "type": "boolean", "description": "Management Level Required" }, "managementLevelWeight": { "type": "number", "description": "Management Level Weight" }, "resume": { "type": "string", "description": "A random string that uniquely identify the resource." }, "searchExpression": { "type": [ "string", "null" ], "description": "Search Expression" }, "searchExpressionRequired": { "type": "boolean", "description": "Search Expression Required" }, "searchExpressionWeight": { "type": "number", "description": "Search Expression Weight" }, "skills": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "required": { "type": "boolean", "description": "The required value" } } }, "description": "The skills value" }, "skillsWeight": { "type": "number", "description": "Skills Weight" }, "socCodes": { "type": "array", "items": { "type": "integer" }, "description": "Soc Codes" }, "socCodesRequired": { "type": "boolean", "description": "Soc Codes Required" }, "socCodesWeight": { "type": "number", "description": "Soc Codes Weight" }, "totalYearsExperience": { "type": [ "number", "null" ], "description": "Total Years Experience" }, "yearsExperienceRequired": { "type": "boolean", "description": "Years Experience Required" }, "yearsExperienceWeight": { "type": "number", "description": "Years Experience Weight" } }, "required": [ "PCID", "identifier", "indices" ] } ``` *** ## affinda\_search\_get\_resume\_search\_config Get the config for the logged in user's embeddable resume search tool ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## affinda\_search\_get\_resume\_search\_detail Get search result of specific resume **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `identifier` | string | Yes | — | Resume identifier | | | `customData` | object\[] | No | — | Custom Data | | | `degrees` | string\[] | No | — | The degrees value | | | `degreesRequired` | boolean | No | — | Degrees Required | | | `educationWeight` | number | No | — | Education Weight | | | `highestDegreeTypes` | string\[] | No | — | Highest Degree Types | | | `highestDegreeTypesRequired` | boolean | No | — | Highest Degree Types Required | | | `indices` | string\[] | Yes | — | The indices value | | | `institutions` | string\[] | No | — | The institutions value | | | `institutionsRequired` | boolean | No | — | Institutions Required | | | `isCurrentStudent` | boolean | No | — | Search for student canditates | | | `isCurrentStudentRequired` | boolean | No | — | Is Current Student Required | | | `isRecentGraduate` | boolean | No | — | Search for canditates that graduated less than a year ago | | | `isRecentGraduateRequired` | boolean | No | — | Is Recent Graduate Required | | | `jobDescription` | string | No | — | A random string that uniquely identify the resource. | | | `jobTitles` | string\[] | No | — | Job Titles | | | `jobTitlesCurrentOnly` | boolean | No | — | Search only through the canditate's current job | | | `jobTitlesRequired` | boolean | No | — | Job Titles Required | | | `jobTitlesWeight` | number | No | — | Job Titles Weight | | | `languages` | object\[] | No | — | The languages value | | | `languagesWeight` | number | No | — | Languages Weight | | | `locations` | object\[] | No | — | Search by location name or by coordinates | | | `locationsRequired` | boolean | No | — | Locations Required | | | `locationsWeight` | number | No | — | Locations Weight | | | `managementLevel` | string | null | No | — | Management Level | | `managementLevelRequired` | boolean | No | — | Management Level Required | | | `managementLevelWeight` | number | No | — | Management Level Weight | | | `resume` | string | No | — | A random string that uniquely identify the resource. | | | `searchExpression` | string | null | No | — | Search through resumes' raw text | | `searchExpressionRequired` | boolean | No | — | Search Expression Required | | | `searchExpressionWeight` | number | No | — | Search Expression Weight | | | `skills` | object\[] | No | — | The skills value | | | `skillsWeight` | number | No | — | Skills Weight | | | `socCodes` | integer\[] | No | — | Soc Codes | | | `socCodesRequired` | boolean | No | — | Soc Codes Required | | | `socCodesWeight` | number | No | — | Soc Codes Weight | | | `yearsExperienceMax` | integer | null | No | — | Maximum years of total work experience | | `yearsExperienceMin` | integer | null | No | — | Minimum years of total work experience | | `yearsExperienceRequired` | boolean | No | — | Years Experience Required | | | `yearsExperienceWeight` | number | No | — | Years Experience Weight | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Resume identifier" }, "customData": { "type": "array", "items": { "type": "object" }, "description": "Custom Data" }, "degrees": { "type": "array", "items": { "type": "string" }, "description": "The degrees value" }, "degreesRequired": { "type": "boolean", "description": "Degrees Required" }, "educationWeight": { "type": "number", "description": "Education Weight" }, "highestDegreeTypes": { "type": "array", "items": { "type": "string", "enum": [ "school", "certificate", "bachelors", "masters", "doctoral" ] }, "description": "Highest Degree Types" }, "highestDegreeTypesRequired": { "type": "boolean", "description": "Highest Degree Types Required" }, "indices": { "type": "array", "items": { "type": "string" }, "description": "The indices value" }, "institutions": { "type": "array", "items": { "type": "string" }, "description": "The institutions value" }, "institutionsRequired": { "type": "boolean", "description": "Institutions Required" }, "isCurrentStudent": { "type": "boolean", "description": "Search for student canditates" }, "isCurrentStudentRequired": { "type": "boolean", "description": "Is Current Student Required" }, "isRecentGraduate": { "type": "boolean", "description": "Search for canditates that graduated less than a year ago" }, "isRecentGraduateRequired": { "type": "boolean", "description": "Is Recent Graduate Required" }, "jobDescription": { "type": "string", "description": "A random string that uniquely identify the resource." }, "jobTitles": { "type": "array", "items": { "type": "string" }, "description": "Job Titles" }, "jobTitlesCurrentOnly": { "type": "boolean", "description": "Search only through the canditate's current job" }, "jobTitlesRequired": { "type": "boolean", "description": "Job Titles Required" }, "jobTitlesWeight": { "type": "number", "description": "Job Titles Weight" }, "languages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "required": { "type": "boolean", "description": "The required value" } } }, "description": "The languages value" }, "languagesWeight": { "type": "number", "description": "Languages Weight" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "coordinates": { "type": "object", "description": "The coordinates value" }, "distance": { "type": "integer", "description": "The distance value" }, "unit": { "type": "string", "enum": [ "km", "mi" ], "description": "The unit value" } } }, "description": "Search by location name or by coordinates" }, "locationsRequired": { "type": "boolean", "description": "Locations Required" }, "locationsWeight": { "type": "number", "description": "Locations Weight" }, "managementLevel": { "type": [ "string", "null" ], "description": "Management Level", "enum": [ "None", "Low", "Mid", "Upper" ] }, "managementLevelRequired": { "type": "boolean", "description": "Management Level Required" }, "managementLevelWeight": { "type": "number", "description": "Management Level Weight" }, "resume": { "type": "string", "description": "A random string that uniquely identify the resource." }, "searchExpression": { "type": [ "string", "null" ], "description": "Search through resumes' raw text" }, "searchExpressionRequired": { "type": "boolean", "description": "Search Expression Required" }, "searchExpressionWeight": { "type": "number", "description": "Search Expression Weight" }, "skills": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "required": { "type": "boolean", "description": "The required value" } } }, "description": "The skills value" }, "skillsWeight": { "type": "number", "description": "Skills Weight" }, "socCodes": { "type": "array", "items": { "type": "integer" }, "description": "Soc Codes" }, "socCodesRequired": { "type": "boolean", "description": "Soc Codes Required" }, "socCodesWeight": { "type": "number", "description": "Soc Codes Weight" }, "yearsExperienceMax": { "type": [ "integer", "null" ], "description": "Maximum years of total work experience" }, "yearsExperienceMin": { "type": [ "integer", "null" ], "description": "Minimum years of total work experience" }, "yearsExperienceRequired": { "type": "boolean", "description": "Years Experience Required" }, "yearsExperienceWeight": { "type": "number", "description": "Years Experience Weight" } }, "required": [ "PCID", "identifier", "indices" ] } ``` *** ## affinda\_search\_get\_resume\_search\_match Match a single resume and job description **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `resume` | string | Yes | — | Identify the resume to match. | | `job_description` | string | Yes | — | Identify the job description to match. | | `index` | string | No | — | Optionally, specify an index to search in. If not specified, will search in all indexes. | | `search_expression` | string | No | — | Add keywords to the search criteria. | | `job_titles_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. | | `years_experience_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. | | `locations_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. | | `languages_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. | | `skills_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. | | `education_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. | | `search_expression_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. | | `soc_codes_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. | | `management_level_weight` | number | No | — | How important is this criteria to the matching score, range from 0 to 1. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "resume": { "type": "string", "description": "Identify the resume to match." }, "job_description": { "type": "string", "description": "Identify the job description to match." }, "index": { "type": "string", "description": "Optionally, specify an index to search in. If not specified, will search in all indexes." }, "search_expression": { "type": "string", "description": "Add keywords to the search criteria." }, "job_titles_weight": { "type": "number", "description": "How important is this criteria to the matching score, range from 0 to 1." }, "years_experience_weight": { "type": "number", "description": "How important is this criteria to the matching score, range from 0 to 1." }, "locations_weight": { "type": "number", "description": "How important is this criteria to the matching score, range from 0 to 1." }, "languages_weight": { "type": "number", "description": "How important is this criteria to the matching score, range from 0 to 1." }, "skills_weight": { "type": "number", "description": "How important is this criteria to the matching score, range from 0 to 1." }, "education_weight": { "type": "number", "description": "How important is this criteria to the matching score, range from 0 to 1." }, "search_expression_weight": { "type": "number", "description": "How important is this criteria to the matching score, range from 0 to 1." }, "soc_codes_weight": { "type": "number", "description": "How important is this criteria to the matching score, range from 0 to 1." }, "management_level_weight": { "type": "number", "description": "How important is this criteria to the matching score, range from 0 to 1." } }, "required": [ "PCID", "resume", "job_description" ] } ``` *** ## affinda\_search\_get\_resume\_search\_suggestion\_job\_title Get job title suggestions based on provided job title(s) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `job_titles` | string\[] | Yes | — | Job title to query suggestions for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "job_titles": { "type": "array", "items": { "type": "string" }, "description": "Job title to query suggestions for" } }, "required": [ "PCID", "job_titles" ] } ``` *** ## affinda\_search\_get\_resume\_search\_suggestion\_skill Get skill suggestions based on provided skill(s) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `skills` | string\[] | Yes | — | Skill to query suggestions for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skills": { "type": "array", "items": { "type": "string" }, "description": "Skill to query suggestions for" } }, "required": [ "PCID", "skills" ] } ``` *** ## affinda\_search\_list\_occupation\_groups List occupation groups ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## affinda\_search\_re\_index\_document Re-index a document **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Index name | | `identifier` | string | Yes | — | Document identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Index name" }, "identifier": { "type": "string", "description": "Document identifier" } }, "required": [ "PCID", "name", "identifier" ] } ``` *** ## affinda\_search\_update\_document\_data Update a document's data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Resume or Job Description identifier | | `body` | object | Yes | — | Resume data to update | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Resume or Job Description identifier" }, "body": { "description": "Resume data to update" } }, "required": [ "PCID", "identifier", "body" ] } ``` *** ## affinda\_search\_update\_job\_description\_search\_config Update the config for the logged in user's embeddable job description search tool **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `actions` | object\[] | No | — | A list of actions to show in the dropdown in the embedded search tool | | | `allowPdfDownload` | boolean | No | — | Allow Pdf Download | | | `customFieldsConfig` | object\[] | No | — | Custom Fields Config | | | `displayEducation` | boolean | No | — | Display Education | | | `displayJobTitle` | boolean | No | — | Display Job Title | | | `displayKeywords` | boolean | No | — | Display Keywords | | | `displayLanguages` | boolean | No | — | Display Languages | | | `displayLocation` | boolean | No | — | Display Location | | | `displayManagementLevel` | boolean | No | — | Display Management Level | | | `displayOccupationGroup` | boolean | No | — | Display Occupation Group | | | `displaySkills` | boolean | No | — | Display Skills | | | `displayYearsExperience` | boolean | No | — | Display Years Experience | | | `distanceUnit` | string | No | — | The unit of distance to use for location based searches | | | `hideSidePanel` | boolean | No | — | Hide the entire side panel. | | | `hideToolbar` | boolean | No | — | Hide the reset/import toolbar. | | | `indices` | string\[] | No | — | List of index names. | | | `maxResults` | integer | null | No | — | Maximum number of results that can be returned. Setting to "null" means no limitation. | | `searchToolTheme` | object | No | — | Customize the theme of the embeded search tool. | | | `showIndexDropdown` | boolean | null | No | — | Controls whether or not the index dropdown is displayed to the user | | `userId` | integer | No | — | ID of the logged in user. | | | `username` | string | No | — | Username of the logged in user. | | | `weightEducation` | number | No | — | Weight Education | | | `weightJobTitle` | number | No | — | Weight Job Title | | | `weightKeywords` | number | No | — | Weight Keywords | | | `weightLanguages` | number | No | — | Weight Languages | | | `weightLocation` | number | No | — | Weight Location | | | `weightManagementLevel` | number | No | — | Weight Management Level | | | `weightOccupationGroup` | number | No | — | Weight Occupation Group | | | `weightSkills` | number | No | — | Weight Skills | | | `weightYearsExperience` | number | No | — | Weight Years Experience | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "Human readable label to display in the UI" }, "eventName": { "type": "string", "description": "Name of the event to be triggered" } }, "required": [ "label", "eventName" ] }, "description": "A list of actions to show in the dropdown in the embedded search tool" }, "allowPdfDownload": { "type": "boolean", "description": "Allow Pdf Download" }, "customFieldsConfig": { "type": "array", "items": { "type": "object", "properties": { "dataPoint": { "type": "string", "description": "Data point identifier." }, "weight": { "type": "number", "description": "The weight value" } }, "required": [ "dataPoint", "weight" ] }, "description": "Custom Fields Config" }, "displayEducation": { "type": "boolean", "description": "Display Education" }, "displayJobTitle": { "type": "boolean", "description": "Display Job Title" }, "displayKeywords": { "type": "boolean", "description": "Display Keywords" }, "displayLanguages": { "type": "boolean", "description": "Display Languages" }, "displayLocation": { "type": "boolean", "description": "Display Location" }, "displayManagementLevel": { "type": "boolean", "description": "Display Management Level" }, "displayOccupationGroup": { "type": "boolean", "description": "Display Occupation Group" }, "displaySkills": { "type": "boolean", "description": "Display Skills" }, "displayYearsExperience": { "type": "boolean", "description": "Display Years Experience" }, "distanceUnit": { "type": "string", "description": "The unit of distance to use for location based searches", "enum": [ "mi", "km" ] }, "hideSidePanel": { "type": "boolean", "description": "Hide the entire side panel." }, "hideToolbar": { "type": "boolean", "description": "Hide the reset/import toolbar." }, "indices": { "type": "array", "items": { "type": "string" }, "description": "List of index names." }, "maxResults": { "type": [ "integer", "null" ], "description": "Maximum number of results that can be returned. Setting to \"null\" means no limitation." }, "searchToolTheme": { "type": "object", "description": "Customize the theme of the embeded search tool." }, "showIndexDropdown": { "type": [ "boolean", "null" ], "description": "Controls whether or not the index dropdown is displayed to the user" }, "userId": { "type": "integer", "description": "ID of the logged in user." }, "username": { "type": "string", "description": "Username of the logged in user." }, "weightEducation": { "type": "number", "description": "Weight Education" }, "weightJobTitle": { "type": "number", "description": "Weight Job Title" }, "weightKeywords": { "type": "number", "description": "Weight Keywords" }, "weightLanguages": { "type": "number", "description": "Weight Languages" }, "weightLocation": { "type": "number", "description": "Weight Location" }, "weightManagementLevel": { "type": "number", "description": "Weight Management Level" }, "weightOccupationGroup": { "type": "number", "description": "Weight Occupation Group" }, "weightSkills": { "type": "number", "description": "Weight Skills" }, "weightYearsExperience": { "type": "number", "description": "Weight Years Experience" } }, "required": [ "PCID" ] } ``` *** ## affinda\_search\_update\_resume\_search\_config Update the config for the logged in user's embeddable resume search tool **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `actions` | object\[] | No | — | A list of actions to show in the dropdown in the embedded search tool | | | `allowPdfDownload` | boolean | No | — | Allow Pdf Download | | | `customFieldsConfig` | object\[] | No | — | Custom Fields Config | | | `displayEducation` | boolean | No | — | Display Education | | | `displayJobTitle` | boolean | No | — | Display Job Title | | | `displayKeywords` | boolean | No | — | Display Keywords | | | `displayLanguages` | boolean | No | — | Display Languages | | | `displayLocation` | boolean | No | — | Display Location | | | `displayManagementLevel` | boolean | No | — | Display Management Level | | | `displayOccupationGroup` | boolean | No | — | Display Occupation Group | | | `displaySkills` | boolean | No | — | Display Skills | | | `displayYearsExperience` | boolean | No | — | Display Years Experience | | | `distanceUnit` | string | No | — | The unit of distance to use for location based searches | | | `hideSidePanel` | boolean | No | — | Hide the entire side panel. | | | `hideToolbar` | boolean | No | — | Hide the reset/import toolbar. | | | `indices` | string\[] | No | — | List of index names. | | | `maxResults` | integer | null | No | — | Maximum number of results that can be returned. Setting to "null" means no limitation. | | `searchToolTheme` | object | No | — | Customize the theme of the embeded search tool. | | | `showIndexDropdown` | boolean | null | No | — | Controls whether or not the index dropdown is displayed to the user | | `userId` | integer | No | — | ID of the logged in user. | | | `username` | string | No | — | Username of the logged in user. | | | `weightEducation` | number | No | — | Weight Education | | | `weightJobTitle` | number | No | — | Weight Job Title | | | `weightKeywords` | number | No | — | Weight Keywords | | | `weightLanguages` | number | No | — | Weight Languages | | | `weightLocation` | number | No | — | Weight Location | | | `weightManagementLevel` | number | No | — | Weight Management Level | | | `weightOccupationGroup` | number | No | — | Weight Occupation Group | | | `weightSkills` | number | No | — | Weight Skills | | | `weightYearsExperience` | number | No | — | Weight Years Experience | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "Human readable label to display in the UI" }, "eventName": { "type": "string", "description": "Name of the event to be triggered" } }, "required": [ "label", "eventName" ] }, "description": "A list of actions to show in the dropdown in the embedded search tool" }, "allowPdfDownload": { "type": "boolean", "description": "Allow Pdf Download" }, "customFieldsConfig": { "type": "array", "items": { "type": "object", "properties": { "dataPoint": { "type": "string", "description": "Data point identifier." }, "weight": { "type": "number", "description": "The weight value" } }, "required": [ "dataPoint", "weight" ] }, "description": "Custom Fields Config" }, "displayEducation": { "type": "boolean", "description": "Display Education" }, "displayJobTitle": { "type": "boolean", "description": "Display Job Title" }, "displayKeywords": { "type": "boolean", "description": "Display Keywords" }, "displayLanguages": { "type": "boolean", "description": "Display Languages" }, "displayLocation": { "type": "boolean", "description": "Display Location" }, "displayManagementLevel": { "type": "boolean", "description": "Display Management Level" }, "displayOccupationGroup": { "type": "boolean", "description": "Display Occupation Group" }, "displaySkills": { "type": "boolean", "description": "Display Skills" }, "displayYearsExperience": { "type": "boolean", "description": "Display Years Experience" }, "distanceUnit": { "type": "string", "description": "The unit of distance to use for location based searches", "enum": [ "mi", "km" ] }, "hideSidePanel": { "type": "boolean", "description": "Hide the entire side panel." }, "hideToolbar": { "type": "boolean", "description": "Hide the reset/import toolbar." }, "indices": { "type": "array", "items": { "type": "string" }, "description": "List of index names." }, "maxResults": { "type": [ "integer", "null" ], "description": "Maximum number of results that can be returned. Setting to \"null\" means no limitation." }, "searchToolTheme": { "type": "object", "description": "Customize the theme of the embeded search tool." }, "showIndexDropdown": { "type": [ "boolean", "null" ], "description": "Controls whether or not the index dropdown is displayed to the user" }, "userId": { "type": "integer", "description": "ID of the logged in user." }, "username": { "type": "string", "description": "Username of the logged in user." }, "weightEducation": { "type": "number", "description": "Weight Education" }, "weightJobTitle": { "type": "number", "description": "Weight Job Title" }, "weightKeywords": { "type": "number", "description": "Weight Keywords" }, "weightLanguages": { "type": "number", "description": "Weight Languages" }, "weightLocation": { "type": "number", "description": "Weight Location" }, "weightManagementLevel": { "type": "number", "description": "Weight Management Level" }, "weightOccupationGroup": { "type": "number", "description": "Weight Occupation Group" }, "weightSkills": { "type": "number", "description": "Weight Skills" }, "weightYearsExperience": { "type": "number", "description": "Weight Years Experience" } }, "required": [ "PCID" ] } ``` # affinda-workspace Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/affinda/affinda-workspace Affinda Workspace - organizations, workspaces, data sources, tags, and webhooks **Server path:** `/affinda-workspace` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`affinda_workspace_add_mapping_data_source_value`](#affinda_workspace_add_mapping_data_source_value) | Add value for a data source | | [`affinda_workspace_batch_add_tag`](#affinda_workspace_batch_add_tag) | Add a tag to documents | | [`affinda_workspace_batch_remove_tag`](#affinda_workspace_batch_remove_tag) | Remove a tag from documents | | [`affinda_workspace_create_invitation`](#affinda_workspace_create_invitation) | Create a new invitation | | [`affinda_workspace_create_mapping_data_source`](#affinda_workspace_create_mapping_data_source) | Create a data source | | [`affinda_workspace_create_resthook_subscription`](#affinda_workspace_create_resthook_subscription) | Create a resthook subscription | | [`affinda_workspace_create_tag`](#affinda_workspace_create_tag) | Create a tag | | [`affinda_workspace_create_workspace`](#affinda_workspace_create_workspace) | Create a workspace | | [`affinda_workspace_create_workspace_membership`](#affinda_workspace_create_workspace_membership) | Create a workspace membership | | [`affinda_workspace_delete_invitation`](#affinda_workspace_delete_invitation) | Delete an invitation | | [`affinda_workspace_delete_mapping_data_source`](#affinda_workspace_delete_mapping_data_source) | Delete specific data source | | [`affinda_workspace_delete_mapping_data_source_value`](#affinda_workspace_delete_mapping_data_source_value) | Delete specific data source value | | [`affinda_workspace_delete_membership`](#affinda_workspace_delete_membership) | Delete a workspace membership | | [`affinda_workspace_delete_resthook_subscription`](#affinda_workspace_delete_resthook_subscription) | Delete a resthook subscription | | [`affinda_workspace_delete_tag`](#affinda_workspace_delete_tag) | Delete an tag | | [`affinda_workspace_delete_workspace`](#affinda_workspace_delete_workspace) | Delete a workspace | | [`affinda_workspace_get_all_invitations`](#affinda_workspace_get_all_invitations) | Get list of all invitations | | [`affinda_workspace_get_all_organizations`](#affinda_workspace_get_all_organizations) | Get list of all organizations | | [`affinda_workspace_get_all_resthook_subscriptions`](#affinda_workspace_get_all_resthook_subscriptions) | Get list of all resthook subscriptions | | [`affinda_workspace_get_all_tags`](#affinda_workspace_get_all_tags) | Get list of all tags | | [`affinda_workspace_get_all_workspace_memberships`](#affinda_workspace_get_all_workspace_memberships) | Get list of all workspace memberships | | [`affinda_workspace_get_all_workspaces`](#affinda_workspace_get_all_workspaces) | Get list of all workspaces | | [`affinda_workspace_get_invitation`](#affinda_workspace_get_invitation) | Get detail of an invitation | | [`affinda_workspace_get_invitation_by_token`](#affinda_workspace_get_invitation_by_token) | Get detail of an invitation by token | | [`affinda_workspace_get_mapping_data_source`](#affinda_workspace_get_mapping_data_source) | Get specific data source | | [`affinda_workspace_get_mapping_data_source_value`](#affinda_workspace_get_mapping_data_source_value) | Get specific data source value | | [`affinda_workspace_get_membership`](#affinda_workspace_get_membership) | Get specific workspace membership | | [`affinda_workspace_get_organization`](#affinda_workspace_get_organization) | Get detail of an organization | | [`affinda_workspace_get_resthook_subscription`](#affinda_workspace_get_resthook_subscription) | Get specific resthook subscription | | [`affinda_workspace_get_tag`](#affinda_workspace_get_tag) | Get specific tag | | [`affinda_workspace_get_usage`](#affinda_workspace_get_usage) | Get usage | | [`affinda_workspace_get_usage_by_workspace`](#affinda_workspace_get_usage_by_workspace) | Get usage by workspace | | [`affinda_workspace_get_workspace`](#affinda_workspace_get_workspace) | Get specific workspace | | [`affinda_workspace_list_mapping_data_source_values`](#affinda_workspace_list_mapping_data_source_values) | List values for a data source | | [`affinda_workspace_list_mapping_data_sources`](#affinda_workspace_list_mapping_data_sources) | List data sources | | [`affinda_workspace_replace_mapping_data_source_values`](#affinda_workspace_replace_mapping_data_source_values) | Replace values for a data source | | [`affinda_workspace_respond_to_invitation`](#affinda_workspace_respond_to_invitation) | Respond to an invitation | | [`affinda_workspace_update_invitation`](#affinda_workspace_update_invitation) | Update an invitation | | [`affinda_workspace_update_mapping_data_source_value`](#affinda_workspace_update_mapping_data_source_value) | Update specific data source value | | [`affinda_workspace_update_resthook_subscription`](#affinda_workspace_update_resthook_subscription) | Update a resthook subscription | | [`affinda_workspace_update_tag`](#affinda_workspace_update_tag) | Update a tag | | [`affinda_workspace_update_workspace`](#affinda_workspace_update_workspace) | Update a workspace | | [`affinda-workspace_get_all_resthook_results`](#affinda-workspace_get_all_resthook_results) | Get list of webhook delivery results for a document | | [`affinda-workspace_resend_resthook_results`](#affinda-workspace_resend_resthook_results) | Re-trigger webhooks for a document | *** ## affinda\_workspace\_add\_mapping\_data\_source\_value Add value for a data source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Data source's identifier | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Data source's identifier" }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "identifier", "body" ] } ``` *** ## affinda\_workspace\_batch\_add\_tag Add a tag to documents **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifiers` | string\[] | No | — | List of documents to tag | | `tag` | integer | No | — | The tag's ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifiers": { "type": "array", "items": { "type": "string" }, "description": "List of documents to tag" }, "tag": { "type": "integer", "description": "The tag's ID" } }, "required": [ "PCID" ] } ``` *** ## affinda\_workspace\_batch\_remove\_tag Remove a tag from documents **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifiers` | string\[] | No | — | List of documents to remove tag from | | `tag` | integer | No | — | The tag's ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifiers": { "type": "array", "items": { "type": "string" }, "description": "List of documents to remove tag from" }, "tag": { "type": "integer", "description": "The tag's ID" } }, "required": [ "PCID" ] } ``` *** ## affinda\_workspace\_create\_invitation Create a new invitation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `email` | string | Yes | — | The email which the invitation is sent to. | | `organization` | string | Yes | — | Uniquely identify an organization. | | `role` | string | Yes | — | The role value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email": { "type": "string", "description": "The email which the invitation is sent to." }, "organization": { "type": "string", "description": "Uniquely identify an organization." }, "role": { "type": "string", "description": "The role value", "enum": [ "admin", "member" ] } }, "required": [ "PCID", "email", "organization", "role" ] } ``` *** ## affinda\_workspace\_create\_mapping\_data\_source Create a data source **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `displayProperty` | string | No | — | Attribute in the schema which is used to display the value | | | `keyProperty` | string | No | — | Attribute in the schema which uniquely identifiers the value | | | `name` | string | null | No | — | The name value | | `organization` | string | null | No | — | The organization that this mapping data source belongs to. | | `schema` | object | No | — | The schema of the mapping data source. | | | `values` | object\[] | No | — | The values value | | | `workspace` | string | null | No | — | The workspace that this mapping data source belongs to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "displayProperty": { "type": "string", "description": "Attribute in the schema which is used to display the value" }, "keyProperty": { "type": "string", "description": "Attribute in the schema which uniquely identifiers the value" }, "name": { "type": [ "string", "null" ], "description": "The name value" }, "organization": { "type": [ "string", "null" ], "description": "The organization that this mapping data source belongs to." }, "schema": { "type": "object", "description": "The schema of the mapping data source." }, "values": { "type": "array", "items": { "type": "object" }, "description": "The values value" }, "workspace": { "type": [ "string", "null" ], "description": "The workspace that this mapping data source belongs to." } }, "required": [ "PCID" ] } ``` *** ## affinda\_workspace\_create\_resthook\_subscription Create a resthook subscription **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `event` | string | Yes | — | The event name to subscribe to. | | `organization` | string | No | — | The organization value | | `targetUrl` | string | Yes | — | URL of the resthook's receiver. | | `version` | string | No | — | Version of the resthook subscription. Determines the resthook body being fired. | | `workspace` | string | No | — | The workspace value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "event": { "type": "string", "description": "The event name to subscribe to.", "enum": [ "resume.parse.succeeded", "resume.parse.failed", "resume.parse.completed", "invoice.parse.succeeded", "invoice.parse.failed", "invoice.parse.completed", "invoice.validate.completed", "document.parse.succeeded", "document.parse.failed", "document.parse.completed", "document.validate.completed", "document.classify.succeeded", "document.classify.failed", "document.classify.completed", "document.rejected", "annotation.validated" ] }, "organization": { "type": "string", "description": "The organization value" }, "targetUrl": { "type": "string", "description": "URL of the resthook's receiver." }, "version": { "type": "string", "description": "Version of the resthook subscription. Determines the resthook body being fired.", "enum": [ "v1", "v2", "v3" ] }, "workspace": { "type": "string", "description": "The workspace value" } }, "required": [ "PCID", "event", "targetUrl" ] } ``` *** ## affinda\_workspace\_create\_tag Create a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | The name value | | `workspace` | string | Yes | — | Uniquely identify a workspace. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name value" }, "workspace": { "type": "string", "description": "Uniquely identify a workspace." } }, "required": [ "PCID", "name", "workspace" ] } ``` *** ## affinda\_workspace\_create\_workspace Create a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `documentSplitter` | string | No | — | Uniquely identify a document splitter. | | | `documentTypes` | string\[] | No | — | Document types to associate with this workspace | | | `name` | string | Yes | — | The name value | | | `organization` | string | Yes | — | Uniquely identify an organization. | | | `rejectDuplicates` | boolean | null | No | — | If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings. | | `rejectInvalidDocuments` | boolean | No | — | If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed. | | | `visibility` | string | No | — | Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the workspace. | | | `whitelistIngestAddresses` | string\[] | No | — | If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. "\*@eyefind.info". | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentSplitter": { "type": "string", "description": "Uniquely identify a document splitter." }, "documentTypes": { "type": "array", "items": { "type": "string" }, "description": "Document types to associate with this workspace" }, "name": { "type": "string", "description": "The name value" }, "organization": { "type": "string", "description": "Uniquely identify an organization." }, "rejectDuplicates": { "type": [ "boolean", "null" ], "description": "If \"true\", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If \"false\", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings." }, "rejectInvalidDocuments": { "type": "boolean", "description": "If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed." }, "visibility": { "type": "string", "description": "Visibility \"organization\" means everyone in the organization can access the workspace. Visibility \"private\" means only people explicitly added can access the workspace.", "enum": [ "organization", "private" ] }, "whitelistIngestAddresses": { "type": "array", "items": { "type": "string" }, "description": "If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. \"*@eyefind.info\"." } }, "required": [ "PCID", "name", "organization" ] } ``` *** ## affinda\_workspace\_create\_workspace\_membership Create a workspace membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user` | integer | No | — | Uniquely identify a user. | | `workspace` | string | No | — | Uniquely identify a workspace. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "user": { "type": "integer", "description": "Uniquely identify a user." }, "workspace": { "type": "string", "description": "Uniquely identify a workspace." } }, "required": [ "PCID" ] } ``` *** ## affinda\_workspace\_delete\_invitation Delete an invitation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Invitation identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Invitation identifier." } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_delete\_mapping\_data\_source Delete specific data source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Data source's identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Data source's identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_delete\_mapping\_data\_source\_value Delete specific data source value **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Data source's identifier | | `value` | string | Yes | — | Data Source Value's value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Data source's identifier" }, "value": { "type": "string", "description": "Data Source Value's value" } }, "required": [ "PCID", "identifier", "value" ] } ``` *** ## affinda\_workspace\_delete\_membership Delete a workspace membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Workspace membership's identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Workspace membership's identifier." } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_delete\_resthook\_subscription Delete a resthook subscription **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | ResthookSubscription's ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ResthookSubscription's ID" } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_workspace\_delete\_tag Delete an tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Tag's ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Tag's ID" } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_workspace\_delete\_workspace Delete a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Workspace's identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Workspace's identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_get\_all\_invitations Get list of all invitations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `limit` | integer | No | — | The numbers of results to return. | | `organization` | string | No | — | Filter by organization. | | `status` | string | No | — | Filter by status. | | `role` | string | No | — | Filter by role. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "organization": { "type": "string", "description": "Filter by organization." }, "status": { "type": "string", "description": "Filter by status.", "enum": [ "pending", "accepted", "declined" ] }, "role": { "type": "string", "description": "Filter by role.", "enum": [ "admin", "member" ] } }, "required": [ "PCID" ] } ``` *** ## affinda\_workspace\_get\_all\_organizations Get list of all organizations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## affinda\_workspace\_get\_all\_resthook\_subscriptions Get list of all resthook subscriptions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `limit` | integer | No | — | The numbers of results to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." } }, "required": [ "PCID" ] } ``` *** ## affinda\_workspace\_get\_all\_tags Get list of all tags **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | The numbers of results to return. | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `workspace` | string | No | — | Filter by workspace. | | `name` | string | No | — | Filter by name. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "workspace": { "type": "string", "description": "Filter by workspace." }, "name": { "type": "string", "description": "Filter by name." } }, "required": [ "PCID" ] } ``` *** ## affinda\_workspace\_get\_all\_workspace\_memberships Get list of all workspace memberships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `limit` | integer | No | — | The numbers of results to return. | | `workspace` | string | No | — | Filter by workspace. | | `user` | string | No | — | Partial text match on user's email, case-insensitive. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "workspace": { "type": "string", "description": "Filter by workspace." }, "user": { "type": "string", "description": "Partial text match on user's email, case-insensitive." } }, "required": [ "PCID" ] } ``` *** ## affinda\_workspace\_get\_all\_workspaces Get list of all workspaces **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `organization` | string | Yes | — | Filter by organization. | | `name` | string | No | — | Filter by name. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization": { "type": "string", "description": "Filter by organization." }, "name": { "type": "string", "description": "Filter by name." } }, "required": [ "PCID", "organization" ] } ``` *** ## affinda\_workspace\_get\_invitation Get detail of an invitation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Invitation identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Invitation identifier." } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_get\_invitation\_by\_token Get detail of an invitation by token **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `token` | string | Yes | — | Invitation token. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "token": { "type": "string", "description": "Invitation token." } }, "required": [ "PCID", "token" ] } ``` *** ## affinda\_workspace\_get\_mapping\_data\_source Get specific data source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Data source's identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Data source's identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_get\_mapping\_data\_source\_value Get specific data source value **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Data source's identifier | | `value` | string | Yes | — | Data Source Value's value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Data source's identifier" }, "value": { "type": "string", "description": "Data Source Value's value" } }, "required": [ "PCID", "identifier", "value" ] } ``` *** ## affinda\_workspace\_get\_membership Get specific workspace membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Workspace membership's identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Workspace membership's identifier." } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_get\_organization Get detail of an organization **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Organization identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Organization identifier." } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_get\_resthook\_subscription Get specific resthook subscription **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Resthook subscription's ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Resthook subscription's ID" } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_workspace\_get\_tag Get specific tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Tag's ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Tag's ID" } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_workspace\_get\_usage Get usage **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `organization` | string | Yes | — | Organization to report usage for. The caller must be an admin or owner. | | `workspace` | string | No | — | Optionally scope the report to a single workspace within the organization. | | `document_type` | string | No | — | Optionally scope the report to a single document type within the organization. | | `start` | string | No | — | Inclusive start date of the report (YYYY-MM-DD). Defaults to 365 days before `end`. | | `end` | string | No | — | Inclusive end date of the report (YYYY-MM-DD). Defaults to today. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization": { "type": "string", "description": "Organization to report usage for. The caller must be an admin or owner." }, "workspace": { "type": "string", "description": "Optionally scope the report to a single workspace within the organization." }, "document_type": { "type": "string", "description": "Optionally scope the report to a single document type within the organization." }, "start": { "type": "string", "description": "Inclusive start date of the report (YYYY-MM-DD). Defaults to 365 days before `end`." }, "end": { "type": "string", "description": "Inclusive end date of the report (YYYY-MM-DD). Defaults to today." } }, "required": [ "PCID", "organization" ] } ``` *** ## affinda\_workspace\_get\_usage\_by\_workspace Get usage by workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Workspace's identifier | | `start` | string | No | — | Start date of the period to retrieve. Format: YYYY-MM | | `end` | string | No | — | End date of the period to retrieve. Format: YYYY-MM | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Workspace's identifier" }, "start": { "type": "string", "description": "Start date of the period to retrieve. Format: YYYY-MM" }, "end": { "type": "string", "description": "End date of the period to retrieve. Format: YYYY-MM" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_get\_workspace Get specific workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Workspace's identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Workspace's identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_list\_mapping\_data\_source\_values List values for a data source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | The numbers of results to return. | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `search` | string | No | — | Search for specific values | | `annotation` | integer | No | — | Filter based on annotation ID | | `document` | string | No | — | Identifier of the document to apply filter lookups on if available | | `identifier` | string | Yes | — | Data source's identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "search": { "type": "string", "description": "Search for specific values" }, "annotation": { "type": "integer", "description": "Filter based on annotation ID" }, "document": { "type": "string", "description": "Identifier of the document to apply filter lookups on if available" }, "identifier": { "type": "string", "description": "Data source's identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_list\_mapping\_data\_sources List data sources **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `limit` | integer | No | — | The numbers of results to return. | | `name` | string | No | — | Filter by name. | | `organization` | string | No | — | Filter by organization. | | `workspace` | string | No | — | Filter by workspace. | | `identifier` | string | No | — | Filter by identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "name": { "type": "string", "description": "Filter by name." }, "organization": { "type": "string", "description": "Filter by organization." }, "workspace": { "type": "string", "description": "Filter by workspace." }, "identifier": { "type": "string", "description": "Filter by identifier." } }, "required": [ "PCID" ] } ``` *** ## affinda\_workspace\_replace\_mapping\_data\_source\_values Replace values for a data source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Data source's identifier | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Data source's identifier" }, "body": { "type": "array", "items": { "type": "object" }, "description": "Request body" } }, "required": [ "PCID", "identifier", "body" ] } ``` *** ## affinda\_workspace\_respond\_to\_invitation Respond to an invitation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `token` | string | Yes | — | Invitation token. | | `status` | string | No | — | The status value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "token": { "type": "string", "description": "Invitation token." }, "status": { "type": "string", "description": "The status value", "enum": [ "accepted", "declined" ] } }, "required": [ "PCID", "token" ] } ``` *** ## affinda\_workspace\_update\_invitation Update an invitation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Invitation identifier. | | `role` | string | No | — | The role value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Invitation identifier." }, "role": { "type": "string", "description": "The role value", "enum": [ "admin", "member" ] } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda\_workspace\_update\_mapping\_data\_source\_value Update specific data source value **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Data source's identifier | | `value` | string | Yes | — | Data Source's value | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Data source's identifier" }, "value": { "type": "string", "description": "Data Source's value" }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "identifier", "value", "body" ] } ``` *** ## affinda\_workspace\_update\_resthook\_subscription Update a resthook subscription **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | ResthookSubscription's ID | | `event` | string | No | — | The event name to subscribe to. | | `organization` | string | No | — | Uniquely identify an organization. | | `version` | string | No | — | Version of the resthook subscription. Determines the resthook body being fired. | | `workspace` | string | No | — | Uniquely identify a workspace. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ResthookSubscription's ID" }, "event": { "type": "string", "description": "The event name to subscribe to.", "enum": [ "resume.parse.succeeded", "resume.parse.failed", "resume.parse.completed", "invoice.parse.succeeded", "invoice.parse.failed", "invoice.parse.completed", "invoice.validate.completed", "document.parse.succeeded", "document.parse.failed", "document.parse.completed", "document.validate.completed", "document.classify.succeeded", "document.classify.failed", "document.classify.completed", "document.rejected", "annotation.validated" ] }, "organization": { "type": "string", "description": "Uniquely identify an organization." }, "version": { "type": "string", "description": "Version of the resthook subscription. Determines the resthook body being fired.", "enum": [ "v1", "v2", "v3" ] }, "workspace": { "type": "string", "description": "Uniquely identify a workspace." } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_workspace\_update\_tag Update a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Tag's ID | | `name` | string | No | — | The name value | | `workspace` | string | No | — | Uniquely identify a workspace. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Tag's ID" }, "name": { "type": "string", "description": "The name value" }, "workspace": { "type": "string", "description": "Uniquely identify a workspace." } }, "required": [ "PCID", "id" ] } ``` *** ## affinda\_workspace\_update\_workspace Update a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `identifier` | string | Yes | — | Workspace's identifier | | | `documentSplitter` | string | No | — | Uniquely identify a document splitter. | | | `documentTypes` | string\[] | No | — | Document types to associate with this workspace | | | `name` | string | No | — | The name value | | | `rejectDuplicates` | boolean | null | No | — | If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings. | | `rejectInvalidDocuments` | boolean | No | — | If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed. | | | `visibility` | string | No | — | Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the workspace. | | | `whitelistIngestAddresses` | string\[] | No | — | If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. "\*@eyefind.info". | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "Workspace's identifier" }, "documentSplitter": { "type": "string", "description": "Uniquely identify a document splitter." }, "documentTypes": { "type": "array", "items": { "type": "string" }, "description": "Document types to associate with this workspace" }, "name": { "type": "string", "description": "The name value" }, "rejectDuplicates": { "type": [ "boolean", "null" ], "description": "If \"true\", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If \"false\", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings." }, "rejectInvalidDocuments": { "type": "boolean", "description": "If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed." }, "visibility": { "type": "string", "description": "Visibility \"organization\" means everyone in the organization can access the workspace. Visibility \"private\" means only people explicitly added can access the workspace.", "enum": [ "organization", "private" ] }, "whitelistIngestAddresses": { "type": "array", "items": { "type": "string" }, "description": "If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. \"*@eyefind.info\"." } }, "required": [ "PCID", "identifier" ] } ``` *** ## affinda-workspace\_get\_all\_resthook\_results Get list of webhook delivery results for a document **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of documents to skip before starting to collect the result set. | | `limit` | integer | No | — | The numbers of results to return. | | `document` | string | Yes | — | Identifier of the document to return webhook delivery results for. | | `event` | string | No | — | Filter results by event. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of documents to skip before starting to collect the result set." }, "limit": { "type": "integer", "description": "The numbers of results to return." }, "document": { "type": "string", "description": "Identifier of the document to return webhook delivery results for." }, "event": { "type": "string", "description": "Filter results by event.", "enum": [ "resume.parse.succeeded", "resume.parse.failed", "resume.parse.completed", "invoice.parse.succeeded", "invoice.parse.failed", "invoice.parse.completed", "invoice.validate.completed", "document.parse.succeeded", "document.parse.failed", "document.parse.completed", "document.validate.completed", "document.classify.succeeded", "document.classify.failed", "document.classify.completed", "document.rejected", "annotation.validated" ] } }, "required": [ "PCID", "document" ] } ``` *** ## affinda-workspace\_resend\_resthook\_results Re-trigger webhooks for a document **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `document` | string | Yes | — | Identifier of the document to replay the event for. | | `event` | string | Yes | — | The event name to subscribe to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "document": { "type": "string", "description": "Identifier of the document to replay the event for." }, "event": { "type": "string", "description": "The event name to subscribe to.", "enum": [ "resume.parse.succeeded", "resume.parse.failed", "resume.parse.completed", "invoice.parse.succeeded", "invoice.parse.failed", "invoice.parse.completed", "invoice.validate.completed", "document.parse.succeeded", "document.parse.failed", "document.parse.completed", "document.validate.completed", "document.classify.succeeded", "document.classify.failed", "document.classify.completed", "document.rejected", "annotation.validated" ] } }, "required": [ "PCID", "document", "event" ] } ``` # Ahrefs Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/ahrefs Ahrefs official MCP server. Site Explorer, Keywords Explorer, SERP Overview, Rank Tracker, Site Audit, and Brand Radar. Tools are discovered at runtime using an existing connection. **Server path:** `/ahrefs` | **Type:** Application (Remote MCP) | **PCID required:** Yes Tools are discovered at runtime from the upstream MCP server at `https://api.ahrefs.com/mcp/mcp`. Authenticate via `apikey`. Use a `ahrefs` PinkConnect connection. # airtable Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/airtable Bases, tables, and records **Server path:** `/airtable` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`airtable_add_base_collaborator`](#airtable_add_base_collaborator) | Add base collaborator | | [`airtable_add_interface_collaborator`](#airtable_add_interface_collaborator) | Add interface collaborator | | [`airtable_add_workspace_collaborator`](#airtable_add_workspace_collaborator) | Add workspace collaborator | | [`airtable_audit_log_events`](#airtable_audit_log_events) | Audit log events | | [`airtable_change_events`](#airtable_change_events) | Change events | | [`airtable_create_a_webhook`](#airtable_create_a_webhook) | Create a webhook | | [`airtable_create_audit_log_request`](#airtable_create_audit_log_request) | Create audit log request | | [`airtable_create_base`](#airtable_create_base) | Create base | | [`airtable_create_base_from_package_enterprise`](#airtable_create_base_from_package_enterprise) | Create base from package | | [`airtable_create_comment`](#airtable_create_comment) | Create comment | | [`airtable_create_descendant_enterprise`](#airtable_create_descendant_enterprise) | Create descendant enterprise | | [`airtable_create_ediscovery_export`](#airtable_create_ediscovery_export) | Create eDiscovery export | | [`airtable_create_field`](#airtable_create_field) | Create field | | [`airtable_create_records`](#airtable_create_records) | Create records | | [`airtable_create_table`](#airtable_create_table) | Create table | | [`airtable_create_workspace`](#airtable_create_workspace) | Create workspace | | [`airtable_delete_a_webhook`](#airtable_delete_a_webhook) | Delete a webhook | | [`airtable_delete_base`](#airtable_delete_base) | Delete base | | [`airtable_delete_base_collaborator`](#airtable_delete_base_collaborator) | Delete base collaborator | | [`airtable_delete_base_invite`](#airtable_delete_base_invite) | Delete base invite | | [`airtable_delete_block_installation`](#airtable_delete_block_installation) | Delete block installation | | [`airtable_delete_comment`](#airtable_delete_comment) | Delete comment | | [`airtable_delete_interface_collaborator`](#airtable_delete_interface_collaborator) | Delete interface collaborator | | [`airtable_delete_interface_invite`](#airtable_delete_interface_invite) | Delete interface invite | | [`airtable_delete_multiple_records`](#airtable_delete_multiple_records) | Delete multiple records | | [`airtable_delete_record`](#airtable_delete_record) | Delete record | | [`airtable_delete_share`](#airtable_delete_share) | Delete share | | [`airtable_delete_user_by_id`](#airtable_delete_user_by_id) | Delete user by id | | [`airtable_delete_users_by_email`](#airtable_delete_users_by_email) | Delete users by email | | [`airtable_delete_view`](#airtable_delete_view) | Delete view | | [`airtable_delete_workspace`](#airtable_delete_workspace) | Delete workspace | | [`airtable_delete_workspace_collaborator`](#airtable_delete_workspace_collaborator) | Delete workspace collaborator | | [`airtable_delete_workspace_invite`](#airtable_delete_workspace_invite) | Delete workspace invite | | [`airtable_enable_disable_webhook_notifications`](#airtable_enable_disable_webhook_notifications) | Enable/disable webhook notifications | | [`airtable_get_audit_log_request`](#airtable_get_audit_log_request) | Get audit log request | | [`airtable_get_base_collaborators`](#airtable_get_base_collaborators) | Get base collaborators | | [`airtable_get_base_schema`](#airtable_get_base_schema) | Get base schema | | [`airtable_get_ediscovery_export`](#airtable_get_ediscovery_export) | Get eDiscovery export | | [`airtable_get_enterprise`](#airtable_get_enterprise) | Get enterprise | | [`airtable_get_interface`](#airtable_get_interface) | Get interface | | [`airtable_get_record`](#airtable_get_record) | Get record | | [`airtable_get_user_by_id`](#airtable_get_user_by_id) | Get user by id | | [`airtable_get_user_group`](#airtable_get_user_group) | Get user group | | [`airtable_get_user_id_scopes`](#airtable_get_user_id_scopes) | Get user info | | [`airtable_get_users_by_id_or_email`](#airtable_get_users_by_id_or_email) | Get users by id or email | | [`airtable_get_view_metadata`](#airtable_get_view_metadata) | Get view metadata | | [`airtable_get_workspace_collaborators`](#airtable_get_workspace_collaborators) | Get workspace collaborators | | [`airtable_grant_admin_access`](#airtable_grant_admin_access) | Grant admin access | | [`airtable_list_audit_log_requests`](#airtable_list_audit_log_requests) | List audit log requests | | [`airtable_list_bases`](#airtable_list_bases) | List bases | | [`airtable_list_block_installations`](#airtable_list_block_installations) | List block installations | | [`airtable_list_comments`](#airtable_list_comments) | List comments | | [`airtable_list_ediscovery_export`](#airtable_list_ediscovery_export) | List eDiscovery exports | | [`airtable_list_enterprise_packages`](#airtable_list_enterprise_packages) | List packages | | [`airtable_list_enterprise_personal_access_tokens`](#airtable_list_enterprise_personal_access_tokens) | List personal access tokens | | [`airtable_list_records`](#airtable_list_records) | List records | | [`airtable_list_shares`](#airtable_list_shares) | List shares | | [`airtable_list_views`](#airtable_list_views) | List views | | [`airtable_list_webhook_payloads`](#airtable_list_webhook_payloads) | List webhook payloads | | [`airtable_list_webhooks`](#airtable_list_webhooks) | List webhooks | | [`airtable_logout_user`](#airtable_logout_user) | Logout user | | [`airtable_manage_block_installation`](#airtable_manage_block_installation) | Manage block installation | | [`airtable_manage_share`](#airtable_manage_share) | Manage share | | [`airtable_manage_user`](#airtable_manage_user) | Manage user | | [`airtable_manage_user_batched`](#airtable_manage_user_batched) | Manage user batched | | [`airtable_manage_user_membership`](#airtable_manage_user_membership) | Manage user membership | | [`airtable_move_base`](#airtable_move_base) | Move base | | [`airtable_move_user_groups`](#airtable_move_user_groups) | Move user groups | | [`airtable_move_workspaces`](#airtable_move_workspaces) | Move workspaces | | [`airtable_post_sync_api_endpoint`](#airtable_post_sync_api_endpoint) | Sync CSV data | | [`airtable_refresh_a_webhook`](#airtable_refresh_a_webhook) | Refresh a webhook | | [`airtable_remove_user_from_enterprise`](#airtable_remove_user_from_enterprise) | Remove user from enterprise | | [`airtable_revoke_admin_access`](#airtable_revoke_admin_access) | Revoke admin access | | [`airtable_revoke_enterprise_personal_access_tokens`](#airtable_revoke_enterprise_personal_access_tokens) | Revoke personal access tokens | | [`airtable_update_collaborator_base_permission`](#airtable_update_collaborator_base_permission) | Update collaborator base permission | | [`airtable_update_comment`](#airtable_update_comment) | Update comment | | [`airtable_update_field`](#airtable_update_field) | Update field | | [`airtable_update_interface_collaborator`](#airtable_update_interface_collaborator) | Update interface collaborator | | [`airtable_update_multiple_records`](#airtable_update_multiple_records) | Update multiple records | | [`airtable_update_record`](#airtable_update_record) | Update record | | [`airtable_update_table`](#airtable_update_table) | Update table | | [`airtable_update_workspace_ai_allowlist`](#airtable_update_workspace_ai_allowlist) | Update workspace AI allowlist | | [`airtable_update_workspace_collaborator`](#airtable_update_workspace_collaborator) | Update workspace collaborator | | [`airtable_update_workspace_restrictions`](#airtable_update_workspace_restrictions) | Update workspace restrictions | *** ## airtable\_add\_base\_collaborator Add base collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `collaborators` | any\[] | Yes | — | This endpoint accepts two types of collaborators: **individual user** and **group**. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "collaborators": { "type": "array", "description": "This endpoint accepts two types of collaborators: **individual user** and **group**." } }, "required": [ "PCID", "baseId", "collaborators" ] } ``` *** ## airtable\_add\_interface\_collaborator Add interface collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `pageBundleId` | string | Yes | — | Page Bundle Id | | `collaborators` | any\[] | Yes | — | This endpoint accepts two types of collaborators: **individual user** and **group**. This route currently supports adding only one collaborator at a time. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "pageBundleId": { "type": "string", "description": "Page Bundle Id" }, "collaborators": { "type": "array", "description": "This endpoint accepts two types of collaborators: **individual user** and **group**. This route currently supports adding only one collaborator at a time." } }, "required": [ "PCID", "baseId", "pageBundleId", "collaborators" ] } ``` *** ## airtable\_add\_workspace\_collaborator Add workspace collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspaceId` | string | Yes | — | Workspace Id | | `collaborators` | any\[] | Yes | — | This endpoint accepts two types of collaborators: **individual user** and **group**. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "collaborators": { "type": "array", "description": "This endpoint accepts two types of collaborators: **individual user** and **group**." } }, "required": [ "PCID", "workspaceId", "collaborators" ] } ``` *** ## airtable\_audit\_log\_events Audit log events **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `startTime` | string | No | — | Earliest audit log event to retrieve (inclusive), in ISO 8601 date time format. Optional. Defaults to the beginning of the retention period, 180 days ago. | | `endTime` | string | No | — | Latest audit log event to retrieve (exclusive), in ISO 8601 date time format. Optional. Defaults to now. | | `originatingUserId` | string\[] | No | — | Retrieve audit log events originating from the provided user ID or IDs (maximum 100). Optional. | | `eventType` | string\[] | No | — | Retrieve audit log events falling under the provided event type or event types (maximum 100). Optional. | | `modelId` | string\[] | No | — | Retrieve audit log events taking action on, or involving, the provided model ID or IDs (maximum 100). Optional. | | `pageSize` | number | No | — | The number of events per page. Maximum value of 1000; defaults to 10. | | `sortOrder` | string | No | — | Sort the events by timestamp in ascending or descending order. Defaults to descending. | | `previous` | string | No | — | If there are older items to retrieve, a **previous** is returned. Pass the **previous** from a prior call to retrieve the next-oldest page of items. You may pass the special value `null` to indicate "use the default behavior", which operates identically to omitting the **previous** parameter entirely. | | `next` | string | No | — | If there are newer items to retrieve, a **next** is returned. Pass the **next** from a prior call to retrieve the next-newest page of items. You may pass the special value `null` to indicate "use the default behavior", which operates identically to omitting the **next** parameter entirely. | | `category` | string\[] | No | — | The category value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "startTime": { "type": "string", "description": "Earliest audit log event to retrieve (inclusive), in ISO 8601 date time format. Optional. Defaults to the beginning of the retention period, 180 days ago." }, "endTime": { "type": "string", "description": "Latest audit log event to retrieve (exclusive), in ISO 8601 date time format. Optional. Defaults to now." }, "originatingUserId": { "type": "array", "items": { "type": "string" }, "description": "Retrieve audit log events originating from the provided user ID or IDs (maximum 100). Optional." }, "eventType": { "type": "array", "items": { "type": "string", "enum": [ "createBase", "deleteBase", "moveBase", "duplicateBase", "viewBase", "updateBaseName", "updateBaseGuideText", "restoreBaseFromSnapshot", "restoreBaseFromTrash", "applyChangesFromSandbox", "enableShare", "disableShare", "configureShare", "regenerateShare", "viewShare", "downloadAttachment", "addBaseInviteLink", "removeBaseInviteLink", "configureBaseInviteLink", "changeBaseAiPermissions", "createSandboxBase", "inviteBaseCollaborator", "addBaseCollaborator", "changeBaseInvitePermission", "changeBaseCollaboratorPermission", "removeBaseCollaborator", "uninviteBaseCollaborator", "resendBaseInvite", "createCustomDomain", "deleteCustomDomain", "createGroup", "deleteGroup", "moveGroup", "addGroupMember", "changeGroupMemberRole", "removeGroupMember", "deleteGroupInvite", "resendGroupInvite", "inviteGroupMember", "createRole", "loginUser", "claimUser", "unclaimUser", "createUser", "deleteUser", "provisionUser", "deactivateUser", "updateUserEmail", "changePassword", "updateUserProfilePicture", "userAssignedLicense", "userAssignedGridGlobalLicense", "createServiceAccount", "deleteServiceAccount", "moveServiceAccount", "acceptTermsOfUse", "linkSsoIdentity", "updateSsoIdentity", "createSsoExternalUser", "addTwoFactorAuthenticationStrategy", "removeTwoFactorAuthenticationStrategy", "regenerateTwoFactorAuthenticationBackupCodes", "setDefaultTwoFactorAuthenticationStrategy", "disableTwoFactorAuthentication", "createOauthAccessToken", "refreshOauthAccessToken", "createSyncIntegrationSource", "renameSyncIntegrationSource", "reconnectSyncIntegrationSource", "deleteSyncIntegrationSource", "connectSyncIntegrationToTable", "changeSyncIntegrationTableSource", "disconnectSyncIntegrationFromTable", "createPersonalAccessToken", "grantEnterpriseAdminAccess", "revokeEnterpriseAdminAccess", "grantEnterpriseUpgraderAccess", "revokeEnterpriseUpgraderAccess", "updateEnterpriseName", "deleteEnterpriseStripeCard", "updateEnterpriseStripeCard", "updateEnterprisePaymentMethod", "retryEnterprisePayment", "updateEnterpriseInvoiceDetails", "createOrgUnit", "deleteOrgUnit", "createEdiscoveryExport", "updateSettingLock", "updateOrgUnitConnection", "updateMembershipCaptureType", "updateEnterpriseTaxDetails", "deleteEnterpriseTaxDetails", "changeEnterpriseInviteRestrictions", "changeEnterprisePortalInviteRestrictions", "changeEnterpriseGlobalShareRestrictions", "changeEnterpriseInterfaceOrgWideSharingRestrictions", "changeEnterpriseGroupCreateRestrictions", "changeEnterpriseIpAddressAccessRestrictions", "changeEnterpriseExtensionConfigurationRestrictions", "changeEnterpriseDataRetentionPolicy", "changeEnterpriseAiRestrictionPolicy", "changeEnterpriseMfaPolicy", "changeEnterpriseLicenseUpgradeRequestConfig", "changeDataTableInstallationRestrictions", "changeEnterpriseColors", "changeEnterpriseTermsOfUseOptions", "changeEnterpriseDataExportControlRestrictions", "changeEnterpriseSensitivityLabels", "changeEnterpriseSensitivityLabelSetting", "changeEnterpriseWorkspaceAppCreationRestrictions", "addUserOrGroupToEnterpriseRestrictionAllowlist", "removeUserOrGroupFromEnterpriseRestrictionAllowlist", "changeEnterpriseOutboundAccessRestrictions", "addOutboundAccessAllowlistEntry", "removeOutboundAccessAllowlistEntry", "applyDefaultEnterpriseSetting", "createSsoIdentityProvider", "updateSsoIdentityProvider", "deleteSsoIdentityProvider", "unlinkUserSsoIdentity", "setEmailDomainSsoPiggybacking", "clearEmailDomainSsoPiggybacking", "requestLicenseUpgrade", "approveLicenseUpgradeRequest", "denyLicenseUpgradeRequest", "createManagedApp", "createComponent", "deleteManagedApp", "deleteComponent", "publishManagedApp", "publishComponent", "updateManagedAppName", "updateComponentName", "addManagedAppAudienceMember", "addComponentAudienceMember", "removeManagedAppAudienceMember", "removeComponentAudienceMember", "addManagedAppCollaborator", "addComponentCollaborator", "changeManagedAppCollaboratorPermission", "changeComponentCollaboratorPermission", "removeManagedAppCollaborator", "removeComponentCollaborator", "createPublishedDataset", "changePublishedDatasetName", "deletePublishedDataset", "updatePublishedDatasetOwner", "updatePublishedDatasetAudiences", "updatePublishedDatasetVerificationStatus", "deactivatePublishedDataset", "reactivatePublishedDataset", "createDataTable", "updateDataTableSource", "updateDataTableSingleSelectColumnChoices", "deleteDataTable", "createPublishedDatasetFromDataTable", "updateDataTablePublishedDataSet", "updateDataTablePublishedDataSetStatus", "abortDataTableImportInProgress", "moveDataTable", "createWorkspace", "deleteWorkspace", "restoreWorkspaceFromTrash", "moveWorkspace", "changeWorkspaceSharingRestrictions", "addWorkspaceInviteLink", "configureWorkspaceInviteLink", "removeWorkspaceInviteLink", "updateWorkspaceName", "changeWorkspaceAiPermissions", "inviteWorkspaceCollaborator", "addWorkspaceCollaborator", "changeWorkspaceInvitePermission", "changeWorkspaceCollaboratorPermission", "removeWorkspaceCollaborator", "uninviteWorkspaceCollaborator", "resendWorkspaceInvite", "viewInterface", "deleteInterface", "restoreInterfaceFromTrash", "duplicateInterface", "createInterface", "updateInterfaceName", "publishInterface", "unpublishInterface", "openRecordDetailsFromInterface", "viewForm", "publishForm", "unpublishForm", "configureFormSharingSettings", "inviteInterfaceCollaborator", "addInterfaceCollaborator", "changeInterfaceInvitePermission", "changeInterfaceCollaboratorPermission", "removeInterfaceCollaborator", "uninviteInterfaceCollaborator", "resendInterfaceInvite", "configureInterfaceOrgWideSharing", "createPortal", "deletePortal", "invitePortalCollaborator", "addPortalCollaborator", "changePortalInvitePermission", "changePortalCollaboratorPermission", "removePortalCollaborator", "uninvitePortalCollaborator", "downloadCSV", "aiCreditConsumed", "moderateAiContent", "installSolution", "updateSolutionVersion", "updateAutomationSubscribers" ] }, "description": "Retrieve audit log events falling under the provided event type or event types (maximum 100). Optional." }, "modelId": { "type": "array", "items": { "type": "string" }, "description": "Retrieve audit log events taking action on, or involving, the provided model ID or IDs (maximum 100). Optional." }, "pageSize": { "type": "number", "description": "The number of events per page. Maximum value of 1000; defaults to 10." }, "sortOrder": { "type": "string", "description": "Sort the events by timestamp in ascending or descending order. Defaults to descending.", "enum": [ "descending", "ascending" ] }, "previous": { "type": "string", "description": "If there are older items to retrieve, a **previous** is returned. Pass the **previous** from a prior call to retrieve the next-oldest page of items. You may pass the special value `null` to indicate \"use the default behavior\", which operates identically to omitting the **previous** parameter entirely." }, "next": { "type": "string", "description": "If there are newer items to retrieve, a **next** is returned. Pass the **next** from a prior call to retrieve the next-newest page of items. You may pass the special value `null` to indicate \"use the default behavior\", which operates identically to omitting the **next** parameter entirely." }, "category": { "type": "array", "items": { "type": "string", "enum": [ "base", "baseCollaboration", "groups", "role", "share", "user", "twoFactorAuthentication", "oauth", "personalAccessToken", "enterprise", "enterpriseSettings", "enterpriseLicenses", "managedApps", "components", "publishedDataSets", "dataTable", "workspace", "workspaceCollaboration", "interface", "standaloneForms", "interfaceCollaboration", "view", "ai", "solution", "portal", "workflow", "customDomain" ] }, "description": "The category value" } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_change\_events Change events **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `startTime` | string | No | — | Earliest change event to retrieve (inclusive), in ISO 8601 date time format. Optional. | | `endTime` | string | No | — | Latest change event to retrieve (exclusive), in ISO 8601 date time format. Optional. | | `pageSize` | number | No | — | The number of records per page. Maximum value of 100; defaults to 10. | | `offset` | string | No | — | If there may be more to retrieve, an **offset** is returned. Pass the **offset** to the next call to retrieve the next page. Do not pass **offset** when retrieving the first page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "startTime": { "type": "string", "description": "Earliest change event to retrieve (inclusive), in ISO 8601 date time format. Optional." }, "endTime": { "type": "string", "description": "Latest change event to retrieve (exclusive), in ISO 8601 date time format. Optional." }, "pageSize": { "type": "number", "description": "The number of records per page. Maximum value of 100; defaults to 10." }, "offset": { "type": "string", "description": "If there may be more to retrieve, an **offset** is returned. Pass the **offset** to the next call to retrieve the next page. Do not pass **offset** when retrieving the first page." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_create\_a\_webhook Create a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | | `notificationUrl` | string | null | No | — | An optional url that can receive notification pings. See notification delivery. | | `specification` | object | Yes | — | A JSON object that describe the types of changes the webhook is interested in. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "notificationUrl": { "type": [ "string", "null" ], "description": "An optional url that can receive notification pings. [See notification delivery](/api/webhooks-overview#webhook-notification-delivery)." }, "specification": { "type": "object", "description": "A JSON object that describe the types of changes the webhook is interested in.", "properties": { "options": { "type": "object", "description": "A single webhook may watch changes in a table, view, or base. The specification defines the types of the changes that are included in the webhook's payloads. Note that tables, fields, and views in the specification must be specified by ID rather than by name. You may find the IDs for each of these with the manage fields UI." } }, "required": [ "options" ] } }, "required": [ "PCID", "baseId", "specification" ] } ``` *** ## airtable\_create\_audit\_log\_request Create audit log request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `filter` | string | No | — | An optional filter may be supplied. The filter value may be any of: - User ID - Workspace ID - Base ID - Table ID - IPv4 address (**1.2.3.4**) | | `timePeriod` | string | Yes | — | The time period (specific month or day) for which you want to retrieve audit logs for. Must be in either **YYYY-MM** or **YYYY-MM-DD** format and within the last 180 days. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "filter": { "type": "string", "description": "An optional filter may be supplied. The filter value may be any of: - User ID - Workspace ID - Base ID - Table ID - IPv4 address (**1.2.3.4**)" }, "timePeriod": { "type": "string", "description": "The time period (specific month or day) for which you want to retrieve audit logs for. Must be in either **YYYY-MM** or **YYYY-MM-DD** format and within the last 180 days." } }, "required": [ "PCID", "enterpriseAccountId", "timePeriod" ] } ``` *** ## airtable\_create\_base Create base **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | The name for the new base. | | `tables` | object\[] | Yes | — | A list of JSON objects representing the tables that will be created along with the base. | | `workspaceId` | string | Yes | — | The workspace where the base will be created. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name for the new base." }, "tables": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "The description value" }, "fields": { "type": "array", "description": "The fields value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "name", "fields" ] }, "description": "A list of JSON objects representing the tables that will be created along with the base." }, "workspaceId": { "type": "string", "description": "The workspace where the base will be created." } }, "required": [ "PCID", "name", "tables", "workspaceId" ] } ``` *** ## airtable\_create\_base\_from\_package\_enterprise Create base from package **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | | `packageId` | string | Yes | — | Package Id | | | `description` | string | null | No | — | Optional description for the base. | | `name` | string | Yes | — | The name for the new base. | | | `packageReleaseId` | string | Yes | — | The package release ID to install. | | | `workspaceId` | string | Yes | — | The workspace where the base will be created. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "packageId": { "type": "string", "description": "Package Id" }, "description": { "type": [ "string", "null" ], "description": "Optional description for the base." }, "name": { "type": "string", "description": "The name for the new base." }, "packageReleaseId": { "type": "string", "description": "The package release ID to install." }, "workspaceId": { "type": "string", "description": "The workspace where the base will be created." } }, "required": [ "PCID", "enterpriseAccountId", "packageId", "name", "packageReleaseId", "workspaceId" ] } ``` *** ## airtable\_create\_comment Create comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | `recordId` | string | Yes | — | Record Id | | `parentCommentId` | string | No | — | A comment ID | | `text` | string | Yes | — | The text value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "parentCommentId": { "type": "string", "description": "A comment ID" }, "text": { "type": "string", "description": "The text value" } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId", "text" ] } ``` *** ## airtable\_create\_descendant\_enterprise Create descendant enterprise **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "enterpriseAccountId", "name" ] } ``` *** ## airtable\_create\_ediscovery\_export Create eDiscovery export **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `baseId` | string | Yes | — | Base ID to create eDiscovery export for. | | `includeCsvFormat` | boolean | No | — | If set, also export the base as CSVs (in a zipped file). Once the export is ready for download, the URL to the zip file will be available in the `csvZipDownloadUrl` attribute. | | `shouldSendEmailOnCompletion` | boolean | No | — | If set, an email will be sent to the user who initiated the export once the export is ready for download. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "baseId": { "type": "string", "description": "Base ID to create eDiscovery export for." }, "includeCsvFormat": { "type": "boolean", "description": "If set, also export the base as CSVs (in a zipped file). Once the export is ready for download, the URL to the zip file will be available in the `csvZipDownloadUrl` attribute." }, "shouldSendEmailOnCompletion": { "type": "boolean", "description": "If set, an email will be sent to the user who initiated the export once the export is ready for download." } }, "required": [ "PCID", "enterpriseAccountId", "baseId" ] } ``` *** ## airtable\_create\_field Create field **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableId` | string | Yes | — | Table Id | | `body` | object | No | — | This identical to Field type and options, with an additional `name` and `description` property on all types | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableId": { "type": "string", "description": "Table Id" }, "body": { "description": "This identical to Field type and options, with an additional `name` and `description` property on all types" } }, "required": [ "PCID", "baseId", "tableId" ] } ``` *** ## airtable\_create\_records Create records **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | | `fields` | object | No | — | Create **a single** record | | | `records` | object\[] | No | — | Create **multiple** records Pass in multiple records to create multiple in one request | | | `returnFieldsByFieldId` | boolean | null | No | — | An optional boolean value that lets you return field objects keyed by the field id. This defaults to `false`, which returns field objects where the key is the field name. | | `typecast` | boolean | null | No | — | The Airtable API will perform best-effort automatic data conversion from string values if the typecast parameter is passed in. Automatic conversion is disabled by default to ensure data integrity, but it may be helpful for integrating with 3rd party data sources. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "fields": { "type": "object", "description": "Create **a single** record" }, "records": { "type": "array", "items": { "type": "object", "properties": { "fields": { "type": "object", "description": "The fields value" } }, "required": [ "fields" ] }, "description": "Create **multiple** records Pass in multiple records to create multiple in one request" }, "returnFieldsByFieldId": { "type": [ "boolean", "null" ], "description": "An optional boolean value that lets you return field objects keyed by the field id. This defaults to `false`, which returns field objects where the key is the field name." }, "typecast": { "type": [ "boolean", "null" ], "description": "The Airtable API will perform best-effort automatic data conversion from string values if the typecast parameter is passed in. Automatic conversion is disabled by default to ensure data integrity, but it may be helpful for integrating with 3rd party data sources." } }, "required": [ "PCID", "baseId", "tableIdOrName" ] } ``` *** ## airtable\_create\_table Create table **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `description` | string | No | — | The description for the table (optional). If present, must be a non-empty string no longer than 20,000 characters. | | `fields` | any\[] | Yes | — | A list of JSON objects representing the fields in the table. Refer to field types for supported field types, the write format for field options, and other specifics for certain field types. | | `name` | string | Yes | — | The name for the table. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "description": { "type": "string", "description": "The description for the table (optional). If present, must be a non-empty string no longer than 20,000 characters." }, "fields": { "type": "array", "description": "A list of JSON objects representing the fields in the table. Refer to [field types](/api/model/field-type) for supported field types, the write format for field options, and other specifics for certain field types." }, "name": { "type": "string", "description": "The name for the table." } }, "required": [ "PCID", "baseId", "fields", "name" ] } ``` *** ## airtable\_create\_workspace Create workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | The enterprise account that the workspace will be created in. | | `name` | string | Yes | — | Name of the workspace to be created. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "The enterprise account that the workspace will be created in." }, "name": { "type": "string", "description": "Name of the workspace to be created." } }, "required": [ "PCID", "enterpriseAccountId", "name" ] } ``` *** ## airtable\_delete\_a\_webhook Delete a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `webhookId` | string | Yes | — | Webhook Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "webhookId": { "type": "string", "description": "Webhook Id" } }, "required": [ "PCID", "baseId", "webhookId" ] } ``` *** ## airtable\_delete\_base Delete base **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" } }, "required": [ "PCID", "baseId" ] } ``` *** ## airtable\_delete\_base\_collaborator Delete base collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `userOrGroupId` | string | Yes | — | User Or Group Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" } }, "required": [ "PCID", "baseId", "userOrGroupId" ] } ``` *** ## airtable\_delete\_base\_invite Delete base invite **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `inviteId` | string | Yes | — | Invite Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "inviteId": { "type": "string", "description": "Invite Id" } }, "required": [ "PCID", "baseId", "inviteId" ] } ``` *** ## airtable\_delete\_block\_installation Delete block installation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `blockInstallationId` | string | Yes | — | Block Installation Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "blockInstallationId": { "type": "string", "description": "Block Installation Id" } }, "required": [ "PCID", "baseId", "blockInstallationId" ] } ``` *** ## airtable\_delete\_comment Delete comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | `recordId` | string | Yes | — | Record Id | | `rowCommentId` | string | Yes | — | Row Comment Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "rowCommentId": { "type": "string", "description": "Row Comment Id" } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId", "rowCommentId" ] } ``` *** ## airtable\_delete\_interface\_collaborator Delete interface collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `pageBundleId` | string | Yes | — | Page Bundle Id | | `userOrGroupId` | string | Yes | — | User Or Group Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "pageBundleId": { "type": "string", "description": "Page Bundle Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" } }, "required": [ "PCID", "baseId", "pageBundleId", "userOrGroupId" ] } ``` *** ## airtable\_delete\_interface\_invite Delete interface invite **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `pageBundleId` | string | Yes | — | Page Bundle Id | | `inviteId` | string | Yes | — | Invite Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "pageBundleId": { "type": "string", "description": "Page Bundle Id" }, "inviteId": { "type": "string", "description": "Invite Id" } }, "required": [ "PCID", "baseId", "pageBundleId", "inviteId" ] } ``` *** ## airtable\_delete\_multiple\_records Delete multiple records **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | `records` | string\[] | No | — | The recordIds of each record to be deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "records": { "type": "array", "items": { "type": "string" }, "description": "The recordIds of each record to be deleted." } }, "required": [ "PCID", "baseId", "tableIdOrName" ] } ``` *** ## airtable\_delete\_record Delete record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | `recordId` | string | Yes | — | Record Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId" ] } ``` *** ## airtable\_delete\_share Delete share **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `shareId` | string | Yes | — | Share Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "shareId": { "type": "string", "description": "Share Id" } }, "required": [ "PCID", "baseId", "shareId" ] } ``` *** ## airtable\_delete\_user\_by\_id Delete user by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `userId` | string | Yes | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "userId": { "type": "string", "description": "User Id" } }, "required": [ "PCID", "enterpriseAccountId", "userId" ] } ``` *** ## airtable\_delete\_users\_by\_email Delete users by email **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `email` | string\[] | No | — | The email value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "email": { "type": "array", "items": { "type": "string" }, "description": "The email value" } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_delete\_view Delete view **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `viewId` | string | Yes | — | View Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "viewId": { "type": "string", "description": "View Id" } }, "required": [ "PCID", "baseId", "viewId" ] } ``` *** ## airtable\_delete\_workspace Delete workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspaceId` | string | Yes | — | Workspace Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## airtable\_delete\_workspace\_collaborator Delete workspace collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspaceId` | string | Yes | — | Workspace Id | | `userOrGroupId` | string | Yes | — | User Or Group Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" } }, "required": [ "PCID", "workspaceId", "userOrGroupId" ] } ``` *** ## airtable\_delete\_workspace\_invite Delete workspace invite **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspaceId` | string | Yes | — | Workspace Id | | `inviteId` | string | Yes | — | Invite Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "inviteId": { "type": "string", "description": "Invite Id" } }, "required": [ "PCID", "workspaceId", "inviteId" ] } ``` *** ## airtable\_enable\_disable\_webhook\_notifications Enable/disable webhook notifications **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `webhookId` | string | Yes | — | Webhook Id | | `enable` | boolean | Yes | — | The enable value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "webhookId": { "type": "string", "description": "Webhook Id" }, "enable": { "type": "boolean", "description": "The enable value" } }, "required": [ "PCID", "baseId", "webhookId", "enable" ] } ``` *** ## airtable\_get\_audit\_log\_request Get audit log request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `enterpriseAuditLogTaskId` | string | Yes | — | Enterprise Audit Log Task Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "enterpriseAuditLogTaskId": { "type": "string", "description": "Enterprise Audit Log Task Id" } }, "required": [ "PCID", "enterpriseAccountId", "enterpriseAuditLogTaskId" ] } ``` *** ## airtable\_get\_base\_collaborators Get base collaborators **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `include` | string\[] | No | — | If specified, collaborators, interfaces, inviteLinks key, and/or packages will be included in the response object. Otherwise, they will be left out. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "collaborators", "inviteLinks", "interfaces", "packages" ] }, "description": "If specified, collaborators, interfaces, inviteLinks key, and/or packages will be included in the response object. Otherwise, they will be left out." } }, "required": [ "PCID", "baseId" ] } ``` *** ## airtable\_get\_base\_schema Get base schema **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `include` | string\[] | No | — | If specified, additional fields to include in the `views` object response; currently, this list only allows a single literal value `visibleFieldIds` (for views of type `grid` only) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "If specified, additional fields to include in the `views` object response; currently, this list only allows a single literal value `visibleFieldIds` (for views of type `grid` only)" } }, "required": [ "PCID", "baseId" ] } ``` *** ## airtable\_get\_ediscovery\_export Get eDiscovery export **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `enterpriseTaskId` | string | Yes | — | Enterprise Task Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "enterpriseTaskId": { "type": "string", "description": "Enterprise Task Id" } }, "required": [ "PCID", "enterpriseAccountId", "enterpriseTaskId" ] } ``` *** ## airtable\_get\_enterprise Get enterprise **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `include` | string\[] | No | — | If specified, aggregated and/or descendants keys will be included in the response object. Otherwise, it will be left out. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "aggregated", "descendants" ] }, "description": "If specified, aggregated and/or descendants keys will be included in the response object. Otherwise, it will be left out." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_get\_interface Get interface **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `pageBundleId` | string | Yes | — | Page Bundle Id | | `include` | string\[] | No | — | Related resources to include | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "pageBundleId": { "type": "string", "description": "Page Bundle Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "collaborators", "inviteLinks" ] }, "description": "Related resources to include" } }, "required": [ "PCID", "baseId", "pageBundleId" ] } ``` *** ## airtable\_get\_record Get record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | `recordId` | string | Yes | — | Record Id | | `cellFormat` | string | No | — | The format that should be used for cell values. Supported values are: - `json:` cells will be formatted as JSON, depending on the field type. - `string:` cells will be formatted as user-facing strings, regardless of the field type. The `timeZone` and `userLocale` parameters are required when using `string` as the `cellFormat`. **Note:** You should not rely on the format of these strings, as it is subject to change. The default is `json`. | | `returnFieldsByFieldId` | boolean | No | — | An optional boolean value that lets you return field objects where the key is the field id. This defaults to `false`, which returns field objects where the key is the field name. | | `includeDateDependencyMetadata` | boolean | No | — | An optional boolean value that returns linked record cell values as objects instead of record IDs. When `true`, all linked record fields return an array of objects with an `id` property. Linked record fields configured for date dependencies include an optional `dateDependencyMetadata` object with `dependencyType` and `buffer` fields (when date dependencies are configured in fixed mode). When `false` or unset, linked record fields return an array of record ID strings. This defaults to `false`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "cellFormat": { "type": "string", "description": "The format that should be used for cell values. Supported values are: - `json:` cells will be formatted as JSON, depending on the field type. - `string:` cells will be formatted as user-facing strings, regardless of the field type. The `timeZone` and `userLocale` parameters are required when using `string` as the `cellFormat`. **Note:** You should not rely on the format of these strings, as it is subject to change. The default is `json`.", "enum": [ "json", "string" ] }, "returnFieldsByFieldId": { "type": "boolean", "description": "An optional boolean value that lets you return field objects where the key is the field id. This defaults to `false`, which returns field objects where the key is the field name." }, "includeDateDependencyMetadata": { "type": "boolean", "description": "An optional boolean value that returns linked record cell values as objects instead of record IDs. When `true`, all linked record fields return an array of objects with an `id` property. Linked record fields configured for date dependencies include an optional `dateDependencyMetadata` object with `dependencyType` and `buffer` fields (when date dependencies are configured in fixed mode). When `false` or unset, linked record fields return an array of record ID strings. This defaults to `false`." } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId" ] } ``` *** ## airtable\_get\_user\_by\_id Get user by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `userId` | string | Yes | — | User Id | | `include` | string\[] | No | — | If specified, collaborations, aggregated, and/or descendants keys will be included in the response object. Otherwise, they will be left out. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "userId": { "type": "string", "description": "User Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "collaborations", "aggregated", "descendants" ] }, "description": "If specified, collaborations, aggregated, and/or descendants keys will be included in the response object. Otherwise, they will be left out." } }, "required": [ "PCID", "enterpriseAccountId", "userId" ] } ``` *** ## airtable\_get\_user\_group Get user group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `groupId` | string | Yes | — | Group Id | | `include` | string\[] | No | — | If specified, collaborations key will be included in the response object. Otherwise it will be left out. You must be a group member or enterprise admin to view this information. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "Group Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "If specified, collaborations key will be included in the response object. Otherwise it will be left out. You must be a group member or enterprise admin to view this information." } }, "required": [ "PCID", "groupId" ] } ``` *** ## airtable\_get\_user\_id\_scopes Get user info ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## airtable\_get\_users\_by\_id\_or\_email Get users by id or email **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `email` | string\[] | No | — | Email addresses to search by. If the request does not have any userIds, you must include at least one email address. | | `id` | string\[] | No | — | User Ids to search by. If the request does not have any email addresses, you must include at least one userId. | | `include` | string\[] | No | — | Allows optionally including collaborations in response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "email": { "type": "array", "items": { "type": "string" }, "description": "Email addresses to search by. If the request does not have any userIds, you must include at least one email address." }, "id": { "type": "array", "items": { "type": "string" }, "description": "User Ids to search by. If the request does not have any email addresses, you must include at least one userId." }, "include": { "type": "array", "items": { "type": "string", "enum": [ "collaborations", "aggregated", "descendants" ] }, "description": "Allows optionally including collaborations in response." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_get\_view\_metadata Get view metadata **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `viewId` | string | Yes | — | View Id | | `include` | string\[] | No | — | If specified, additional fields to include in the `views` object response; currently, this list only allows a single literal value `visibleFieldIds` (for views of type `grid` only) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "viewId": { "type": "string", "description": "View Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "If specified, additional fields to include in the `views` object response; currently, this list only allows a single literal value `visibleFieldIds` (for views of type `grid` only)" } }, "required": [ "PCID", "baseId", "viewId" ] } ``` *** ## airtable\_get\_workspace\_collaborators Get workspace collaborators **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspaceId` | string | Yes | — | Workspace Id | | `include` | string\[] | No | — | If specified, collaborators or inviteLinks key will be included in the response object. Otherwise they will be left out. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "include": { "type": "array", "items": { "type": "string", "enum": [ "collaborators", "inviteLinks" ] }, "description": "If specified, collaborators or inviteLinks key will be included in the response object. Otherwise they will be left out." } }, "required": [ "PCID", "workspaceId" ] } ``` *** ## airtable\_grant\_admin\_access Grant admin access **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `users` | object\[] | Yes | — | The users value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "users": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The email value" }, "id": { "type": "string", "description": "A user ID" } } }, "description": "The users value" } }, "required": [ "PCID", "enterpriseAccountId", "users" ] } ``` *** ## airtable\_list\_audit\_log\_requests List audit log requests **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `pageSize` | number | No | — | The number of records per page. Maximum value of 100; defaults to 10. | | `offset` | number | No | — | If there may be more to retrieve, an **offset** is returned. Pass the **offset** to the next call to retrieve the next page. Do not pass **offset** when retrieving the first page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "pageSize": { "type": "number", "description": "The number of records per page. Maximum value of 100; defaults to 10." }, "offset": { "type": "number", "description": "If there may be more to retrieve, an **offset** is returned. Pass the **offset** to the next call to retrieve the next page. Do not pass **offset** when retrieving the first page." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_list\_bases List bases **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | string | No | — | The offset value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "string", "description": "The offset value" } }, "required": [ "PCID" ] } ``` *** ## airtable\_list\_block\_installations List block installations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" } }, "required": [ "PCID", "baseId" ] } ``` *** ## airtable\_list\_comments List comments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | `recordId` | string | Yes | — | Record Id | | `pageSize` | number | No | — | If specified, this will determine the number of comments to return. Must be less than or equal to 100. Default is 100. | | `offset` | string | No | — | A pointer to a specific comment. If specified, the returned comments will begin at the specified **offset**. An **offset** to the next set of comments will be provided by the API if the number of returned comments exceed the **pageSize**. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "pageSize": { "type": "number", "description": "If specified, this will determine the number of comments to return. Must be less than or equal to 100. Default is 100." }, "offset": { "type": "string", "description": "A pointer to a specific comment. If specified, the returned comments will begin at the specified **offset**. An **offset** to the next set of comments will be provided by the API if the number of returned comments exceed the **pageSize**." } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId" ] } ``` *** ## airtable\_list\_ediscovery\_export List eDiscovery exports **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `state` | string | No | — | Filter for exports with the specified state. | | `pageSize` | number | No | — | The number of records per page. Maximum value of 100; defaults to 10. | | `offset` | number | No | — | If there may be more to retrieve, an **offset** is returned. Pass the **offset** to the next call to retrieve the next page. Do not pass **offset** when retrieving the first page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "state": { "type": "string", "description": "Filter for exports with the specified state.", "enum": [ "pending", "processing", "error", "done" ] }, "pageSize": { "type": "number", "description": "The number of records per page. Maximum value of 100; defaults to 10." }, "offset": { "type": "number", "description": "If there may be more to retrieve, an **offset** is returned. Pass the **offset** to the next call to retrieve the next page. Do not pass **offset** when retrieving the first page." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_list\_enterprise\_packages List packages **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `shouldGetAllPackagesInGrid` | boolean | No | — | If true and the enterprise account is the root enterprise account, returns all packages across the entire enterprise grid. Defaults to false. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "shouldGetAllPackagesInGrid": { "type": "boolean", "description": "If true and the enterprise account is the root enterprise account, returns all packages across the entire enterprise grid. Defaults to false." } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_list\_enterprise\_personal\_access\_tokens List personal access tokens **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `includeResources` | boolean | No | — | Include Resources | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "includeResources": { "type": "boolean", "description": "Include Resources" } }, "required": [ "PCID", "enterpriseAccountId" ] } ``` *** ## airtable\_list\_records List records **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | `timeZone` | object | No | — | Timezone identifier | | `userLocale` | string | No | — | The [user locale](https://support.airtable.com/docs/supported-locale-modifiers-for-set-locale) that should be used to format dates when using `string` as the `cellFormat`. This parameter is required when using `string` as the `cellFormat`. | | `pageSize` | number | No | — | The number of records returned in each request. Must be less than or equal to 100. Default is 100. | | `maxRecords` | number | No | — | The maximum total number of records that will be returned in your requests. If this value is larger than **pageSize** (which is 100 by default), you may have to load multiple pages to reach this total. | | `offset` | string | No | — | To fetch the next page of records, include offset from the previous request in the next request's parameters. | | `view` | object | No | — | The name or ID of a view in the table. If set, only the records in that view will be returned. The records will be sorted according to the order of the view unless the **sort** parameter is included, which overrides that order. Fields hidden in this view will be returned in the results. To only return a subset of fields, use the **fields** parameter. | | `sort` | object\[] | No | — | A list of sort objects that specifies how the records will be ordered. Each sort object must have a **field** key specifying the name of the field to sort on, and an optional **direction** key that is either **"asc"** or **"desc"**. The default direction is **"asc"**. The **sort** parameter overrides the sorting of the view specified in the **view** parameter. If neither the **sort** nor the **view** parameter is included, the order of records is arbitrary. | | `filterByFormula` | string | No | — | A [formula](https://support.airtable.com/docs/formula-field-reference) used to filter records. The formula will be evaluated for each record, and if the result is not **0**, **false**, **""**, **NaN**, **\[]**, or **#Error!** the record will be included in the response. We recommend testing your formula in the Formula field UI before using it in your API request. If combined with the **view** parameter, only records in that view which satisfy the formula will be returned. The formula must be encoded first before passing it as a value. You can use [this tool](https://codepen.io/airtable/full/MeXqOg) to not only encode the formula but also create the entire url you need. Formulas can use field names or field IDs inside the formula. **Note** Airtable's API only accepts request with a URL shorter than 16,000 characters. Encoded formulas may cause your requests to exceed this limit. To fix this issue you can instead make a POST request to `/v0/{baseId}/{tableIdOrName}/listRecords` while passing the parameters within the body of the request instead of the query parameters. | | `cellFormat` | string | No | — | The format that should be used for cell values. Supported values are: - **json**: cells will be formatted as JSON, depending on the field type. - **string**: cells will be formatted as user-facing strings, regardless of the field type. The **timeZone** and **userLocale** parameters are required when using **string** as the **cellFormat**. **Note**: You should not rely on the format of these strings, as it is subject to change. The default is **json**. | | `fields` | string\[] | No | — | Only data for fields whose names or IDs are in this list will be included in the result. If you don't need every field, you can use this parameter to reduce the amount of data transferred. **Note** Airtable's API only accepts request with a URL shorter than 16,000 characters. Encoded formulas may cause your requests to exceed this limit. To fix this issue you can instead make a POST request to `/v0/{baseId}/{tableIdOrName}/listRecords` while passing the parameters within the body of the request instead of the query parameters. | | `returnFieldsByFieldId` | boolean | No | — | An optional boolean value that lets you return field objects where the key is the field id. This defaults to **false**, which returns field objects where the key is the field name. | | `includeDateDependencyMetadata` | boolean | No | — | An optional boolean value that returns linked record cell values as objects instead of record IDs. When `true`, all linked record fields return an array of objects with an `id` property. Linked record fields configured for date dependencies include an optional `dateDependencyMetadata` object with `dependencyType` and `buffer` fields (when date dependencies are configured in fixed mode). When `false` or unset, linked record fields return an array of record ID strings. This defaults to `false`. | | `recordMetadata` | string\[] | No | — | An optional field that, if specified, includes **commentCount** on each record returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "timeZone": { "description": "Timezone identifier" }, "userLocale": { "type": "string", "description": "The [user locale](https://support.airtable.com/docs/supported-locale-modifiers-for-set-locale) that should be used to format dates when using `string` as the `cellFormat`. This parameter is required when using `string` as the `cellFormat`." }, "pageSize": { "type": "number", "description": "The number of records returned in each request. Must be less than or equal to 100. Default is 100." }, "maxRecords": { "type": "number", "description": "The maximum total number of records that will be returned in your requests. If this value is larger than **pageSize** (which is 100 by default), you may have to load multiple pages to reach this total." }, "offset": { "type": "string", "description": "To fetch the next page of records, include offset from the previous request in the next request's parameters." }, "view": { "description": "The name or ID of a view in the table. If set, only the records in that view will be returned. The records will be sorted according to the order of the view unless the **sort** parameter is included, which overrides that order. Fields hidden in this view will be returned in the results. To only return a subset of fields, use the **fields** parameter." }, "sort": { "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "asc", "desc" ], "description": "The direction value" }, "field": { "type": "string", "description": "The field value" } }, "required": [ "field" ] }, "description": "A list of sort objects that specifies how the records will be ordered. Each sort object must have a **field** key specifying the name of the field to sort on, and an optional **direction** key that is either **\"asc\"** or **\"desc\"**. The default direction is **\"asc\"**. The **sort** parameter overrides the sorting of the view specified in the **view** parameter. If neither the **sort** nor the **view** parameter is included, the order of records is arbitrary." }, "filterByFormula": { "type": "string", "description": "A [formula](https://support.airtable.com/docs/formula-field-reference) used to filter records. The formula will be evaluated for each record, and if the result is not **0**, **false**, **\"\"**, **NaN**, **[]**, or **#Error!** the record will be included in the response. We recommend testing your formula in the Formula field UI before using it in your API request. If combined with the **view** parameter, only records in that view which satisfy the formula will be returned. The formula must be encoded first before passing it as a value. You can use [this tool](https://codepen.io/airtable/full/MeXqOg) to not only encode the formula but also create the entire url you need. Formulas can use field names or field IDs inside the formula. **Note** Airtable's API only accepts request with a URL shorter than 16,000 characters. Encoded formulas may cause your requests to exceed this limit. To fix this issue you can instead make a POST request to `/v0/{baseId}/{tableIdOrName}/listRecords` while passing the parameters within the body of the request instead of the query parameters." }, "cellFormat": { "type": "string", "description": "The format that should be used for cell values. Supported values are: - **json**: cells will be formatted as JSON, depending on the field type. - **string**: cells will be formatted as user-facing strings, regardless of the field type. The **timeZone** and **userLocale** parameters are required when using **string** as the **cellFormat**. **Note**: You should not rely on the format of these strings, as it is subject to change. The default is **json**.", "enum": [ "json", "string" ] }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Only data for fields whose names or IDs are in this list will be included in the result. If you don't need every field, you can use this parameter to reduce the amount of data transferred. **Note** Airtable's API only accepts request with a URL shorter than 16,000 characters. Encoded formulas may cause your requests to exceed this limit. To fix this issue you can instead make a POST request to `/v0/{baseId}/{tableIdOrName}/listRecords` while passing the parameters within the body of the request instead of the query parameters." }, "returnFieldsByFieldId": { "type": "boolean", "description": "An optional boolean value that lets you return field objects where the key is the field id. This defaults to **false**, which returns field objects where the key is the field name." }, "includeDateDependencyMetadata": { "type": "boolean", "description": "An optional boolean value that returns linked record cell values as objects instead of record IDs. When `true`, all linked record fields return an array of objects with an `id` property. Linked record fields configured for date dependencies include an optional `dateDependencyMetadata` object with `dependencyType` and `buffer` fields (when date dependencies are configured in fixed mode). When `false` or unset, linked record fields return an array of record ID strings. This defaults to `false`." }, "recordMetadata": { "type": "array", "items": { "type": "string" }, "description": "An optional field that, if specified, includes **commentCount** on each record returned." } }, "required": [ "PCID", "baseId", "tableIdOrName" ] } ``` *** ## airtable\_list\_shares List shares **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" } }, "required": [ "PCID", "baseId" ] } ``` *** ## airtable\_list\_views List views **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `include` | string\[] | No | — | If specified, additional fields to include in the `views` object response; currently, this list only allows a single literal value `visibleFieldIds` (for views of type `grid` only) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "include": { "type": "array", "items": { "type": "string" }, "description": "If specified, additional fields to include in the `views` object response; currently, this list only allows a single literal value `visibleFieldIds` (for views of type `grid` only)" } }, "required": [ "PCID", "baseId" ] } ``` *** ## airtable\_list\_webhook\_payloads List webhook payloads **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `webhookId` | string | Yes | — | Webhook Id | | `cursor` | number | No | — | The first time this action is called, the cursor argument may be omitted from the request and will default to 1. After that, cursors should be saved between invocations of this action. When a client receives a ping, it should use the last cursor that this action returned when polling for new payloads, no matter how old that cursor value is. The cursor argument indicates the transaction number of the payload to start listing from. | | `limit` | number | No | — | If given the limit parameter specifies the maximum number of payloads to return in the response. A maximum of 50 payloads can be returned in a single request. A single payload can contain multiple updates. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "webhookId": { "type": "string", "description": "Webhook Id" }, "cursor": { "type": "number", "description": "The first time this action is called, the cursor argument may be omitted from the request and will default to 1. After that, cursors should be saved between invocations of this action. When a client receives a ping, it should use the last cursor that this action returned when polling for new payloads, no matter how old that cursor value is. The cursor argument indicates the transaction number of the payload to start listing from." }, "limit": { "type": "number", "description": "If given the limit parameter specifies the maximum number of payloads to return in the response. A maximum of 50 payloads can be returned in a single request. A single payload can contain multiple updates." } }, "required": [ "PCID", "baseId", "webhookId" ] } ``` *** ## airtable\_list\_webhooks List webhooks **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" } }, "required": [ "PCID", "baseId" ] } ``` *** ## airtable\_logout\_user Logout user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `userId` | string | Yes | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "userId": { "type": "string", "description": "User Id" } }, "required": [ "PCID", "enterpriseAccountId", "userId" ] } ``` *** ## airtable\_manage\_block\_installation Manage block installation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `blockInstallationId` | string | Yes | — | Block Installation Id | | `state` | string | Yes | — | The state value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "blockInstallationId": { "type": "string", "description": "Block Installation Id" }, "state": { "type": "string", "description": "The state value", "enum": [ "enabled", "disabled" ] } }, "required": [ "PCID", "baseId", "blockInstallationId", "state" ] } ``` *** ## airtable\_manage\_share Manage share **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `shareId` | string | Yes | — | Share Id | | `state` | string | Yes | — | When *enabling* a share a user is subject to [sharing restrictions](https://support.airtable.com/docs/workspace-sharing-restrictions). These restrictions are not applicable when disabling a share. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "shareId": { "type": "string", "description": "Share Id" }, "state": { "type": "string", "description": "When _enabling_ a share a user is subject to [sharing restrictions](https://support.airtable.com/docs/workspace-sharing-restrictions). These restrictions are not applicable when disabling a share.", "enum": [ "enabled", "disabled" ] } }, "required": [ "PCID", "baseId", "shareId", "state" ] } ``` *** ## airtable\_manage\_user Manage user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `userId` | string | Yes | — | User Id | | `email` | string | No | — | Enterprise account must own both the original and destination email domains. *WARNING:* If SSO is required for your enterprise account, you must follow these steps precisely to avoid locking the end user out of their account or creating duplicate accounts. - Use this API to update the user's email to a new value (this effectively logs the user out) - Use your SSO provider's (e.g. Okta's) admin panel to update the user's email to the new value - Tell the user to log into Airtable with the new email | | `firstName` | string | No | — | First Name | | `lastName` | string | No | — | Last Name | | `state` | string | No | — | provisioned \| deactivated Can only change the state of managed users. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "userId": { "type": "string", "description": "User Id" }, "email": { "type": "string", "description": "Enterprise account must own both the original and destination email domains. *WARNING:* If SSO is required for your enterprise account, you must follow these steps precisely to avoid locking the end user out of their account or creating duplicate accounts. - Use this API to update the user's email to a new value (this effectively logs the user out) - Use your SSO provider's (e.g. Okta's) admin panel to update the user's email to the new value - Tell the user to log into Airtable with the new email" }, "firstName": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "state": { "type": "string", "description": "[provisioned](/api/org-management-glossary#provisioned-user) | [deactivated](/api/org-management-glossary#deactivated-user) Can only change the state of [managed](/api/org-management-glossary#managed-user) users.", "enum": [ "provisioned", "deactivated" ] } }, "required": [ "PCID", "enterpriseAccountId", "userId" ] } ``` *** ## airtable\_manage\_user\_batched Manage user batched **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `users` | object\[] | Yes | — | The users value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "users": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "Enterprise account must own both the original and destination email domains. *WARNING:* If SSO is required for your enterprise account, you must follow these steps precisely to avoid locking the end user out of their account or creating duplicate accounts. - Use this API to update the user's email to a new value (this effectively logs the user out) - Use your SSO provider's (e.g. Okta's) admin panel to update the user's email to the new value - Tell the user to log into Airtable with the new email" }, "firstName": { "type": "string", "description": "First Name" }, "id": { "type": "string", "description": "A user ID" }, "lastName": { "type": "string", "description": "Last Name" }, "state": { "type": "string", "enum": [ "provisioned", "deactivated" ], "description": "[provisioned](/api/org-management-glossary#provisioned-user) | [deactivated](/api/org-management-glossary#deactivated-user) Can only change the state of [managed](/api/org-management-glossary#managed-user) users." } } }, "description": "The users value" } }, "required": [ "PCID", "enterpriseAccountId", "users" ] } ``` *** ## airtable\_manage\_user\_membership Manage user membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `users` | object\[] | Yes | — | The users value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "users": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The email value" }, "id": { "type": "string", "description": "A user ID" }, "state": { "type": "string", "enum": [ "managed", "unmanaged" ], "description": "[managed](/api/org-management-glossary#managed-user) | [unmanaged](/api/org-management-glossary#unmanaged-user)" } }, "required": [ "state" ] }, "description": "The users value" } }, "required": [ "PCID", "enterpriseAccountId", "users" ] } ``` *** ## airtable\_move\_base Move base **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspaceId` | string | Yes | — | Workspace Id | | `baseId` | string | Yes | — | ID of the base to be moved | | `targetIndex` | number | No | — | The desired index for the base in the target workspace's base order (optional). If provided, targetIndex must be a number between 0 (beginning of the list) and the number of bases in the target workspace (end of the list). If targetIndex is not provided, the base will be moved to the end of the list of bases in the target workspace. | | `targetWorkspaceId` | string | Yes | — | ID of the target workspace of the move. I.e. the workspace that the base will belong to once the move is complete. The target workspace must be in the same enterprise account as the source workspace. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "baseId": { "type": "string", "description": "ID of the base to be moved" }, "targetIndex": { "type": "number", "description": "The desired index for the base in the target workspace's base order (optional). If provided, targetIndex must be a number between 0 (beginning of the list) and the number of bases in the target workspace (end of the list). If targetIndex is not provided, the base will be moved to the end of the list of bases in the target workspace." }, "targetWorkspaceId": { "type": "string", "description": "ID of the target workspace of the move. I.e. the workspace that the base will belong to once the move is complete. The target workspace must be in the same enterprise account as the source workspace." } }, "required": [ "PCID", "workspaceId", "baseId", "targetWorkspaceId" ] } ``` *** ## airtable\_move\_user\_groups Move user groups **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `groupIds` | string\[] | Yes | — | ID of the groups to be moved. Up to 100 groupIds can be provided. | | `targetEnterpriseAccountId` | string | Yes | — | ID of the target enterprise account of the move. The target enterprise account must be in the same Hub-enabled organization as the source enterprise account, and you must have admin rights over the target enterprise account. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "groupIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the groups to be moved. Up to 100 groupIds can be provided." }, "targetEnterpriseAccountId": { "type": "string", "description": "ID of the target enterprise account of the move. The target enterprise account must be in the same Hub-enabled organization as the source enterprise account, and you must have admin rights over the target enterprise account." } }, "required": [ "PCID", "enterpriseAccountId", "groupIds", "targetEnterpriseAccountId" ] } ``` *** ## airtable\_move\_workspaces Move workspaces **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `replacementOwnerId` | string | No | — | If the target enterprise account has the invites settings restricted to org unit members, all non-member collaborators will be removed when the workspace are moved. If any workspace only has non-member owners, you must specify a replacementOwnerId to be added as the new owner of such workspaces. If no workspace has only non-member owners, replaceOwnerId is optional and will be ignored if provided. | | `targetEnterpriseAccountId` | string | Yes | — | ID of the target enterprise account of the move. The target enterprise account must be in the same Hub-enabled organization as the source enterprise account, and you must have admin rights over the target enterprise account. | | `workspaceIds` | string\[] | Yes | — | ID of the workspaces to be moved. Up to 100 workspaceIds can be provided. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "replacementOwnerId": { "type": "string", "description": "If the target enterprise account has the invites settings restricted to org unit members, all non-member collaborators will be removed when the workspace are moved. If any workspace only has non-member owners, you must specify a replacementOwnerId to be added as the new owner of such workspaces. If no workspace has only non-member owners, replaceOwnerId is optional and will be ignored if provided." }, "targetEnterpriseAccountId": { "type": "string", "description": "ID of the target enterprise account of the move. The target enterprise account must be in the same Hub-enabled organization as the source enterprise account, and you must have admin rights over the target enterprise account." }, "workspaceIds": { "type": "array", "items": { "type": "string" }, "description": "ID of the workspaces to be moved. Up to 100 workspaceIds can be provided." } }, "required": [ "PCID", "enterpriseAccountId", "targetEnterpriseAccountId", "workspaceIds" ] } ``` *** ## airtable\_post\_sync\_api\_endpoint Sync CSV data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | `apiEndpointSyncId` | string | Yes | — | Api Endpoint Sync Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "apiEndpointSyncId": { "type": "string", "description": "Api Endpoint Sync Id" } }, "required": [ "PCID", "baseId", "tableIdOrName", "apiEndpointSyncId" ] } ``` *** ## airtable\_refresh\_a\_webhook Refresh a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `webhookId` | string | Yes | — | Webhook Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "webhookId": { "type": "string", "description": "Webhook Id" } }, "required": [ "PCID", "baseId", "webhookId" ] } ``` *** ## airtable\_remove\_user\_from\_enterprise Remove user from enterprise **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | | `userId` | string | Yes | — | User Id | | | `isDryRun` | boolean | null | No | — | Is Dry Run | | `removeFromDescendants` | boolean | No | — | If true, removes the user from descendant enterprise accounts as well. Only enterprise accounts with the Enterprise Hub feature enabled have descendant enterprise accounts. | | | `replacementOwnerId` | string | null | No | — | If the user is the sole owner of any workspaces, you must specify a replacementOwnerId to be added as the new owner of such workspaces. If the user is not the sole owner of any workspaces, replacementOwnerId is optional and will be ignored if provided. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "userId": { "type": "string", "description": "User Id" }, "isDryRun": { "type": [ "boolean", "null" ], "description": "Is Dry Run" }, "removeFromDescendants": { "type": "boolean", "description": "If true, removes the user from descendant enterprise accounts as well. Only enterprise accounts with the Enterprise Hub feature enabled have descendant enterprise accounts." }, "replacementOwnerId": { "type": [ "string", "null" ], "description": "If the user is the sole owner of any workspaces, you must specify a replacementOwnerId to be added as the new owner of such workspaces. If the user is not the sole owner of any workspaces, replacementOwnerId is optional and will be ignored if provided." } }, "required": [ "PCID", "enterpriseAccountId", "userId" ] } ``` *** ## airtable\_revoke\_admin\_access Revoke admin access **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `users` | object\[] | Yes | — | The users value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "users": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The email value" }, "id": { "type": "string", "description": "A user ID" } } }, "description": "The users value" } }, "required": [ "PCID", "enterpriseAccountId", "users" ] } ``` *** ## airtable\_revoke\_enterprise\_personal\_access\_tokens Revoke personal access tokens **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `tokenIds` | string\[] | Yes | — | Token Ids | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "tokenIds": { "type": "array", "items": { "type": "string" }, "description": "Token Ids" } }, "required": [ "PCID", "enterpriseAccountId", "tokenIds" ] } ``` *** ## airtable\_update\_collaborator\_base\_permission Update collaborator base permission **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `userOrGroupId` | string | Yes | — | User Or Group Id | | `permissionLevel` | string | Yes | — | Permission Level | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" }, "permissionLevel": { "type": "string", "description": "Permission Level", "enum": [ "read", "comment", "edit", "create" ] } }, "required": [ "PCID", "baseId", "userOrGroupId", "permissionLevel" ] } ``` *** ## airtable\_update\_comment Update comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | `recordId` | string | Yes | — | Record Id | | `rowCommentId` | string | Yes | — | Row Comment Id | | `text` | string | Yes | — | The text value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "rowCommentId": { "type": "string", "description": "Row Comment Id" }, "text": { "type": "string", "description": "The text value" } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId", "rowCommentId", "text" ] } ``` *** ## airtable\_update\_field Update field **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableId` | string | Yes | — | Table Id | | `columnId` | string | Yes | — | Column Id | | `description` | string | No | — | The new description for the field (optional). If present, must be a string no longer than 20,000 characters. | | `name` | string | No | — | The new name for the field (optional). | | `options` | object | No | — | Type-specific field options to update. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableId": { "type": "string", "description": "Table Id" }, "columnId": { "type": "string", "description": "Column Id" }, "description": { "type": "string", "description": "The new description for the field (optional). If present, must be a string no longer than 20,000 characters." }, "name": { "type": "string", "description": "The new name for the field (optional)." }, "options": { "type": "object", "description": "Type-specific field options to update.", "properties": { "formula": { "type": "string", "description": "The new formula expression (formula fields only). Field references can use field IDs (e.g., {fldXXXXXXXXXXXXXX}) or field names (e.g., {My Field})." } } } }, "required": [ "PCID", "baseId", "tableId", "columnId" ] } ``` *** ## airtable\_update\_interface\_collaborator Update interface collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `pageBundleId` | string | Yes | — | Page Bundle Id | | `userOrGroupId` | string | Yes | — | User Or Group Id | | `permissionLevel` | string | Yes | — | Permission Level | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "pageBundleId": { "type": "string", "description": "Page Bundle Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" }, "permissionLevel": { "type": "string", "description": "Permission Level", "enum": [ "read", "comment", "edit" ] } }, "required": [ "PCID", "baseId", "pageBundleId", "userOrGroupId", "permissionLevel" ] } ``` *** ## airtable\_update\_multiple\_records Update multiple records **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | | `performUpsert` | object | No | — | Enables upsert behavior when set. **fieldsToMergeOn** will be used as an external ID to match records for updates. For records where no match is found, a new Airtable record will be created. | | | `records` | object\[] | Yes | — | The records value | | | `returnFieldsByFieldId` | boolean | null | No | — | If set to `true`, records in the API response will key the **fields** object by field ID. Defaults to `false` when unset, which returns **fields** objects keyed by field name. | | `typecast` | boolean | null | No | — | If set to `true`, Airtable will try to convert string values into the appropriate cell value. This conversion is only performed on a best-effort basis. To ensure your data's integrity, this should only be used when necessary. Defaults to `false` when unset. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "performUpsert": { "type": "object", "description": "Enables upsert behavior when set. **fieldsToMergeOn** will be used as an external ID to match records for updates. For records where no match is found, a new Airtable record will be created.", "properties": { "fieldsToMergeOn": { "type": "array", "items": { "type": "string" }, "description": "An array with at least one and at most three field names or IDs. IDs must uniquely identify a single record. These cannot be computed fields (formulas, lookups, rollups), and must be one of the following types: number, text, long text, single select, multiple select, date." } }, "required": [ "fieldsToMergeOn" ] }, "records": { "type": "array", "items": { "type": "object", "properties": { "fields": { "type": "object", "description": "The fields value" }, "id": { "type": "string", "description": "The ID of the record to update. Required when **performUpsert** is undefined." } }, "required": [ "fields" ] }, "description": "The records value" }, "returnFieldsByFieldId": { "type": [ "boolean", "null" ], "description": "If set to `true`, records in the API response will key the **fields** object by field ID. Defaults to `false` when unset, which returns **fields** objects keyed by field name." }, "typecast": { "type": [ "boolean", "null" ], "description": "If set to `true`, Airtable will try to convert string values into the appropriate cell value. This conversion is only performed on a best-effort basis. To ensure your data's integrity, this should only be used when necessary. Defaults to `false` when unset." } }, "required": [ "PCID", "baseId", "tableIdOrName", "records" ] } ``` *** ## airtable\_update\_record Update record **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | | `recordId` | string | Yes | — | Record Id | | | `fields` | object | Yes | — | The fields value | | | `returnFieldsByFieldId` | boolean | null | No | — | An optional boolean value that lets you return field objects keyed by the field id. This defaults to `false`, which returns field objects where the key is the field name. | | `typecast` | boolean | null | No | — | The Airtable API will perform best-effort automatic data conversion from string values if the typecast parameter is passed in. Automatic conversion is disabled by default to ensure data integrity, but it may be helpful for integrating with 3rd party data sources. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "recordId": { "type": "string", "description": "Record Id" }, "fields": { "type": "object", "description": "The fields value" }, "returnFieldsByFieldId": { "type": [ "boolean", "null" ], "description": "An optional boolean value that lets you return field objects keyed by the field id. This defaults to `false`, which returns field objects where the key is the field name." }, "typecast": { "type": [ "boolean", "null" ], "description": "The Airtable API will perform best-effort automatic data conversion from string values if the typecast parameter is passed in. Automatic conversion is disabled by default to ensure data integrity, but it may be helpful for integrating with 3rd party data sources." } }, "required": [ "PCID", "baseId", "tableIdOrName", "recordId", "fields" ] } ``` *** ## airtable\_update\_table Update table **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `baseId` | string | Yes | — | Base Id | | `tableIdOrName` | string | Yes | — | Table Id Or Name | | `dateDependencySettings` | object | No | — | Configuration for a table's date dependency settings. | | `description` | string | No | — | The new description for the table (optional). If present, must be a string no longer than 20,000 characters. | | `name` | string | No | — | The new name for the table (optional). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "baseId": { "type": "string", "description": "Base Id" }, "tableIdOrName": { "type": "string", "description": "Table Id Or Name" }, "dateDependencySettings": { "type": "object", "description": "Configuration for a table's date dependency settings.", "properties": { "durationFieldId": { "type": "string", "description": "Must be an editable number field with unit in days." }, "endDateFieldId": { "type": "string", "description": "Must be an editable Date field." }, "holidays": { "type": "array", "items": { "type": "string" }, "description": "Set of holidays dates to skip when recalculating. Each date should be ISO-formatted. Has no effect if shouldSkipWeekendsAndHolidays is false." }, "isEnabled": { "type": "boolean", "description": "Whether the date dependency settings are enabled." }, "isForwardOnly": { "type": "boolean", "description": "Is Forward Only" }, "predecessorFieldId": { "type": "string", "description": "If present, must be an editable linked record field pointing to the same table." }, "reschedulingMode": { "type": "string", "description": "Determines how tasks are rescheduled relative to their predecessors. [See support article](https://support.airtable.com/docs/date-dependencies-in-airtable#supported-date-dependency-behavior-in-airtable) for more.", "enum": [ "flexible", "fixed", "none" ] }, "shouldSkipWeekendsAndHolidays": { "type": "boolean", "description": "Whether to skip weekends and holidays when recalculating." }, "startDateFieldId": { "type": "string", "description": "Must be an editable Date field." } }, "required": [ "startDateFieldId", "endDateFieldId", "durationFieldId", "predecessorFieldId", "isEnabled", "shouldSkipWeekendsAndHolidays", "holidays", "reschedulingMode" ] }, "description": { "type": "string", "description": "The new description for the table (optional). If present, must be a string no longer than 20,000 characters." }, "name": { "type": "string", "description": "The new name for the table (optional)." } }, "required": [ "PCID", "baseId", "tableIdOrName" ] } ``` *** ## airtable\_update\_workspace\_ai\_allowlist Update workspace AI allowlist **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enterpriseAccountId` | string | Yes | — | Enterprise Account Id | | `includeDescendantWorkspaces` | boolean | No | — | Include Descendant Workspaces | | `workspaces` | object\[] | Yes | — | The workspaces value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enterpriseAccountId": { "type": "string", "description": "Enterprise Account Id" }, "includeDescendantWorkspaces": { "type": "boolean", "description": "Include Descendant Workspaces" }, "workspaces": { "type": "array", "items": { "type": "object", "properties": { "isAllowed": { "type": "boolean", "description": "Is Allowed" }, "workspaceId": { "type": "string", "description": "Workspace Id" } }, "required": [ "workspaceId", "isAllowed" ] }, "description": "The workspaces value" } }, "required": [ "PCID", "enterpriseAccountId", "workspaces" ] } ``` *** ## airtable\_update\_workspace\_collaborator Update workspace collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspaceId` | string | Yes | — | Workspace Id | | `userOrGroupId` | string | Yes | — | User Or Group Id | | `permissionLevel` | object | Yes | — | Permission Level | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "userOrGroupId": { "type": "string", "description": "User Or Group Id" }, "permissionLevel": { "description": "Permission Level" } }, "required": [ "PCID", "workspaceId", "userOrGroupId", "permissionLevel" ] } ``` *** ## airtable\_update\_workspace\_restrictions Update workspace restrictions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspaceId` | string | Yes | — | Workspace Id | | `inviteCreationRestriction` | string | No | — | Invite Creation Restriction | | `shareCreationRestriction` | string | No | — | Share Creation Restriction | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "Workspace Id" }, "inviteCreationRestriction": { "type": "string", "description": "Invite Creation Restriction", "enum": [ "unrestricted", "onlyOwners" ] }, "shareCreationRestriction": { "type": "string", "description": "Share Creation Restriction", "enum": [ "unrestricted", "onlyOwners" ] } }, "required": [ "PCID", "workspaceId" ] } ``` # airwatch Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/airwatch Enterprise mobility management **Server path:** `/airwatch` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`airwatch_get_applications`](#airwatch_get_applications) | Get list of managed applications | | [`airwatch_get_device`](#airwatch_get_device) | Get detailed information about a specific device | | [`airwatch_get_devices`](#airwatch_get_devices) | Get list of managed devices from AirWatch | | [`airwatch_get_profiles`](#airwatch_get_profiles) | Get list of device profiles | | [`airwatch_install_application`](#airwatch_install_application) | Install an application on a device | | [`airwatch_send_command`](#airwatch_send_command) | Send a command to a managed device | *** ## airwatch\_get\_applications Get list of managed applications **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `platform` | string | No | — | Filter by platform | | `type` | string | No | — | Filter by application type | | `limit` | number | No | `500` | Maximum number of applications to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "platform": { "type": "string", "enum": [ "iOS", "Android", "Windows" ], "description": "Filter by platform" }, "type": { "type": "string", "enum": [ "Internal", "Public", "Purchased" ], "description": "Filter by application type" }, "limit": { "type": "number", "default": 500, "description": "Maximum number of applications to return" } }, "required": [ "PCID" ] } ``` *** ## airwatch\_get\_device Get detailed information about a specific device **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deviceId` | string | Yes | — | Device ID to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "deviceId": { "type": "string", "description": "Device ID to retrieve" } }, "required": [ "PCID", "deviceId" ] } ``` *** ## airwatch\_get\_devices Get list of managed devices from AirWatch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `platform` | string | No | — | Filter by device platform | | `status` | string | No | — | Filter by device status | | `organizationGroupId` | string | No | — | Filter by organization group | | `limit` | number | No | `500` | Maximum number of devices to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "platform": { "type": "string", "enum": [ "iOS", "Android", "Windows", "macOS" ], "description": "Filter by device platform" }, "status": { "type": "string", "enum": [ "Enrolled", "Unenrolled", "Compromised" ], "description": "Filter by device status" }, "organizationGroupId": { "type": "string", "description": "Filter by organization group" }, "limit": { "type": "number", "default": 500, "description": "Maximum number of devices to return" } }, "required": [ "PCID" ] } ``` *** ## airwatch\_get\_profiles Get list of device profiles **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `platform` | string | No | — | Filter by platform | | `organizationGroupId` | string | No | — | Filter by organization group | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "platform": { "type": "string", "enum": [ "iOS", "Android", "Windows", "macOS" ], "description": "Filter by platform" }, "organizationGroupId": { "type": "string", "description": "Filter by organization group" } }, "required": [ "PCID" ] } ``` *** ## airwatch\_install\_application Install an application on a device **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deviceId` | string | Yes | — | Device ID to install app on | | `applicationId` | string | Yes | — | Application ID to install | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "deviceId": { "type": "string", "description": "Device ID to install app on" }, "applicationId": { "type": "string", "description": "Application ID to install" } }, "required": [ "PCID", "deviceId", "applicationId" ] } ``` *** ## airwatch\_send\_command Send a command to a managed device **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deviceId` | string | Yes | — | Device ID to send command to | | `command` | string | Yes | — | Command to send | | `pin` | string | No | — | PIN for device lock command | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "deviceId": { "type": "string", "description": "Device ID to send command to" }, "command": { "type": "string", "enum": [ "DeviceLock", "DeviceWipe", "EnterpriseWipe", "DeviceQuery", "ClearPasscode", "SyncDevice" ], "description": "Command to send" }, "pin": { "type": "string", "description": "PIN for device lock command" } }, "required": [ "PCID", "deviceId", "command" ] } ``` # aivoov Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/aivoov AiVOOV Text-to-Speech **Server path:** `/aivoov` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`aivoov_create_audio`](#aivoov_create_audio) | Generate audio from text | | [`aivoov_list_voices`](#aivoov_list_voices) | List available voices | *** ## aivoov\_create\_audio Generate audio from text **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `transcribe_ssml_pitch_rate` | integer | No | — | Pitch adjustment. Range: -50 to 50. Default: 0. | | `transcribe_ssml_spk_rate` | integer | No | — | Speaking rate adjustment. Range: 20 to 200. Default: 100. | | `transcribe_ssml_volume` | integer | No | — | Volume adjustment. Range: -40 to 40. Default: 0. | | `transcribe_text` | string | Yes | — | Text to synthesize into speech. Trial accounts have a 2000 word limit. | | `voice_id` | string | Yes | — | Voice identifier string. Use listVoices to discover available voice IDs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "transcribe_ssml_pitch_rate": { "type": "integer", "description": "Pitch adjustment. Range: -50 to 50. Default: 0." }, "transcribe_ssml_spk_rate": { "type": "integer", "description": "Speaking rate adjustment. Range: 20 to 200. Default: 100." }, "transcribe_ssml_volume": { "type": "integer", "description": "Volume adjustment. Range: -40 to 40. Default: 0." }, "transcribe_text": { "type": "string", "description": "Text to synthesize into speech. Trial accounts have a 2000 word limit." }, "voice_id": { "type": "string", "description": "Voice identifier string. Use listVoices to discover available voice IDs." } }, "required": [ "PCID", "transcribe_text", "voice_id" ] } ``` *** ## aivoov\_list\_voices List available voices **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `language_code` | string | No | — | Language code to filter voices (e.g., 'en-US', 'fr-FR'). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "language_code": { "type": "string", "description": "Language code to filter voices (e.g., 'en-US', 'fr-FR')." } }, "required": [ "PCID" ] } ``` # akeneo Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/akeneo Product information management **Server path:** `/akeneo` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`akeneo_create_product`](#akeneo_create_product) | Create a new Akeneo product | | [`akeneo_delete_product`](#akeneo_delete_product) | Delete an Akeneo product | | [`akeneo_get_product`](#akeneo_get_product) | Get details of a specific Akeneo product | | [`akeneo_list_products`](#akeneo_list_products) | List all Akeneo products with optional search filter | | [`akeneo_update_product`](#akeneo_update_product) | Update an existing Akeneo product | | [`akeneo_upload_asset_media`](#akeneo_upload_asset_media) | Upload an asset media file to Akeneo | *** ## akeneo\_create\_product Create a new Akeneo product **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Product identifier | | `family` | string | Yes | — | Product family | | `categories` | string\[] | No | — | Product categories | | `enabled` | boolean | No | — | Whether the product is enabled | | `values` | any | Yes | — | Product attribute values (at least one required) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "identifier": { "type": "string", "description": "Product identifier" }, "family": { "type": "string", "description": "Product family" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Product categories" }, "enabled": { "type": "boolean", "description": "Whether the product is enabled" }, "values": { "type": "effects", "description": "Product attribute values (at least one required)" } }, "required": [ "PCID", "identifier", "family", "values" ] } ``` *** ## akeneo\_delete\_product Delete an Akeneo product **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Product identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "identifier": { "type": "string", "description": "Product identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## akeneo\_get\_product Get details of a specific Akeneo product **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Product identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "identifier": { "type": "string", "description": "Product identifier" } }, "required": [ "PCID", "identifier" ] } ``` *** ## akeneo\_list\_products List all Akeneo products with optional search filter **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `searchFilter` | object | No | — | Optional search filter for products | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "searchFilter": { "type": "object", "additionalProperties": true, "description": "Optional search filter for products" } }, "required": [ "PCID" ] } ``` *** ## akeneo\_update\_product Update an existing Akeneo product **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | Product identifier | | `family` | string | No | — | Product family | | `categories` | string\[] | No | — | Product categories | | `enabled` | boolean | No | — | Whether the product is enabled | | `values` | object | No | — | Product attribute values to update | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "identifier": { "type": "string", "description": "Product identifier" }, "family": { "type": "string", "description": "Product family" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Product categories" }, "enabled": { "type": "boolean", "description": "Whether the product is enabled" }, "values": { "type": "object", "additionalProperties": true, "description": "Product attribute values to update" } }, "required": [ "PCID", "identifier" ] } ``` *** ## akeneo\_upload\_asset\_media Upload an asset media file to Akeneo **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `file` | any | Yes | — | File to upload | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "file": { "type": "effects", "description": "File to upload" } }, "required": [ "PCID", "file" ] } ``` # algolia Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/algolia Algolia Search **Server path:** `/algolia` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`algolia_add_api_key`](#algolia_add_api_key) | Create an API key | | [`algolia_add_or_update_object`](#algolia_add_or_update_object) | Add or replace a record | | [`algolia_append_source`](#algolia_append_source) | Add a source | | [`algolia_batch`](#algolia_batch) | Batch indexing operations on one index | | [`algolia_batch_dictionary_entries`](#algolia_batch_dictionary_entries) | Add or delete dictionary entries | | [`algolia_browse`](#algolia_browse) | Browse for records | | [`algolia_clear_objects`](#algolia_clear_objects) | Delete all records from an index | | [`algolia_clear_rules`](#algolia_clear_rules) | Delete all rules | | [`algolia_clear_synonyms`](#algolia_clear_synonyms) | Delete all synonyms | | [`algolia_delete_api_key`](#algolia_delete_api_key) | Delete an API key | | [`algolia_delete_by`](#algolia_delete_by) | Delete records matching a filter | | [`algolia_delete_index`](#algolia_delete_index) | Delete an index | | [`algolia_delete_object`](#algolia_delete_object) | Delete a record | | [`algolia_delete_rule`](#algolia_delete_rule) | Delete a rule | | [`algolia_delete_source`](#algolia_delete_source) | Delete a source | | [`algolia_delete_synonym`](#algolia_delete_synonym) | Delete a synonym | | [`algolia_get_api_key`](#algolia_get_api_key) | Retrieve API key permissions | | [`algolia_get_app_task`](#algolia_get_app_task) | Check application task status | | [`algolia_get_dictionary_languages`](#algolia_get_dictionary_languages) | List available languages | | [`algolia_get_dictionary_settings`](#algolia_get_dictionary_settings) | Retrieve dictionary settings | | [`algolia_get_logs`](#algolia_get_logs) | Retrieve log entries | | [`algolia_get_object`](#algolia_get_object) | Retrieve a record | | [`algolia_get_objects`](#algolia_get_objects) | Retrieve records | | [`algolia_get_rule`](#algolia_get_rule) | Retrieve a rule | | [`algolia_get_settings`](#algolia_get_settings) | Retrieve index settings | | [`algolia_get_sources`](#algolia_get_sources) | List allowed sources | | [`algolia_get_synonym`](#algolia_get_synonym) | Retrieve a synonym | | [`algolia_get_task`](#algolia_get_task) | Check task status | | [`algolia_list_api_keys`](#algolia_list_api_keys) | List API keys | | [`algolia_list_indices`](#algolia_list_indices) | List indices | | [`algolia_multiple_batch`](#algolia_multiple_batch) | Batch indexing operations on multiple indices | | [`algolia_operation_index`](#algolia_operation_index) | Copy or move an index | | [`algolia_partial_update_object`](#algolia_partial_update_object) | Add or update attributes | | [`algolia_replace_sources`](#algolia_replace_sources) | Replace allowed sources | | [`algolia_restore_api_key`](#algolia_restore_api_key) | Restore an API key | | [`algolia_save_object`](#algolia_save_object) | Add a new record (with auto-generated object ID) | | [`algolia_save_rule`](#algolia_save_rule) | Create or replace a rule | | [`algolia_save_rules`](#algolia_save_rules) | Create or update rules | | [`algolia_save_synonym`](#algolia_save_synonym) | Create or replace a synonym | | [`algolia_save_synonyms`](#algolia_save_synonyms) | Create or replace synonyms | | [`algolia_search`](#algolia_search) | Search multiple indices | | [`algolia_search_dictionary_entries`](#algolia_search_dictionary_entries) | Search dictionary entries | | [`algolia_search_for_facet_values`](#algolia_search_for_facet_values) | Search for facet values | | [`algolia_search_rules`](#algolia_search_rules) | Search for rules | | [`algolia_search_single_index`](#algolia_search_single_index) | Search an index | | [`algolia_search_synonyms`](#algolia_search_synonyms) | Search for synonyms | | [`algolia_set_dictionary_settings`](#algolia_set_dictionary_settings) | Update dictionary settings | | [`algolia_set_settings`](#algolia_set_settings) | Update index settings | | [`algolia_update_api_key`](#algolia_update_api_key) | Update an API key | *** ## algolia\_add\_api\_key Create an API key **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `acl` | string\[] | Yes | — | Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). | | `description` | string | No | — | Description of an API key to help you identify this API key. | | `indexes` | string\[] | No | — | Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with "dev\_" - `*_dev` matches all indices ending with "\_dev" - `*_products_*` matches all indices containing "*products*". | | `maxHitsPerQuery` | integer | No | — | Maximum number of results this API key can retrieve in one query. By default, there's no limit. | | `maxQueriesPerIPPerHour` | integer | No | — | Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there's no limit. | | `queryParameters` | string | No | — | Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range. | | `referers` | string\[] | No | — | Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`): - `https://algolia.com/*` allows all referrers starting with "[https://algolia.com/](https://algolia.com/)" - `*.algolia.com` allows all referrers ending with ".algolia.com" - `*algolia.com*` allows all referrers in the domain "algolia.com". Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions). | | `validity` | integer | No | — | Duration (in seconds) after which the API key expires. By default, API keys don't expire. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "acl": { "type": "array", "items": { "type": "string", "enum": [ "addObject", "analytics", "browse", "deleteObject", "deleteIndex", "editSettings", "inference", "listIndexes", "logs", "personalization", "recommendation", "search", "seeUnretrievableAttributes", "settings", "usage", "nluWriteProject", "nluReadProject", "nluWriteEntity", "nluReadEntity", "nluWriteIntent", "nluReadIntent", "nluPrediction", "nluReadAnswers" ] }, "description": "Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl)." }, "description": { "type": "string", "description": "Description of an API key to help you identify this API key." }, "indexes": { "type": "array", "items": { "type": "string" }, "description": "Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\"." }, "maxHitsPerQuery": { "type": "integer", "description": "Maximum number of results this API key can retrieve in one query. By default, there's no limit." }, "maxQueriesPerIPPerHour": { "type": "integer", "description": "Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there's no limit." }, "queryParameters": { "type": "string", "description": "Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range." }, "referers": { "type": "array", "items": { "type": "string" }, "description": "Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`): - `https://algolia.com/*` allows all referrers starting with \"https://algolia.com/\" - `*.algolia.com` allows all referrers ending with \".algolia.com\" - `*algolia.com*` allows all referrers in the domain \"algolia.com\". Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions)." }, "validity": { "type": "integer", "description": "Duration (in seconds) after which the API key expires. By default, API keys don't expire." } }, "required": [ "PCID", "acl" ] } ``` *** ## algolia\_add\_or\_update\_object Add or replace a record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique record identifier. | | `body` | object | Yes | — | The record. A schemaless object with attributes that are useful in the context of search and discovery. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique record identifier." }, "body": { "type": "object", "description": "The record. A schemaless object with attributes that are useful in the context of search and discovery." } }, "required": [ "PCID", "indexName", "objectID", "body" ] } ``` *** ## algolia\_append\_source Add a source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `description` | string | No | — | Source description. | | `source` | string | Yes | — | IP address range of the source. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "Source description." }, "source": { "type": "string", "description": "IP address range of the source." } }, "required": [ "PCID", "source" ] } ``` *** ## algolia\_batch Batch indexing operations on one index **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `requests` | object\[] | Yes | — | The requests value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "requests": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "addObject", "updateObject", "partialUpdateObject", "partialUpdateObjectNoCreate", "deleteObject", "delete", "clear" ], "description": "Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new record (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index. Equivalent to the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within records. Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to true. (If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false. (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete records from an index. Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to the \"Delete an index\" operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all records from an index operation\"." }, "body": { "type": "object", "description": "Operation arguments (varies with specified `action`)." } }, "required": [ "action", "body" ] }, "description": "The requests value" } }, "required": [ "PCID", "indexName", "requests" ] } ``` *** ## algolia\_batch\_dictionary\_entries Add or delete dictionary entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dictionaryName` | string | Yes | — | Dictionary type in which to search. | | `clearExistingDictionaryEntries` | boolean | No | — | Whether to replace all custom entries in the dictionary with the ones sent with this request. | | `requests` | object\[] | Yes | — | List of additions and deletions to your dictionaries. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dictionaryName": { "type": "string", "description": "Dictionary type in which to search.", "enum": [ "plurals", "stopwords", "compounds" ] }, "clearExistingDictionaryEntries": { "type": "boolean", "description": "Whether to replace all custom entries in the dictionary with the ones sent with this request." }, "requests": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "addEntry", "deleteEntry" ], "description": "Actions to perform." }, "body": { "type": "object", "description": "Dictionary entry." } }, "required": [ "action", "body" ] }, "description": "List of additions and deletions to your dictionaries." } }, "required": [ "PCID", "dictionaryName", "requests" ] } ``` *** ## algolia\_browse Browse for records **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `body` | object | No | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "body": { "description": "Request body" } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_clear\_objects Delete all records from an index **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_clear\_rules Delete all rules **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_clear\_synonyms Delete all synonyms **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_delete\_api\_key Delete an API key **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `key` | string | Yes | — | API key. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "API key." } }, "required": [ "PCID", "key" ] } ``` *** ## algolia\_delete\_by Delete records matching a filter **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `aroundLatLng` | string | No | — | Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. | | `aroundRadius` | object | No | — | Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates. | | `facetFilters` | object | No | — | Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\-value`. | | `filters` | string | No | — | Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true \| false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering). | | `insideBoundingBox` | object | No | — | Inside Bounding Box | | `insidePolygon` | any\[]\[] | No | — | Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`. | | `numericFilters` | object | No | — | Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. | | `tagFilters` | object | No | — | Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "aroundLatLng": { "type": "string", "description": "Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`." }, "aroundRadius": { "description": "Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates." }, "facetFilters": { "description": "Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`." }, "filters": { "type": "string", "description": "Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** ` `, where `` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `: TO `, where `` and `` are the lower and upper limits of the range (inclusive). - **Facet filters.** `:`, where `` is a facet attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering)." }, "insideBoundingBox": { "description": "Inside Bounding Box" }, "insidePolygon": { "type": "array", "items": { "type": "array" }, "description": "Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`." }, "numericFilters": { "description": "Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet: TO `. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`." }, "tagFilters": { "description": "Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_delete\_index Delete an index **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_delete\_object Delete a record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique record identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique record identifier." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_delete\_rule Delete a rule **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a rule object. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a rule object." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_delete\_source Delete a source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `source` | string | Yes | — | IP address range of the source. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "source": { "type": "string", "description": "IP address range of the source." } }, "required": [ "PCID", "source" ] } ``` *** ## algolia\_delete\_synonym Delete a synonym **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a synonym object. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a synonym object." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_get\_api\_key Retrieve API key permissions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `key` | string | Yes | — | API key. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "API key." } }, "required": [ "PCID", "key" ] } ``` *** ## algolia\_get\_app\_task Check application task status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `taskID` | integer | Yes | — | Unique task identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "taskID": { "type": "integer", "description": "Unique task identifier." } }, "required": [ "PCID", "taskID" ] } ``` *** ## algolia\_get\_dictionary\_languages List available languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## algolia\_get\_dictionary\_settings Retrieve dictionary settings ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## algolia\_get\_logs Retrieve log entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | First log entry to retrieve. The most recent entries are listed first. | | `length` | integer | No | — | Maximum number of entries to retrieve. | | `indexName` | string | No | — | Index for which to retrieve log entries. By default, log entries are retrieved for all indices. | | `type` | string | No | — | Type of log entries to retrieve. By default, all log entries are retrieved. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "First log entry to retrieve. The most recent entries are listed first." }, "length": { "type": "integer", "description": "Maximum number of entries to retrieve." }, "indexName": { "type": "string", "description": "Index for which to retrieve log entries. By default, log entries are retrieved for all indices." }, "type": { "type": "string", "description": "Type of log entries to retrieve. By default, all log entries are retrieved.", "enum": [ "all", "query", "build", "error" ] } }, "required": [ "PCID" ] } ``` *** ## algolia\_get\_object Retrieve a record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique record identifier. | | `attributesToRetrieve` | string\[] | No | — | Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique record identifier." }, "attributesToRetrieve": { "type": "array", "items": { "type": "string" }, "description": "Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_get\_objects Retrieve records **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `requests` | object\[] | Yes | — | The requests value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "requests": { "type": "array", "items": { "type": "object", "properties": { "attributesToRetrieve": { "type": "array", "items": { "type": "string" }, "description": "Attributes to retrieve. If not specified, all retrievable attributes are returned." }, "objectID": { "type": "string", "description": "Object ID for the record to retrieve." }, "indexName": { "type": "string", "description": "Index from which to retrieve the records." } }, "required": [ "objectID", "indexName" ] }, "description": "The requests value" } }, "required": [ "PCID", "requests" ] } ``` *** ## algolia\_get\_rule Retrieve a rule **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a rule object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a rule object." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_get\_settings Retrieve index settings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `getVersion` | integer | No | — | When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "getVersion": { "type": "integer", "description": "When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_get\_sources List allowed sources ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## algolia\_get\_synonym Retrieve a synonym **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a synonym object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a synonym object." } }, "required": [ "PCID", "indexName", "objectID" ] } ``` *** ## algolia\_get\_task Check task status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `taskID` | integer | Yes | — | Unique task identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "taskID": { "type": "integer", "description": "Unique task identifier." } }, "required": [ "PCID", "indexName", "taskID" ] } ``` *** ## algolia\_list\_api\_keys List API keys ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## algolia\_list\_indices List indices **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Requested page of the API response. If `null`, the API response is not paginated. | | `hitsPerPage` | integer | No | — | Number of hits per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Requested page of the API response. If `null`, the API response is not paginated." }, "hitsPerPage": { "type": "integer", "description": "Number of hits per page." } }, "required": [ "PCID" ] } ``` *** ## algolia\_multiple\_batch Batch indexing operations on multiple indices **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `requests` | object\[] | Yes | — | The requests value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "requests": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "addObject", "updateObject", "partialUpdateObject", "partialUpdateObjectNoCreate", "deleteObject", "delete", "clear" ], "description": "Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new record (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index. Equivalent to the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within records. Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to true. (If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false. (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete records from an index. Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to the \"Delete an index\" operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all records from an index operation\"." }, "body": { "type": "object", "description": "Operation arguments (varies with specified `action`)." }, "indexName": { "type": "string", "description": "Index name (case-sensitive)." } }, "required": [ "action", "indexName" ] }, "description": "The requests value" } }, "required": [ "PCID", "requests" ] } ``` *** ## algolia\_operation\_index Copy or move an index **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `destination` | string | Yes | — | Index name (case-sensitive). | | `operation` | string | Yes | — | Operation to perform on the index. | | `scope` | string\[] | No | — | **Only for copying.** If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged. If you omit the `scope` parameter, everything is copied: records, settings, synonyms, and rules. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "destination": { "type": "string", "description": "Index name (case-sensitive)." }, "operation": { "type": "string", "description": "Operation to perform on the index.", "enum": [ "move", "copy" ] }, "scope": { "type": "array", "items": { "type": "string", "enum": [ "settings", "synonyms", "rules" ] }, "description": "**Only for copying.** If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged. If you omit the `scope` parameter, everything is copied: records, settings, synonyms, and rules." } }, "required": [ "PCID", "indexName", "destination", "operation" ] } ``` *** ## algolia\_partial\_update\_object Add or update attributes **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique record identifier. | | `createIfNotExists` | boolean | No | — | Whether to create a new record if it doesn't exist. | | `body` | object | Yes | — | Attributes with their values. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique record identifier." }, "createIfNotExists": { "type": "boolean", "description": "Whether to create a new record if it doesn't exist." }, "body": { "type": "object", "description": "Attributes with their values." } }, "required": [ "PCID", "indexName", "objectID", "body" ] } ``` *** ## algolia\_replace\_sources Replace allowed sources **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object\[] | Yes | — | Allowed sources. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "description": "IP address range of the source." }, "description": { "type": "string", "description": "Source description." } }, "required": [ "source" ] }, "description": "Allowed sources." } }, "required": [ "PCID", "body" ] } ``` *** ## algolia\_restore\_api\_key Restore an API key **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `key` | string | Yes | — | API key. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "API key." } }, "required": [ "PCID", "key" ] } ``` *** ## algolia\_save\_object Add a new record (with auto-generated object ID) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `body` | object | Yes | — | The record. A schemaless object with attributes that are useful in the context of search and discovery. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "body": { "type": "object", "description": "The record. A schemaless object with attributes that are useful in the context of search and discovery." } }, "required": [ "PCID", "indexName", "body" ] } ``` *** ## algolia\_save\_rule Create or replace a rule **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a rule object. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | | `condition` | object | No | — | The condition value | | `conditions` | object\[] | No | — | Conditions that trigger a rule. Some consequences require specific conditions or don't require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions). | | `consequence` | object | Yes | — | Effect of the rule. For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences). | | `description` | string | No | — | Description of the rule's purpose to help you distinguish between different rules. | | `enabled` | boolean | No | — | Whether the rule is active. | | `scope` | string | No | — | The scope value | | `tags` | string\[] | No | — | The tags value | | `validity` | object\[] | No | — | Time periods when the rule is active. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a rule object." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." }, "condition": { "type": "object", "description": "The condition value", "properties": { "pattern": { "type": "string", "description": "Query pattern that triggers the rule. You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\"." }, "anchoring": { "type": "string", "description": "Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`.", "enum": [ "is", "startsWith", "endsWith", "contains" ] }, "alternatives": { "type": "boolean", "description": "Whether the pattern should match plurals, synonyms, and typos." }, "context": { "type": "string", "description": "An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters." }, "filters": { "type": "string", "description": "Filters that trigger the rule. You can add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter. You can't combine multiple filters with `OR` and you can't use numeric filters." } } }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "pattern": { "type": "string", "description": "Query pattern that triggers the rule. You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\"." }, "anchoring": { "type": "string", "enum": [ "is", "startsWith", "endsWith", "contains" ], "description": "Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`." }, "alternatives": { "type": "boolean", "description": "Whether the pattern should match plurals, synonyms, and typos." }, "context": { "type": "string", "description": "An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters." }, "filters": { "type": "string", "description": "Filters that trigger the rule. You can add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter. You can't combine multiple filters with `OR` and you can't use numeric filters." } } }, "description": "Conditions that trigger a rule. Some consequences require specific conditions or don't require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions)." }, "consequence": { "type": "object", "description": "Effect of the rule. For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).", "properties": { "params": { "description": "The params value" }, "promote": { "type": "array", "description": "Records you want to pin to a specific position in the search results. You can promote up to 300 records, either individually, or as groups of up to 100 records each." }, "filterPromotes": { "type": "boolean", "description": "Determines whether promoted records must also match active filters for the consequence to apply. This ensures user-applied filters take priority and irrelevant matches aren't shown. For example, if you promote a record with `color: red` but the user filters for `color: blue`, the \"red\" record won't be shown. > In the Algolia dashboard, when you use the **Pin an item** consequence, `filterPromotes` appears as the checkbox: **Pinned items must match active filters to be displayed.** For examples, see [Promote results with rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits/#promote-results-matching-active-filters)." }, "hide": { "type": "array", "items": { "type": "object" }, "description": "Records you want to hide from the search results." }, "redirect": { "type": "object", "description": "Redirect to a virtual replica index. This consequence is only valid for rules with `scope: redirect`." }, "userData": { "type": "object", "description": "A JSON object with custom data that will be appended to the `userData` array in the response. This object isn't interpreted by the API and is limited to 1 kB of minified JSON." } } }, "description": { "type": "string", "description": "Description of the rule's purpose to help you distinguish between different rules." }, "enabled": { "type": "boolean", "description": "Whether the rule is active." }, "scope": { "type": "string", "description": "The scope value" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "The tags value" }, "validity": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "integer", "format": "int64", "description": "Timestamp when the rule should start to be active, measured in seconds since the Unix epoch." }, "until": { "type": "integer", "format": "int64", "description": "Timestamp when the rule should stop to be active, measured in seconds since the Unix epoch." } } }, "description": "Time periods when the rule is active." } }, "required": [ "PCID", "indexName", "objectID", "consequence" ] } ``` *** ## algolia\_save\_rules Create or update rules **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | | `clearExistingRules` | boolean | No | — | Whether existing rules should be deleted before adding this batch. | | `body` | object\[] | Yes | — | Rules to add or replace. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." }, "clearExistingRules": { "type": "boolean", "description": "Whether existing rules should be deleted before adding this batch." }, "body": { "type": "array", "items": { "type": "object", "properties": { "objectID": { "type": "string", "description": "Unique identifier of a rule object." }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "pattern": { "type": "string", "description": "Query pattern that triggers the rule. You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\". " }, "anchoring": { "type": "string", "description": "Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`. " }, "alternatives": { "type": "boolean", "description": "Whether the pattern should match plurals, synonyms, and typos." }, "context": { "type": "string", "description": "An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters. " }, "filters": { "type": "string", "description": "Filters that trigger the rule. You can add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter. You can't combine multiple filters with `OR` and you can't use numeric filters. " } } }, "description": "Conditions that trigger a rule. Some consequences require specific conditions or don't require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions)." }, "consequence": { "type": "object", "description": "Effect of the rule. For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences)." }, "description": { "type": "string", "description": "Description of the rule's purpose to help you distinguish between different rules." }, "enabled": { "type": "boolean", "description": "Whether the rule is active." }, "validity": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "integer", "description": "Timestamp when the rule should start to be active, measured in seconds since the Unix epoch." }, "until": { "type": "integer", "description": "Timestamp when the rule should stop to be active, measured in seconds since the Unix epoch." } } }, "description": "Time periods when the rule is active." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "The tags value" }, "scope": { "type": "string", "description": "The scope value" }, "condition": { "type": "object", "description": "The condition value" } }, "required": [ "objectID", "consequence" ] }, "description": "Rules to add or replace." } }, "required": [ "PCID", "indexName", "body" ] } ``` *** ## algolia\_save\_synonym Create or replace a synonym **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `objectID` | string | Yes | — | Unique identifier of a synonym object. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | | `corrections` | string\[] | No | — | Words to be matched in records. | | `input` | string | No | — | Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms)). | | `placeholder` | string | No | — | [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders) to be put inside records. | | `replacements` | string\[] | No | — | Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders). | | `synonyms` | string\[] | No | — | Words or phrases considered equivalent. | | `type` | string | Yes | — | Synonym type. | | `word` | string | No | — | Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections)). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "objectID": { "type": "string", "description": "Unique identifier of a synonym object." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." }, "corrections": { "type": "array", "items": { "type": "string" }, "description": "Words to be matched in records." }, "input": { "type": "string", "description": "Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms))." }, "placeholder": { "type": "string", "description": "[Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders) to be put inside records." }, "replacements": { "type": "array", "items": { "type": "string" }, "description": "Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders)." }, "synonyms": { "type": "array", "items": { "type": "string" }, "description": "Words or phrases considered equivalent." }, "type": { "type": "string", "description": "Synonym type.", "enum": [ "synonym", "onewaysynonym", "altcorrection1", "altcorrection2", "placeholder", "oneWaySynonym", "altCorrection1", "altCorrection2" ] }, "word": { "type": "string", "description": "Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections))." } }, "required": [ "PCID", "indexName", "objectID", "type" ] } ``` *** ## algolia\_save\_synonyms Create or replace synonyms **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | | `replaceExistingSynonyms` | boolean | No | — | Whether to replace all synonyms in the index with the ones sent with this request. | | `body` | object\[] | Yes | — | Matching synonyms. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." }, "replaceExistingSynonyms": { "type": "boolean", "description": "Whether to replace all synonyms in the index with the ones sent with this request." }, "body": { "type": "array", "items": { "type": "object", "properties": { "objectID": { "type": "string", "description": "Unique identifier of a synonym object." }, "type": { "type": "string", "enum": [ "synonym", "onewaysynonym", "altcorrection1", "altcorrection2", "placeholder", "oneWaySynonym", "altCorrection1", "altCorrection2" ], "description": "Synonym type." }, "synonyms": { "type": "array", "items": { "type": "string" }, "description": "Words or phrases considered equivalent." }, "input": { "type": "string", "description": "Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms))." }, "word": { "type": "string", "description": "Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections))." }, "corrections": { "type": "array", "items": { "type": "string" }, "description": "Words to be matched in records." }, "placeholder": { "type": "string", "description": "[Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders) to be put inside records." }, "replacements": { "type": "array", "items": { "type": "string" }, "description": "Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders)." } }, "required": [ "objectID", "type" ] }, "description": "Matching synonyms." } }, "required": [ "PCID", "indexName", "body" ] } ``` *** ## algolia\_search Search multiple indices **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `requests` | any\[] | Yes | — | The requests value | | `strategy` | string | No | — | Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "requests": { "type": "array", "description": "The requests value" }, "strategy": { "type": "string", "description": "Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.", "enum": [ "none", "stopIfEnoughMatches" ] } }, "required": [ "PCID", "requests" ] } ``` *** ## algolia\_search\_dictionary\_entries Search dictionary entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dictionaryName` | string | Yes | — | Dictionary type in which to search. | | `hitsPerPage` | integer | No | — | Number of hits per page. | | `language` | string | No | — | ISO code for a supported language. | | `page` | integer | No | — | Page of search results to retrieve. | | `query` | string | Yes | — | Search query. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dictionaryName": { "type": "string", "description": "Dictionary type in which to search.", "enum": [ "plurals", "stopwords", "compounds" ] }, "hitsPerPage": { "type": "integer", "description": "Number of hits per page." }, "language": { "type": "string", "description": "ISO code for a supported language.", "enum": [ "af", "ar", "az", "bg", "bn", "ca", "cs", "cy", "da", "de", "el", "en", "eo", "es", "et", "eu", "fa", "fi", "fo", "fr", "ga", "gl", "he", "hi", "hu", "hy", "id", "is", "it", "ja", "ka", "kk", "ko", "ku", "ky", "lt", "lv", "mi", "mn", "mr", "ms", "mt", "nb", "nl", "no", "ns", "pl", "ps", "pt", "pt-br", "qu", "ro", "ru", "sk", "sq", "sv", "sw", "ta", "te", "th", "tl", "tn", "tr", "tt", "uk", "ur", "uz", "zh" ] }, "page": { "type": "integer", "description": "Page of search results to retrieve." }, "query": { "type": "string", "description": "Search query." } }, "required": [ "PCID", "dictionaryName", "query" ] } ``` *** ## algolia\_search\_for\_facet\_values Search for facet values **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `facetName` | string | Yes | — | Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. | | `facetQuery` | string | No | — | Text to search inside the facet's values. | | `maxFacetHits` | integer | No | — | Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). | | `params` | string | No | — | Search parameters as a URL-encoded query string. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "facetName": { "type": "string", "description": "Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier." }, "facetQuery": { "type": "string", "description": "Text to search inside the facet's values." }, "maxFacetHits": { "type": "integer", "description": "Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values)." }, "params": { "type": "string", "description": "Search parameters as a URL-encoded query string." } }, "required": [ "PCID", "indexName", "facetName" ] } ``` *** ## algolia\_search\_rules Search for rules **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | | `anchoring` | string | No | — | Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`. | | | `context` | string | No | — | Only return rules that match the context (exact match). | | | `enabled` | boolean | null | No | — | If `true`, return only enabled rules. If `false`, return only inactive rules. By default, *all* rules are returned. | | `hitsPerPage` | integer | No | — | Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)). - `hitsPerPage`: sets the number of search results (*hits*) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. | | | `page` | integer | No | — | Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)). - `hitsPerPage`: sets the number of search results (*hits*) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. | | | `query` | string | No | — | Search query for rules. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "anchoring": { "type": "string", "description": "Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`.", "enum": [ "is", "startsWith", "endsWith", "contains" ] }, "context": { "type": "string", "description": "Only return rules that match the context (exact match)." }, "enabled": { "type": [ "boolean", "null" ], "description": "If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned." }, "hitsPerPage": { "type": "integer", "description": "Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2." }, "page": { "type": "integer", "description": "Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2." }, "query": { "type": "string", "description": "Search query for rules." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_search\_single\_index Search an index **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `body` | object | No | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "body": { "description": "Request body" } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_search\_synonyms Search for synonyms **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `hitsPerPage` | integer | No | — | Number of hits per page. | | `page` | integer | No | — | Page of search results to retrieve. | | `query` | string | No | — | Search query. | | `type` | string | No | — | Synonym type. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "hitsPerPage": { "type": "integer", "description": "Number of hits per page." }, "page": { "type": "integer", "description": "Page of search results to retrieve." }, "query": { "type": "string", "description": "Search query." }, "type": { "type": "string", "description": "Synonym type.", "enum": [ "synonym", "onewaysynonym", "altcorrection1", "altcorrection2", "placeholder", "oneWaySynonym", "altCorrection1", "altCorrection2" ] } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_set\_dictionary\_settings Update dictionary settings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `disableStandardEntries` | object | Yes | — | Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) and boolean values. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "disableStandardEntries": { "type": "object", "description": "Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) and boolean values.", "properties": { "plurals": { "type": "object", "description": "Key-value pair of a language ISO code and a boolean value." }, "stopwords": { "type": "object", "description": "Key-value pair of a language ISO code and a boolean value." }, "compounds": { "type": "object", "description": "Key-value pair of a language ISO code and a boolean value." } } } }, "required": [ "PCID", "disableStandardEntries" ] } ``` *** ## algolia\_set\_settings Update index settings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `indexName` | string | Yes | — | Name of the index on which to perform the operation. | | `forwardToReplicas` | boolean | No | — | Whether changes are applied to replica indices. | | `advancedSyntax` | boolean | No | — | Whether to support phrase matching and excluding words from search queries Use the `advancedSyntaxFeatures` parameter to control which feature is supported. | | `advancedSyntaxFeatures` | string\[] | No | — | Advanced search syntax features you want to support - `exactPhrase`. Phrases in quotes must match exactly. For example, `sparkly blue "iPhone case"` only returns records with the exact string "iPhone case" - `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain "search" but not "engine" This setting only has an effect if `advancedSyntax` is true. | | `allowCompressionOfIntegerArray` | boolean | No | — | Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered. | | `allowTyposOnNumericTokens` | boolean | No | — | Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers. | | `alternativesAsExact` | string\[] | No | — | Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example - "swimsuit" and "swimsuits" are treated the same - "swimsuit" and "swimwear" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)) - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches - `singleWordSynonym`. Single-word synonyms, such as "NY" = "NYC", are considered exact matches - `multiWordsSynonym`. Multi-word synonyms, such as "NY" = "New York", are considered exact matches. | | `attributeCriteriaComputedByMinProximity` | boolean | No | — | Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting. | | `attributeForDistinct` | string | No | — | Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting *after* deduplication, which will result in accurate facet counts. | | `attributesForFaceting` | string\[] | No | — | Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly("ATTRIBUTE")`. Allows the attribute to be used as a filter but doesn't evaluate the facet values. - `searchable("ATTRIBUTE")`. Allows searching for facet values. - `afterDistinct("ATTRIBUTE")`. Evaluates the facet count *after* deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. | | `attributesToHighlight` | string\[] | No | — | Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js). | | `attributesToRetrieve` | string\[] | No | — | Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `["*", "-ATTRIBUTE"]`. - The `objectID` attribute is always included. | | `attributesToSnippet` | string\[] | No | — | Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted. | | `attributesToTransliterate` | string\[] | No | — | Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive. | | `camelCaseAttributes` | string\[] | No | — | Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive. | | `customNormalization` | object | No | — | Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization). | | `customRanking` | string\[] | No | — | Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc("ATTRIBUTE")`. Sort the index by the values of an attribute, in ascending order. - `desc("ATTRIBUTE")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision) of your first attributes, or the other attributes will never be applied. | | `decompoundedAttributes` | object | No | — | Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, "firefighter". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). | | `decompoundQuery` | boolean | No | — | Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). | | `disableExactOnAttributes` | string\[] | No | — | Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking. | | `disablePrefixOnAttributes` | string\[] | No | — | Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive. | | `disableTypoToleranceOnAttributes` | string\[] | No | — | Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance). Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos. | | `disableTypoToleranceOnWords` | string\[] | No | — | Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) for the specified words. | | `distinct` | object | No | — | Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. | | `enablePersonalization` | boolean | No | — | Whether to enable Personalization. | | `enableReRanking` | boolean | No | — | Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard. | | `enableRules` | boolean | No | — | Whether to enable rules. | | `exactOnSingleWordQuery` | string | No | — | Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for "road" will match the value "road", but not "road trip". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. | | `highlightPostTag` | string | No | — | HTML tag to insert after the highlighted parts in all highlighted results and snippets. | | `highlightPreTag` | string | No | — | HTML tag to insert before the highlighted parts in all highlighted results and snippets. | | `hitsPerPage` | integer | No | — | Number of hits per page. | | `ignorePlurals` | object | No | — | Treat singular, plurals, and other forms of declensions as equivalent. Only use this feature for the languages used in your index. | | `indexLanguages` | string\[] | No | — | Languages for language-specific processing steps, such as word detection and dictionary settings. **Always specify an indexing language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations). | | `keepDiacriticsOnCharacters` | string | No | — | Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics. | | `maxFacetHits` | integer | No | — | Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). | | `maxValuesPerFacet` | integer | No | — | Maximum number of facet values to return for each facet. | | `minProximity` | integer | No | — | Minimum proximity score for two matching words This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score. | | `minWordSizefor1Typo` | integer | No | — | Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos). | | `minWordSizefor2Typos` | integer | No | — | Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos). | | `mode` | string | No | — | Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you. | | `numericAttributesForFiltering` | string\[] | No | — | Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. To turn off filtering for all numeric attributes, specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly("ATTRIBUTE")`. Support only filtering based on equality comparisons `=` and `!=`. | | `optionalWords` | object | No | — | Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is "action video" and "video" is optional, the search engine runs two queries: one for "action video" and one for "action". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has fewer than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 2 matched words. - If `optionalWords` has 10 or more words, the required number of matched words increases by the number of optional words divided by 5 (rounded down). Example: with 18 optional words, results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). | | `paginationLimitedTo` | integer | No | — | Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed. | | `queryLanguages` | string\[] | No | — | Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, place the CJK language **first**. **Always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations). | | `queryType` | string | No | — | Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching). | | `ranking` | string\[] | No | — | Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc("ATTRIBUTE")`. Sort the index by the values of an attribute, in ascending order. - `desc("ATTRIBUTE")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing). | | `relevancyStrictness` | integer | No | — | Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. | | `removeStopWords` | object | No | — | Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, "the", "a", or "and" are stop words. Only use this feature for the languages used in your index. | | `removeWordsIfNoResults` | string | No | — | Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results). | | `renderingContent` | object | No | — | Extra data that can be used in the search UI. You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code. | | `replaceSynonymsInHighlight` | boolean | No | — | Whether to replace a highlighted word with the matched synonym By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either "home" or "house" are included in the search results, and either "home" or "house" are highlighted With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurrences of "house" are replaced by "home" in the highlighted response. | | `replicas` | string\[] | No | — | Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index. **Modifier** - `virtual("REPLICA")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort). | | `reRankingApplyFilter` | object | No | — | Re Ranking Apply Filter | | `responseFields` | string\[] | No | — | Properties to include in the API response of search and browse requests By default, all response properties are included. To reduce the response size, you can select which properties should be included An empty list may lead to an empty API response (except properties you can't exclude) You can't exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true Your search depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience. | | `restrictHighlightAndSnippetArrays` | boolean | No | — | Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted. | | `searchableAttributes` | string\[] | No | — | Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `"title,alternate_title"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes). **Modifier** - `unordered("ATTRIBUTE")`. Ignore the position of a match within the attribute. Without a modifier, matches at the beginning of an attribute rank higher than matches at the end. | | `semanticSearch` | object | No | — | Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`. | | `separatorsToIndex` | string | No | — | Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as \$€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for "Disney+", Algolia considers "Disney" and "+" as two separate words. | | `snippetEllipsisText` | string | No | — | String used as an ellipsis indicator when a snippet is truncated. | | `sortFacetValuesBy` | string | No | — | Order in which to retrieve facet values - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value - `alpha`. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js). | | `typoTolerance` | object | No | — | Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) are also active. | | `unretrievableAttributes` | string\[] | No | — | Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data), but don't want to include it in the search results. Attribute names are case-sensitive. | | `userData` | object | No | — | An object with custom data. You can store up to 32kB as custom data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "indexName": { "type": "string", "description": "Name of the index on which to perform the operation." }, "forwardToReplicas": { "type": "boolean", "description": "Whether changes are applied to replica indices." }, "advancedSyntax": { "type": "boolean", "description": "Whether to support phrase matching and excluding words from search queries Use the `advancedSyntaxFeatures` parameter to control which feature is supported." }, "advancedSyntaxFeatures": { "type": "array", "items": { "type": "string", "enum": [ "exactPhrase", "excludeWords" ] }, "description": "Advanced search syntax features you want to support - `exactPhrase`. Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\" - `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\" This setting only has an effect if `advancedSyntax` is true." }, "allowCompressionOfIntegerArray": { "type": "boolean", "description": "Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered." }, "allowTyposOnNumericTokens": { "type": "boolean", "description": "Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers." }, "alternativesAsExact": { "type": "array", "items": { "type": "string", "enum": [ "ignorePlurals", "singleWordSynonym", "multiWordsSynonym", "ignoreConjugations" ] }, "description": "Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)) - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches." }, "attributeCriteriaComputedByMinProximity": { "type": "boolean", "description": "Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting." }, "attributeForDistinct": { "type": "string", "description": "Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts." }, "attributesForFaceting": { "type": "array", "items": { "type": "string" }, "description": "Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as a filter but doesn't evaluate the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`." }, "attributesToHighlight": { "type": "array", "items": { "type": "string" }, "description": "Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js)." }, "attributesToRetrieve": { "type": "array", "items": { "type": "string" }, "description": "Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included." }, "attributesToSnippet": { "type": "array", "items": { "type": "string" }, "description": "Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted." }, "attributesToTransliterate": { "type": "array", "items": { "type": "string" }, "description": "Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive." }, "camelCaseAttributes": { "type": "array", "items": { "type": "string" }, "description": "Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive." }, "customNormalization": { "type": "object", "description": "Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization)." }, "customRanking": { "type": "array", "items": { "type": "string" }, "description": "Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision) of your first attributes, or the other attributes will never be applied." }, "decompoundedAttributes": { "type": "object", "description": "Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308)." }, "decompoundQuery": { "type": "boolean", "description": "Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308)." }, "disableExactOnAttributes": { "type": "array", "items": { "type": "string" }, "description": "Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking." }, "disablePrefixOnAttributes": { "type": "array", "items": { "type": "string" }, "description": "Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive." }, "disableTypoToleranceOnAttributes": { "type": "array", "items": { "type": "string" }, "description": "Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance). Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos." }, "disableTypoToleranceOnWords": { "type": "array", "items": { "type": "string" }, "description": "Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) for the specified words." }, "distinct": { "description": "Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set." }, "enablePersonalization": { "type": "boolean", "description": "Whether to enable Personalization." }, "enableReRanking": { "type": "boolean", "description": "Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard." }, "enableRules": { "type": "boolean", "description": "Whether to enable rules." }, "exactOnSingleWordQuery": { "type": "string", "description": "Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't.", "enum": [ "attribute", "none", "word" ] }, "highlightPostTag": { "type": "string", "description": "HTML tag to insert after the highlighted parts in all highlighted results and snippets." }, "highlightPreTag": { "type": "string", "description": "HTML tag to insert before the highlighted parts in all highlighted results and snippets." }, "hitsPerPage": { "type": "integer", "description": "Number of hits per page." }, "ignorePlurals": { "description": "Treat singular, plurals, and other forms of declensions as equivalent. Only use this feature for the languages used in your index." }, "indexLanguages": { "type": "array", "items": { "type": "string", "enum": [ "af", "ar", "az", "bg", "bn", "ca", "cs", "cy", "da", "de", "el", "en", "eo", "es", "et", "eu", "fa", "fi", "fo", "fr", "ga", "gl", "he", "hi", "hu", "hy", "id", "is", "it", "ja", "ka", "kk", "ko", "ku", "ky", "lt", "lv", "mi", "mn", "mr", "ms", "mt", "nb", "nl", "no", "ns", "pl", "ps", "pt", "pt-br", "qu", "ro", "ru", "sk", "sq", "sv", "sw", "ta", "te", "th", "tl", "tn", "tr", "tt", "uk", "ur", "uz", "zh" ] }, "description": "Languages for language-specific processing steps, such as word detection and dictionary settings. **Always specify an indexing language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations)." }, "keepDiacriticsOnCharacters": { "type": "string", "description": "Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics." }, "maxFacetHits": { "type": "integer", "description": "Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values)." }, "maxValuesPerFacet": { "type": "integer", "description": "Maximum number of facet values to return for each facet." }, "minProximity": { "type": "integer", "description": "Minimum proximity score for two matching words This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score." }, "minWordSizefor1Typo": { "type": "integer", "description": "Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos)." }, "minWordSizefor2Typos": { "type": "integer", "description": "Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos)." }, "mode": { "type": "string", "description": "Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you.", "enum": [ "neuralSearch", "keywordSearch" ] }, "numericAttributesForFiltering": { "type": "array", "items": { "type": "string" }, "description": "Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. To turn off filtering for all numeric attributes, specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`." }, "optionalWords": { "description": "Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is optional, the search engine runs two queries: one for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has fewer than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 2 matched words. - If `optionalWords` has 10 or more words, the required number of matched words increases by the number of optional words divided by 5 (rounded down). Example: with 18 optional words, results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words)." }, "paginationLimitedTo": { "type": "integer", "description": "Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed." }, "queryLanguages": { "type": "array", "items": { "type": "string", "enum": [ "af", "ar", "az", "bg", "bn", "ca", "cs", "cy", "da", "de", "el", "en", "eo", "es", "et", "eu", "fa", "fi", "fo", "fr", "ga", "gl", "he", "hi", "hu", "hy", "id", "is", "it", "ja", "ka", "kk", "ko", "ku", "ky", "lt", "lv", "mi", "mn", "mr", "ms", "mt", "nb", "nl", "no", "ns", "pl", "ps", "pt", "pt-br", "qu", "ro", "ru", "sk", "sq", "sv", "sw", "ta", "te", "th", "tl", "tn", "tr", "tt", "uk", "ur", "uz", "zh" ] }, "description": "Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, place the CJK language **first**. **Always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations)." }, "queryType": { "type": "string", "description": "Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching).", "enum": [ "prefixLast", "prefixAll", "prefixNone" ] }, "ranking": { "type": "array", "items": { "type": "string" }, "description": "Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing)." }, "relevancyStrictness": { "type": "integer", "description": "Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results." }, "removeStopWords": { "description": "Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. Only use this feature for the languages used in your index." }, "removeWordsIfNoResults": { "type": "string", "description": "Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results).", "enum": [ "none", "lastWords", "firstWords", "allOptional" ] }, "renderingContent": { "type": "object", "description": "Extra data that can be used in the search UI. You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code.", "properties": { "facetOrdering": { "type": "object", "description": "Order of facet names and facet values in your UI." }, "redirect": { "type": "object", "description": "The redirect rule container." }, "widgets": { "type": "object", "description": "Widgets returned from any rules that are applied to the current search." } } }, "replaceSynonymsInHighlight": { "type": "boolean", "description": "Whether to replace a highlighted word with the matched synonym By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurrences of \"house\" are replaced by \"home\" in the highlighted response." }, "replicas": { "type": "array", "items": { "type": "string" }, "description": "Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort)." }, "reRankingApplyFilter": { "description": "Re Ranking Apply Filter" }, "responseFields": { "type": "array", "items": { "type": "string" }, "description": "Properties to include in the API response of search and browse requests By default, all response properties are included. To reduce the response size, you can select which properties should be included An empty list may lead to an empty API response (except properties you can't exclude) You can't exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true Your search depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience." }, "restrictHighlightAndSnippetArrays": { "type": "boolean", "description": "Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted." }, "searchableAttributes": { "type": "array", "items": { "type": "string" }, "description": "Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without a modifier, matches at the beginning of an attribute rank higher than matches at the end." }, "semanticSearch": { "type": "object", "description": "Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.", "properties": { "eventSources": { "type": "array", "items": { "type": "string" }, "description": "Indices from which to collect click and conversion events. If null, the current index and all its replicas are used." } } }, "separatorsToIndex": { "type": "string", "description": "Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words." }, "snippetEllipsisText": { "type": "string", "description": "String used as an ellipsis indicator when a snippet is truncated." }, "sortFacetValuesBy": { "type": "string", "description": "Order in which to retrieve facet values - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value - `alpha`. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js)." }, "typoTolerance": { "description": "Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) are also active." }, "unretrievableAttributes": { "type": "array", "items": { "type": "string" }, "description": "Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data), but don't want to include it in the search results. Attribute names are case-sensitive." }, "userData": { "description": "An object with custom data. You can store up to 32kB as custom data." } }, "required": [ "PCID", "indexName" ] } ``` *** ## algolia\_update\_api\_key Update an API key **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `key` | string | Yes | — | API key. | | `acl` | string\[] | Yes | — | Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). | | `description` | string | No | — | Description of an API key to help you identify this API key. | | `indexes` | string\[] | No | — | Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with "dev\_" - `*_dev` matches all indices ending with "\_dev" - `*_products_*` matches all indices containing "*products*". | | `maxHitsPerQuery` | integer | No | — | Maximum number of results this API key can retrieve in one query. By default, there's no limit. | | `maxQueriesPerIPPerHour` | integer | No | — | Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there's no limit. | | `queryParameters` | string | No | — | Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range. | | `referers` | string\[] | No | — | Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`): - `https://algolia.com/*` allows all referrers starting with "[https://algolia.com/](https://algolia.com/)" - `*.algolia.com` allows all referrers ending with ".algolia.com" - `*algolia.com*` allows all referrers in the domain "algolia.com". Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions). | | `validity` | integer | No | — | Duration (in seconds) after which the API key expires. By default, API keys don't expire. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "key": { "type": "string", "description": "API key." }, "acl": { "type": "array", "items": { "type": "string", "enum": [ "addObject", "analytics", "browse", "deleteObject", "deleteIndex", "editSettings", "inference", "listIndexes", "logs", "personalization", "recommendation", "search", "seeUnretrievableAttributes", "settings", "usage", "nluWriteProject", "nluReadProject", "nluWriteEntity", "nluReadEntity", "nluWriteIntent", "nluReadIntent", "nluPrediction", "nluReadAnswers" ] }, "description": "Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl)." }, "description": { "type": "string", "description": "Description of an API key to help you identify this API key." }, "indexes": { "type": "array", "items": { "type": "string" }, "description": "Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\"." }, "maxHitsPerQuery": { "type": "integer", "description": "Maximum number of results this API key can retrieve in one query. By default, there's no limit." }, "maxQueriesPerIPPerHour": { "type": "integer", "description": "Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there's no limit." }, "queryParameters": { "type": "string", "description": "Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range." }, "referers": { "type": "array", "items": { "type": "string" }, "description": "Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`): - `https://algolia.com/*` allows all referrers starting with \"https://algolia.com/\" - `*.algolia.com` allows all referrers ending with \".algolia.com\" - `*algolia.com*` allows all referrers in the domain \"algolia.com\". Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions)." }, "validity": { "type": "integer", "description": "Duration (in seconds) after which the API key expires. By default, API keys don't expire." } }, "required": [ "PCID", "key", "acl" ] } ``` # amazon-s3 Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/amazon-s3 Buckets, objects, and presigned URLs **Server path:** `/amazon-s3` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`amazon-s3_copy_object`](#amazon-s3_copy_object) | Copy an object from one S3 location to another | | [`amazon-s3_create_folder`](#amazon-s3_create_folder) | Create an empty folder in an S3 bucket | | [`amazon-s3_delete_file`](#amazon-s3_delete_file) | Delete a file from S3 | | [`amazon-s3_delete_folder`](#amazon-s3_delete_folder) | Delete a folder and all its contents from S3 | | [`amazon-s3_download_file`](#amazon-s3_download_file) | Download a file from S3. IN WORKFLOWS: Files are automatically saved to Node Outputs - no manual save step needed. By default, automatically extracts text from supported document formats (PDF, DOCX, PPTX, XLSX) and includes it in the response. Text files (TXT, CSV) do not need extraction. STREAMING IS PREFERRED: Use stream=true (default) to get a pre-signed downloadUrl for efficient downloading of large files. Only use stream=false for small files (\<2MB) that need immediate processing. | | [`amazon-s3_get_presigned_url`](#amazon-s3_get_presigned_url) | Generate a pre-signed URL for temporary access to an S3 object | | [`amazon-s3_list_buckets`](#amazon-s3_list_buckets) | List all buckets in your S3 account | | [`amazon-s3_list_folder`](#amazon-s3_list_folder) | List contents of a specific folder in a bucket, showing both files and subfolders | | [`amazon-s3_list_objects`](#amazon-s3_list_objects) | List objects within a bucket with optional prefix and delimiter | | [`amazon-s3_upload_file`](#amazon-s3_upload_file) | Upload a file to S3 from a URL source | *** ## amazon-s3\_copy\_object Copy an object from one S3 location to another **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sourceBucket` | string | Yes | — | Name of the source S3 bucket | | `sourceKey` | string | Yes | — | Source object key/path | | `destinationBucket` | string | Yes | — | Name of the destination S3 bucket | | `destinationKey` | string | Yes | — | Destination object key/path | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "sourceBucket": { "type": "string", "description": "Name of the source S3 bucket" }, "sourceKey": { "type": "string", "description": "Source object key/path" }, "destinationBucket": { "type": "string", "description": "Name of the destination S3 bucket" }, "destinationKey": { "type": "string", "description": "Destination object key/path" } }, "required": [ "PCID", "sourceBucket", "sourceKey", "destinationBucket", "destinationKey" ] } ``` *** ## amazon-s3\_create\_folder Create an empty folder in an S3 bucket **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucket` | string | Yes | — | Name of the S3 bucket | | `folderName` | string | Yes | — | Name of the folder to create | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "bucket": { "type": "string", "description": "Name of the S3 bucket" }, "folderName": { "type": "string", "description": "Name of the folder to create" } }, "required": [ "PCID", "bucket", "folderName" ] } ``` *** ## amazon-s3\_delete\_file Delete a file from S3 **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucket` | string | Yes | — | Name of the S3 bucket | | `key` | string | Yes | — | Object key/path of the file to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "bucket": { "type": "string", "description": "Name of the S3 bucket" }, "key": { "type": "string", "description": "Object key/path of the file to delete" } }, "required": [ "PCID", "bucket", "key" ] } ``` *** ## amazon-s3\_delete\_folder Delete a folder and all its contents from S3 **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucket` | string | Yes | — | Name of the S3 bucket | | `folderName` | string | Yes | — | Name of the folder to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "bucket": { "type": "string", "description": "Name of the S3 bucket" }, "folderName": { "type": "string", "description": "Name of the folder to delete" } }, "required": [ "PCID", "bucket", "folderName" ] } ``` *** ## amazon-s3\_download\_file Download a file from S3. IN WORKFLOWS: Files are automatically saved to Node Outputs - no manual save step needed. By default, automatically extracts text from supported document formats (PDF, DOCX, PPTX, XLSX) and includes it in the response. Text files (TXT, CSV) do not need extraction. STREAMING IS PREFERRED: Use stream=true (default) to get a pre-signed downloadUrl for efficient downloading of large files. Only use stream=false for small files (\<2MB) that need immediate processing. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucket` | string | Yes | — | Name of the S3 bucket | | `key` | string | Yes | — | Object key/path of the file to download | | `stream` | boolean | No | `true` | RECOMMENDED: true (default). Returns a pre-signed downloadUrl for efficient streaming. Set to false only for small files (\<2MB) requiring immediate base64 content. | | `expiresIn` | number | No | `3600` | Expiration time for the pre-signed URL in seconds (default: 3600 = 1 hour). Only used when stream is true. | | `extractText` | boolean | No | `true` | Automatically extracts text from supported formats (PDF, DOCX, PPTX, XLSX) and includes it in the response. Text files do not need extraction. Set to false to skip extraction. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "bucket": { "type": "string", "description": "Name of the S3 bucket" }, "key": { "type": "string", "description": "Object key/path of the file to download" }, "stream": { "type": "boolean", "default": true, "description": "RECOMMENDED: true (default). Returns a pre-signed downloadUrl for efficient streaming. Set to false only for small files (<2MB) requiring immediate base64 content." }, "expiresIn": { "type": "number", "default": 3600, "description": "Expiration time for the pre-signed URL in seconds (default: 3600 = 1 hour). Only used when stream is true." }, "extractText": { "type": "boolean", "default": true, "description": "Automatically extracts text from supported formats (PDF, DOCX, PPTX, XLSX) and includes it in the response. Text files do not need extraction. Set to false to skip extraction." } }, "required": [ "PCID", "bucket", "key" ] } ``` *** ## amazon-s3\_get\_presigned\_url Generate a pre-signed URL for temporary access to an S3 object **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucket` | string | Yes | — | Name of the S3 bucket | | `key` | string | Yes | — | Object key/path of the file | | `expiresIn` | number | No | `3600` | URL expiration time in seconds (default: 3600) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "bucket": { "type": "string", "description": "Name of the S3 bucket" }, "key": { "type": "string", "description": "Object key/path of the file" }, "expiresIn": { "type": "number", "default": 3600, "description": "URL expiration time in seconds (default: 3600)" } }, "required": [ "PCID", "bucket", "key" ] } ``` *** ## amazon-s3\_list\_buckets List all buckets in your S3 account ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" } }, "required": [ "PCID" ] } ``` *** ## amazon-s3\_list\_folder List contents of a specific folder in a bucket, showing both files and subfolders **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucket` | string | Yes | — | Name of the S3 bucket | | `folderName` | string | Yes | — | Name of the folder to list (without trailing slash) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "bucket": { "type": "string", "description": "Name of the S3 bucket" }, "folderName": { "type": "string", "description": "Name of the folder to list (without trailing slash)" } }, "required": [ "PCID", "bucket", "folderName" ] } ``` *** ## amazon-s3\_list\_objects List objects within a bucket with optional prefix and delimiter **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucket` | string | Yes | — | Name of the S3 bucket | | `prefix` | string | No | — | Prefix to filter objects (e.g., "folder-name/") | | `delimiter` | string | No | — | Delimiter to group objects (typically "/") | | `maxKeys` | number | No | `1000` | Maximum number of objects to return (default: 1000) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "bucket": { "type": "string", "description": "Name of the S3 bucket" }, "prefix": { "type": "string", "description": "Prefix to filter objects (e.g., \"folder-name/\")" }, "delimiter": { "type": "string", "description": "Delimiter to group objects (typically \"/\")" }, "maxKeys": { "type": "number", "default": 1000, "description": "Maximum number of objects to return (default: 1000)" } }, "required": [ "PCID", "bucket" ] } ``` *** ## amazon-s3\_upload\_file Upload a file to S3 from a URL source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucket` | string | Yes | — | Name of the S3 bucket | | `key` | string | Yes | — | Object key/path where the file will be stored | | `fileUrl` | string | Yes | — | URL of the file to upload to S3 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "bucket": { "type": "string", "description": "Name of the S3 bucket" }, "key": { "type": "string", "description": "Object key/path where the file will be stored" }, "fileUrl": { "type": "string", "description": "URL of the file to upload to S3" } }, "required": [ "PCID", "bucket", "key", "fileUrl" ] } ``` # amplitude Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/amplitude Amplitude Analytics — event segmentation, funnels, retention, cohorts, taxonomy, and real-time data **Server path:** `/amplitude` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`amplitude_create_annotation`](#amplitude_create_annotation) | Create Annotation | | [`amplitude_delete_annotation`](#amplitude_delete_annotation) | Delete Annotation | | [`amplitude_download_cohort`](#amplitude_download_cohort) | Download Cohort Users | | [`amplitude_export_project_data`](#amplitude_export_project_data) | Export Project Data | | [`amplitude_get_active_new_users`](#amplitude_get_active_new_users) | Get Active/New User Counts | | [`amplitude_get_annotation`](#amplitude_get_annotation) | Get Annotation | | [`amplitude_get_average_session_length`](#amplitude_get_average_session_length) | Get Average Session Length | | [`amplitude_get_average_sessions_per_user`](#amplitude_get_average_sessions_per_user) | Get Average Sessions Per User | | [`amplitude_get_chart_results`](#amplitude_get_chart_results) | Get Chart Results | | [`amplitude_get_cohort`](#amplitude_get_cohort) | Get Cohort | | [`amplitude_get_deletion_requests`](#amplitude_get_deletion_requests) | Get Deletion Requests | | [`amplitude_get_event_segmentation`](#amplitude_get_event_segmentation) | Get Event Segmentation | | [`amplitude_get_event_type`](#amplitude_get_event_type) | Get Event Type | | [`amplitude_get_events_list`](#amplitude_get_events_list) | List Events | | [`amplitude_get_funnel_analysis`](#amplitude_get_funnel_analysis) | Get Funnel Analysis | | [`amplitude_get_real_time_active_users`](#amplitude_get_real_time_active_users) | Get Real-time Active Users | | [`amplitude_get_retention_analysis`](#amplitude_get_retention_analysis) | Get Retention Analysis | | [`amplitude_get_revenue_ltv`](#amplitude_get_revenue_ltv) | Get Revenue LTV | | [`amplitude_get_session_length_distribution`](#amplitude_get_session_length_distribution) | Get Session Length Distribution | | [`amplitude_get_user_activity`](#amplitude_get_user_activity) | Get User Activity | | [`amplitude_get_user_composition`](#amplitude_get_user_composition) | Get User Composition | | [`amplitude_get_user_search`](#amplitude_get_user_search) | Search Users | | [`amplitude_list_annotations`](#amplitude_list_annotations) | List Annotations | | [`amplitude_list_cohorts`](#amplitude_list_cohorts) | List Cohorts | | [`amplitude_list_event_properties`](#amplitude_list_event_properties) | List Event Properties | | [`amplitude_list_event_types`](#amplitude_list_event_types) | List Event Types | | [`amplitude_list_user_properties`](#amplitude_list_user_properties) | List User Properties | | [`amplitude_request_user_deletion`](#amplitude_request_user_deletion) | Request User Deletion | | [`amplitude_update_annotation`](#amplitude_update_annotation) | Update Annotation | | [`amplitude_update_event_type`](#amplitude_update_event_type) | Update Event Type | *** ## amplitude\_create\_annotation Create Annotation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `date` | string | Yes | — | Date for the annotation (YYYY-MM-DD format) | | `details` | string | No | — | Detailed description | | `label` | string | Yes | — | Label/title for the annotation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "date": { "type": "string", "description": "Date for the annotation (YYYY-MM-DD format)" }, "details": { "type": "string", "description": "Detailed description" }, "label": { "type": "string", "description": "Label/title for the annotation" } }, "required": [ "PCID", "date", "label" ] } ``` *** ## amplitude\_delete\_annotation Delete Annotation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `annotationId` | string | Yes | — | Annotation Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "annotationId": { "type": "string", "description": "Annotation Id" } }, "required": [ "PCID", "annotationId" ] } ``` *** ## amplitude\_download\_cohort Download Cohort Users **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cohortId` | string | Yes | — | The cohort ID to download | | `props` | string | No | `0` | Set to 1 to include user properties in the download | | `propKeys` | string | No | — | Comma-separated list of user property keys to include (requires props=1) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "cohortId": { "type": "string", "description": "The cohort ID to download" }, "props": { "oneOf": [ { "type": "number", "const": 0 }, { "type": "number", "const": 1 } ], "default": 0, "description": "Set to 1 to include user properties in the download" }, "propKeys": { "type": "string", "description": "Comma-separated list of user property keys to include (requires props=1)" } }, "required": [ "PCID", "cohortId" ] } ``` *** ## amplitude\_export\_project\_data Export Project Data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `start` | string | Yes | — | Start datetime (YYYYMMDDTHH format, e.g. 20210101T05) | | `end` | string | Yes | — | End datetime (YYYYMMDDTHH format, e.g. 20210102T20) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "start": { "type": "string", "description": "Start datetime (YYYYMMDDTHH format, e.g. 20210101T05)" }, "end": { "type": "string", "description": "End datetime (YYYYMMDDTHH format, e.g. 20210102T20)" } }, "required": [ "PCID", "start", "end" ] } ``` *** ## amplitude\_get\_active\_new\_users Get Active/New User Counts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `start` | string | Yes | — | Start date (YYYYMMDD format) | | `end` | string | Yes | — | End date (YYYYMMDD format) | | `m` | string | No | `"active"` | User metric: active or new | | `i` | string | No | `"1"` | Interval: 1 (daily), 7 (weekly), 30 (monthly) | | `s` | string | No | — | Segment definitions as JSON array | | `g` | string | No | — | Property to group by | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "start": { "type": "string", "description": "Start date (YYYYMMDD format)" }, "end": { "type": "string", "description": "End date (YYYYMMDD format)" }, "m": { "type": "string", "enum": [ "active", "new" ], "default": "active", "description": "User metric: active or new" }, "i": { "type": "string", "enum": [ "1", "7", "30" ], "default": "1", "description": "Interval: 1 (daily), 7 (weekly), 30 (monthly)" }, "s": { "type": "string", "description": "Segment definitions as JSON array" }, "g": { "type": "string", "description": "Property to group by" } }, "required": [ "PCID", "start", "end" ] } ``` *** ## amplitude\_get\_annotation Get Annotation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `annotationId` | string | Yes | — | Annotation Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "annotationId": { "type": "string", "description": "Annotation Id" } }, "required": [ "PCID", "annotationId" ] } ``` *** ## amplitude\_get\_average\_session\_length Get Average Session Length **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `start` | string | Yes | — | Start date (YYYYMMDD format) | | `end` | string | Yes | — | End date (YYYYMMDD format) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "start": { "type": "string", "description": "Start date (YYYYMMDD format)" }, "end": { "type": "string", "description": "End date (YYYYMMDD format)" } }, "required": [ "PCID", "start", "end" ] } ``` *** ## amplitude\_get\_average\_sessions\_per\_user Get Average Sessions Per User **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `start` | string | Yes | — | Start date (YYYYMMDD format) | | `end` | string | Yes | — | End date (YYYYMMDD format) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "start": { "type": "string", "description": "Start date (YYYYMMDD format)" }, "end": { "type": "string", "description": "End date (YYYYMMDD format)" } }, "required": [ "PCID", "start", "end" ] } ``` *** ## amplitude\_get\_chart\_results Get Chart Results **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `chartId` | string | Yes | — | Chart ID from the URL in Amplitude web app | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "chartId": { "type": "string", "description": "Chart ID from the URL in Amplitude web app" } }, "required": [ "PCID", "chartId" ] } ``` *** ## amplitude\_get\_cohort Get Cohort **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cohortId` | string | Yes | — | The cohort ID to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "cohortId": { "type": "string", "description": "The cohort ID to retrieve" } }, "required": [ "PCID", "cohortId" ] } ``` *** ## amplitude\_get\_deletion\_requests Get Deletion Requests **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `start_day` | string | No | — | Start date filter (YYYY-MM-DD) | | `end_day` | string | No | — | End date filter (YYYY-MM-DD) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "start_day": { "type": "string", "description": "Start date filter (YYYY-MM-DD)" }, "end_day": { "type": "string", "description": "End date filter (YYYY-MM-DD)" } }, "required": [ "PCID" ] } ``` *** ## amplitude\_get\_event\_segmentation Get Event Segmentation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `e` | string | Yes | — | Event definition as JSON: \{"event\_type": "your\_event"}. Prefix custom events with ce:. Use \_active for any active event. | | `e2` | string | No | — | Optional second event definition (same format as e) | | `start` | string | Yes | — | Start date (YYYYMMDD format) | | `end` | string | Yes | — | End date (YYYYMMDD format) | | `m` | string | No | `"uniques"` | Metric type: uniques, totals, pct\_dau, average, histogram, sums, value\_avg, or formula | | `n` | string | No | — | User type: any or active | | `i` | string | No | `"1"` | Interval: -300000 (real-time), -3600000 (hourly), 1 (daily), 7 (weekly), 30 (monthly) | | `s` | string | No | — | Segment definitions as JSON array | | `g` | string | No | — | Property to group by (limit 2). Only available with single segment. | | `limit` | number | No | — | Limit number of group-by values returned | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "e": { "type": "string", "description": "Event definition as JSON: {\"event_type\": \"your_event\"}. Prefix custom events with ce:. Use _active for any active event." }, "e2": { "type": "string", "description": "Optional second event definition (same format as e)" }, "start": { "type": "string", "description": "Start date (YYYYMMDD format)" }, "end": { "type": "string", "description": "End date (YYYYMMDD format)" }, "m": { "type": "string", "enum": [ "uniques", "totals", "pct_dau", "average", "histogram", "sums", "value_avg", "formula" ], "default": "uniques", "description": "Metric type: uniques, totals, pct_dau, average, histogram, sums, value_avg, or formula" }, "n": { "type": "string", "enum": [ "any", "active" ], "description": "User type: any or active" }, "i": { "type": "string", "enum": [ "-300000", "-3600000", "1", "7", "30" ], "default": "1", "description": "Interval: -300000 (real-time), -3600000 (hourly), 1 (daily), 7 (weekly), 30 (monthly)" }, "s": { "type": "string", "description": "Segment definitions as JSON array" }, "g": { "type": "string", "description": "Property to group by (limit 2). Only available with single segment." }, "limit": { "type": "number", "description": "Limit number of group-by values returned" } }, "required": [ "PCID", "e", "start", "end" ] } ``` *** ## amplitude\_get\_event\_type Get Event Type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `eventType` | string | Yes | — | The event type name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "eventType": { "type": "string", "description": "The event type name" } }, "required": [ "PCID", "eventType" ] } ``` *** ## amplitude\_get\_events\_list List Events ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" } }, "required": [ "PCID" ] } ``` *** ## amplitude\_get\_funnel\_analysis Get Funnel Analysis **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `e` | string | Yes | — | First event in funnel as JSON: \{"event\_type": "step\_1"} | | `e2` | string | No | — | Second event in funnel | | `e3` | string | No | — | Third event in funnel (up to e10 supported) | | `start` | string | Yes | — | Start date (YYYYMMDD format) | | `end` | string | Yes | — | End date (YYYYMMDD format) | | `mode` | string | No | `"ordered"` | Funnel mode: ordered (default) or unordered | | `n` | string | No | — | Funnel counting mode. Some projects use totals/uniques, others use active/new. | | `cs` | number | No | — | Conversion window in seconds | | `s` | string | No | — | Segment definitions as JSON array | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "e": { "type": "string", "description": "First event in funnel as JSON: {\"event_type\": \"step_1\"}" }, "e2": { "type": "string", "description": "Second event in funnel" }, "e3": { "type": "string", "description": "Third event in funnel (up to e10 supported)" }, "start": { "type": "string", "description": "Start date (YYYYMMDD format)" }, "end": { "type": "string", "description": "End date (YYYYMMDD format)" }, "mode": { "type": "string", "enum": [ "ordered", "unordered" ], "default": "ordered", "description": "Funnel mode: ordered (default) or unordered" }, "n": { "type": "string", "enum": [ "totals", "uniques", "active", "new" ], "description": "Funnel counting mode. Some projects use totals/uniques, others use active/new." }, "cs": { "type": "number", "description": "Conversion window in seconds" }, "s": { "type": "string", "description": "Segment definitions as JSON array" } }, "required": [ "PCID", "e", "start", "end" ] } ``` *** ## amplitude\_get\_real\_time\_active\_users Get Real-time Active Users **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `i` | string | No | `"5"` | Interval in minutes: 5 (default), 15, or 60 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "i": { "type": "string", "enum": [ "5", "15", "60" ], "default": "5", "description": "Interval in minutes: 5 (default), 15, or 60" } }, "required": [ "PCID" ] } ``` *** ## amplitude\_get\_retention\_analysis Get Retention Analysis **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `se` | string | Yes | — | Starting event as JSON: \{"event\_type": "signup"} | | `re` | string | Yes | — | Returning event as JSON: \{"event\_type": "login"} | | `start` | string | Yes | — | Start date (YYYYMMDD format) | | `end` | string | Yes | — | End date (YYYYMMDD format) | | `rm` | string | No | — | Retention mode: bracket or rolling | | `s` | string | No | — | Segment definitions as JSON array | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "se": { "type": "string", "description": "Starting event as JSON: {\"event_type\": \"signup\"}" }, "re": { "type": "string", "description": "Returning event as JSON: {\"event_type\": \"login\"}" }, "start": { "type": "string", "description": "Start date (YYYYMMDD format)" }, "end": { "type": "string", "description": "End date (YYYYMMDD format)" }, "rm": { "type": "string", "enum": [ "bracket", "rolling" ], "description": "Retention mode: bracket or rolling" }, "s": { "type": "string", "description": "Segment definitions as JSON array" } }, "required": [ "PCID", "se", "re", "start", "end" ] } ``` *** ## amplitude\_get\_revenue\_ltv Get Revenue LTV **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `start` | string | Yes | — | Start date (YYYYMMDD format) | | `end` | string | Yes | — | End date (YYYYMMDD format) | | `m` | string | No | — | Metric: 0 for ARPPU, 1 for ARPU, 2 for total revenue, 3 for paying users | | `i` | string | No | `"1"` | Interval: 1 (daily), 7 (weekly), 30 (monthly) | | `s` | string | No | — | Segment definitions as JSON array | | `g` | string | No | — | Property to group by | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "start": { "type": "string", "description": "Start date (YYYYMMDD format)" }, "end": { "type": "string", "description": "End date (YYYYMMDD format)" }, "m": { "type": "string", "enum": [ "0", "1", "2", "3" ], "description": "Metric: 0 for ARPPU, 1 for ARPU, 2 for total revenue, 3 for paying users" }, "i": { "type": "string", "enum": [ "1", "7", "30" ], "default": "1", "description": "Interval: 1 (daily), 7 (weekly), 30 (monthly)" }, "s": { "type": "string", "description": "Segment definitions as JSON array" }, "g": { "type": "string", "description": "Property to group by" } }, "required": [ "PCID", "start", "end" ] } ``` *** ## amplitude\_get\_session\_length\_distribution Get Session Length Distribution **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `start` | string | Yes | — | Start date (YYYYMMDD format) | | `end` | string | Yes | — | End date (YYYYMMDD format) | | `timeHistogramConfigBinTimeUnit` | string | No | — | Time unit for bucket sizes: hours, minutes, or seconds | | `timeHistogramConfigBinMin` | number | No | — | Minimum value for bucketing | | `timeHistogramConfigBinMax` | number | No | — | Maximum value for bucketing | | `timeHistogramConfigBinSize` | number | No | — | Size of each bucket | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "start": { "type": "string", "description": "Start date (YYYYMMDD format)" }, "end": { "type": "string", "description": "End date (YYYYMMDD format)" }, "timeHistogramConfigBinTimeUnit": { "type": "string", "enum": [ "hours", "minutes", "seconds" ], "description": "Time unit for bucket sizes: hours, minutes, or seconds" }, "timeHistogramConfigBinMin": { "type": "number", "description": "Minimum value for bucketing" }, "timeHistogramConfigBinMax": { "type": "number", "description": "Maximum value for bucketing" }, "timeHistogramConfigBinSize": { "type": "number", "description": "Size of each bucket" } }, "required": [ "PCID", "start", "end" ] } ``` *** ## amplitude\_get\_user\_activity Get User Activity **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user` | string | Yes | — | Amplitude ID of the user | | `offset` | number | No | `0` | Offset for pagination (0-indexed) | | `limit` | number | No | `1000` | Number of events to return (max 1000) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "user": { "type": "string", "description": "Amplitude ID of the user" }, "offset": { "type": "number", "default": 0, "description": "Offset for pagination (0-indexed)" }, "limit": { "type": "number", "default": 1000, "description": "Number of events to return (max 1000)" } }, "required": [ "PCID", "user" ] } ``` *** ## amplitude\_get\_user\_composition Get User Composition **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `start` | string | Yes | — | Start date (YYYYMMDD format) | | `end` | string | Yes | — | End date (YYYYMMDD format) | | `p` | string | Yes | — | Property to get composition of. Built-in: version, country, city, region, DMA, language, platform, os, device, start\_version, paying. Custom: prefix with gp: | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "start": { "type": "string", "description": "Start date (YYYYMMDD format)" }, "end": { "type": "string", "description": "End date (YYYYMMDD format)" }, "p": { "type": "string", "description": "Property to get composition of. Built-in: version, country, city, region, DMA, language, platform, os, device, start_version, paying. Custom: prefix with gp:" } }, "required": [ "PCID", "start", "end", "p" ] } ``` *** ## amplitude\_get\_user\_search Search Users **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user` | string | Yes | — | User ID, device ID, or Amplitude ID to search for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "user": { "type": "string", "description": "User ID, device ID, or Amplitude ID to search for" } }, "required": [ "PCID", "user" ] } ``` *** ## amplitude\_list\_annotations List Annotations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" } }, "required": [ "PCID" ] } ``` *** ## amplitude\_list\_cohorts List Cohorts ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" } }, "required": [ "PCID" ] } ``` *** ## amplitude\_list\_event\_properties List Event Properties **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `event_type` | string | Yes | — | The event type to list properties for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "event_type": { "type": "string", "description": "The event type to list properties for" } }, "required": [ "PCID", "event_type" ] } ``` *** ## amplitude\_list\_event\_types List Event Types ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" } }, "required": [ "PCID" ] } ``` *** ## amplitude\_list\_user\_properties List User Properties ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" } }, "required": [ "PCID" ] } ``` *** ## amplitude\_request\_user\_deletion Request User Deletion **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `amplitude_ids` | string\[] | Yes | — | List of Amplitude IDs to delete | | `requester` | string | Yes | — | Email of the person requesting deletion | | `user_ids` | string\[] | No | — | Alternative - list of User IDs to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "amplitude_ids": { "type": "array", "items": { "type": "string" }, "description": "List of Amplitude IDs to delete" }, "requester": { "type": "string", "description": "Email of the person requesting deletion" }, "user_ids": { "type": "array", "items": { "type": "string" }, "description": "Alternative - list of User IDs to delete" } }, "required": [ "PCID", "amplitude_ids", "requester" ] } ``` *** ## amplitude\_update\_annotation Update Annotation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `annotationId` | string | Yes | — | Annotation Id | | `date` | string | No | — | Updated date (YYYY-MM-DD format) | | `details` | string | No | — | Updated details | | `label` | string | No | — | Updated label | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "annotationId": { "type": "string", "description": "Annotation Id" }, "date": { "type": "string", "description": "Updated date (YYYY-MM-DD format)" }, "details": { "type": "string", "description": "Updated details" }, "label": { "type": "string", "description": "Updated label" } }, "required": [ "PCID", "annotationId" ] } ``` *** ## amplitude\_update\_event\_type Update Event Type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `eventType` | string | Yes | — | The event type name | | `description` | string | No | — | New description | | `display_name` | string | No | — | New display name | | `visible` | boolean | No | — | Whether the event should be visible | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "eventType": { "type": "string", "description": "The event type name" }, "description": { "type": "string", "description": "New description" }, "display_name": { "type": "string", "description": "New display name" }, "visible": { "type": "boolean", "description": "Whether the event should be visible" } }, "required": [ "PCID", "eventType" ] } ``` # anthropic Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/anthropic Claude models **Server path:** `/anthropic` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`anthropic_analyze_image`](#anthropic_analyze_image) | DEPRECATED — Analyze an image using Claude vision capabilities. Use anthropic\_create\_message with image content blocks instead. | | [`anthropic_batch_messages`](#anthropic_batch_messages) | DEPRECATED — Process multiple messages sequentially. Use anthropic\_create\_message\_batch for proper async batch processing instead. | | [`anthropic_cancel_message_batch`](#anthropic_cancel_message_batch) | Cancel a Message Batch | | [`anthropic_count_tokens`](#anthropic_count_tokens) | Count tokens in a Message | | [`anthropic_create_message`](#anthropic_create_message) | Create a Message | | [`anthropic_create_message_batch`](#anthropic_create_message_batch) | Create a Message Batch | | [`anthropic_create_skill`](#anthropic_create_skill) | Create Skill | | [`anthropic_create_skill_version`](#anthropic_create_skill_version) | Create Skill Version | | [`anthropic_delete_file`](#anthropic_delete_file) | Delete File | | [`anthropic_delete_message_batch`](#anthropic_delete_message_batch) | Delete a Message Batch | | [`anthropic_delete_skill`](#anthropic_delete_skill) | Delete Skill | | [`anthropic_delete_skill_version`](#anthropic_delete_skill_version) | Delete Skill Version | | [`anthropic_download_file`](#anthropic_download_file) | Download File | | [`anthropic_get_file`](#anthropic_get_file) | Get File Metadata | | [`anthropic_get_message_batch`](#anthropic_get_message_batch) | Retrieve a Message Batch | | [`anthropic_get_message_batch_results`](#anthropic_get_message_batch_results) | Retrieve Message Batch results | | [`anthropic_get_model`](#anthropic_get_model) | Get a Model | | [`anthropic_get_skill`](#anthropic_get_skill) | Get Skill | | [`anthropic_get_skill_version`](#anthropic_get_skill_version) | Get Skill Version | | [`anthropic_list_files`](#anthropic_list_files) | List Files | | [`anthropic_list_message_batches`](#anthropic_list_message_batches) | List Message Batches | | [`anthropic_list_models`](#anthropic_list_models) | List Models | | [`anthropic_list_skill_versions`](#anthropic_list_skill_versions) | List Skill Versions | | [`anthropic_list_skills`](#anthropic_list_skills) | List Skills | | [`anthropic_upload_file`](#anthropic_upload_file) | Upload File | *** ## anthropic\_analyze\_image DEPRECATED — Analyze an image using Claude vision capabilities. Use anthropic\_create\_message with image content blocks instead. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `model` | string | No | — | Claude model with vision capabilities (e.g., claude-sonnet-4-5-20250929) | | `imageUrl` | string | No | — | URL of image to analyze | | `imageBase64` | string | No | — | Base64 encoded image data | | `prompt` | string | Yes | — | Question or instruction about the image | | `maxTokens` | integer | No | — | Maximum tokens to generate | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "model": { "type": "string", "description": "Claude model with vision capabilities (e.g., claude-sonnet-4-5-20250929)" }, "imageUrl": { "type": "string", "description": "URL of image to analyze" }, "imageBase64": { "type": "string", "description": "Base64 encoded image data" }, "prompt": { "type": "string", "description": "Question or instruction about the image" }, "maxTokens": { "type": "integer", "description": "Maximum tokens to generate" } }, "required": [ "PCID", "prompt" ] } ``` *** ## anthropic\_batch\_messages DEPRECATED — Process multiple messages sequentially. Use anthropic\_create\_message\_batch for proper async batch processing instead. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `model` | string | Yes | — | Claude model to use (e.g., claude-sonnet-4-5-20250929) | | `requests` | object\[] | Yes | — | Array of message requests to process sequentially | | `temperature` | number | No | — | Sampling temperature (0-1) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "model": { "type": "string", "description": "Claude model to use (e.g., claude-sonnet-4-5-20250929)" }, "requests": { "type": "array", "description": "Array of message requests to process sequentially", "items": { "type": "object", "properties": { "messages": { "type": "array", "description": "Messages for this request", "items": { "type": "object", "properties": { "role": { "type": "string", "description": "Message role (user or assistant)" }, "content": { "type": "string", "description": "Message content" } }, "required": [ "role", "content" ] } }, "system": { "type": "string", "description": "System prompt" }, "maxTokens": { "type": "integer", "description": "Max tokens for this request" } }, "required": [ "messages" ] } }, "temperature": { "type": "number", "description": "Sampling temperature (0-1)" } }, "required": [ "PCID", "model", "requests" ] } ``` *** ## anthropic\_cancel\_message\_batch Cancel a Message Batch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `message_batch_id` | string | Yes | — | ID of the Message Batch. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "message_batch_id": { "type": "string", "description": "ID of the Message Batch." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "message_batch_id" ] } ``` *** ## anthropic\_count\_tokens Count tokens in a Message **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | | `anthropic-user-profile-id` | string | No | — | The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. | | `cache_control` | object | No | — | Top-level cache control automatically applies a cache\_control marker to the last cacheable block in the request. | | `messages` | object\[] | Yes | — | Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: `json [{"role": "user", "content": "Hello, Claude"}] ` Example with multiple conversational turns: `json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ` Example with a partially-filled response from Claude: `json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: `json {"role": "user", "content": "Hello, Claude"} ` `json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. | | `model` | object | Yes | — | The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. | | `output_config` | object | No | — | Output Config | | `system` | object | No | — | System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role). | | `thinking` | object | No | — | Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details. | | `tool_choice` | object | No | — | How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. | | `tools` | any\[] | No | — | Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: \* `name`: Name of the tool. \* `description`: Optional, but strongly-recommended description of the tool. \* `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: `json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ` And then asked the model "What's the S\&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: `json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: `json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details. | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." }, "anthropic-user-profile-id": { "type": "string", "description": "The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header." }, "cache_control": { "type": "object", "description": "Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.", "properties": { "ttl": { "type": "string", "description": "The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ] }, "type": { "type": "string", "description": "The type value" } }, "required": [ "type" ] }, "messages": { "type": "array", "items": { "type": "object", "properties": { "content": { "description": "The content value" }, "role": { "type": "string", "enum": [ "user", "assistant", "system" ], "description": "The role value" } }, "required": [ "content", "role" ] }, "description": "Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{\"role\": \"user\", \"content\": \"Hello, Claude\"}] ``` Example with multiple conversational turns: ```json [ {\"role\": \"user\", \"content\": \"Hello there.\"}, {\"role\": \"assistant\", \"content\": \"Hi, I'm Claude. How can I help you?\"}, {\"role\": \"user\", \"content\": \"Can you explain LLMs in plain English?\"}, ] ``` Example with a partially-filled response from Claude: ```json [ {\"role\": \"user\", \"content\": \"What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun\"}, {\"role\": \"assistant\", \"content\": \"The best answer is (\"}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `\"text\"`. The following input messages are equivalent: ```json {\"role\": \"user\", \"content\": \"Hello, Claude\"} ``` ```json {\"role\": \"user\", \"content\": [{\"type\": \"text\", \"text\": \"Hello, Claude\"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `\"system\"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request." }, "model": { "description": "The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options." }, "output_config": { "type": "object", "description": "Output Config", "properties": { "effort": { "type": "string", "description": "How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.", "enum": [ "low", "medium", "high", "xhigh", "max" ] }, "format": { "type": "object", "description": "A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)" } } }, "system": { "description": "System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role)." }, "thinking": { "description": "Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details." }, "tool_choice": { "description": "How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all." }, "tools": { "type": "array", "description": "Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { \"name\": \"get_stock_price\", \"description\": \"Get the current stock price for a given ticker symbol.\", \"input_schema\": { \"type\": \"object\", \"properties\": { \"ticker\": { \"type\": \"string\", \"description\": \"The stock ticker symbol, e.g. AAPL for Apple Inc.\" } }, \"required\": [\"ticker\"] } } ] ``` And then asked the model \"What's the S&P 500 at today?\", the model might produce `tool_use` content blocks in the response like this: ```json [ { \"type\": \"tool_use\", \"id\": \"toolu_01D7FLrfh4GYq7yT1ULFeyMV\", \"name\": \"get_stock_price\", \"input\": { \"ticker\": \"^GSPC\" } } ] ``` You might then run your `get_stock_price` tool with `{\"ticker\": \"^GSPC\"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { \"type\": \"tool_result\", \"tool_use_id\": \"toolu_01D7FLrfh4GYq7yT1ULFeyMV\", \"content\": \"259.75 USD\" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details." } }, "required": [ "PCID", "messages", "model" ] } ```` *** ## anthropic\_create\_message Create a Message **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | | | `anthropic-user-profile-id` | string | No | — | The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. | | | `cache_control` | object | No | — | Top-level cache control automatically applies a cache\_control marker to the last cacheable block in the request. | | | `container` | string | null | No | — | Container identifier for reuse across requests. | | `inference_geo` | string | null | No | — | Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. | | `max_tokens` | integer | Yes | — | The maximum number of tokens to generate before stopping. Note that our models may stop *before* reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details. | | | `messages` | object\[] | Yes | — | Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: `json [{"role": "user", "content": "Hello, Claude"}] ` Example with multiple conversational turns: `json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ` Example with a partially-filled response from Claude: `json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: `json {"role": "user", "content": "Hello, Claude"} ` `json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. | | | `metadata` | object | No | — | The metadata value | | | `model` | object | Yes | — | The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. | | | `output_config` | object | No | — | Output Config | | | `service_tier` | string | No | — | Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details. | | | `stop_sequences` | string\[] | No | — | Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. | | | `stream` | boolean | No | — | Whether to incrementally stream the response using server-sent events. See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming) for details. | | | `system` | object | No | — | System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role). | | | `temperature` | number | No | — | Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. | | | `thinking` | object | No | — | Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details. | | | `tool_choice` | object | No | — | How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. | | | `tools` | any\[] | No | — | Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: \* `name`: Name of the tool. \* `description`: Optional, but strongly-recommended description of the tool. \* `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: `json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ` And then asked the model "What's the S\&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: `json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: `json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details. | | | `top_k` | integer | No | — | Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. | | | `top_p` | number | No | — | Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. | | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." }, "anthropic-user-profile-id": { "type": "string", "description": "The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header." }, "cache_control": { "type": "object", "description": "Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.", "properties": { "ttl": { "type": "string", "description": "The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ] }, "type": { "type": "string", "description": "The type value" } }, "required": [ "type" ] }, "container": { "type": [ "string", "null" ], "description": "Container identifier for reuse across requests." }, "inference_geo": { "type": [ "string", "null" ], "description": "Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used." }, "max_tokens": { "type": "integer", "description": "The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details." }, "messages": { "type": "array", "items": { "type": "object", "properties": { "content": { "description": "The content value" }, "role": { "type": "string", "enum": [ "user", "assistant", "system" ], "description": "The role value" } }, "required": [ "content", "role" ] }, "description": "Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{\"role\": \"user\", \"content\": \"Hello, Claude\"}] ``` Example with multiple conversational turns: ```json [ {\"role\": \"user\", \"content\": \"Hello there.\"}, {\"role\": \"assistant\", \"content\": \"Hi, I'm Claude. How can I help you?\"}, {\"role\": \"user\", \"content\": \"Can you explain LLMs in plain English?\"}, ] ``` Example with a partially-filled response from Claude: ```json [ {\"role\": \"user\", \"content\": \"What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun\"}, {\"role\": \"assistant\", \"content\": \"The best answer is (\"}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `\"text\"`. The following input messages are equivalent: ```json {\"role\": \"user\", \"content\": \"Hello, Claude\"} ``` ```json {\"role\": \"user\", \"content\": [{\"type\": \"text\", \"text\": \"Hello, Claude\"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `\"system\"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request." }, "metadata": { "type": "object", "description": "The metadata value", "properties": { "user_id": { "type": "string", "description": "An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number." } } }, "model": { "description": "The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options." }, "output_config": { "type": "object", "description": "Output Config", "properties": { "effort": { "type": "string", "description": "How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.", "enum": [ "low", "medium", "high", "xhigh", "max" ] }, "format": { "type": "object", "description": "A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)" } } }, "service_tier": { "type": "string", "description": "Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details.", "enum": [ "auto", "standard_only" ] }, "stop_sequences": { "type": "array", "items": { "type": "string" }, "description": "Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `\"end_turn\"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `\"stop_sequence\"` and the response `stop_sequence` value will contain the matched stop sequence." }, "stream": { "type": "boolean", "description": "Whether to incrementally stream the response using server-sent events. See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming) for details." }, "system": { "description": "System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role)." }, "temperature": { "type": "number", "description": "Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic." }, "thinking": { "description": "Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details." }, "tool_choice": { "description": "How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all." }, "tools": { "type": "array", "description": "Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { \"name\": \"get_stock_price\", \"description\": \"Get the current stock price for a given ticker symbol.\", \"input_schema\": { \"type\": \"object\", \"properties\": { \"ticker\": { \"type\": \"string\", \"description\": \"The stock ticker symbol, e.g. AAPL for Apple Inc.\" } }, \"required\": [\"ticker\"] } } ] ``` And then asked the model \"What's the S&P 500 at today?\", the model might produce `tool_use` content blocks in the response like this: ```json [ { \"type\": \"tool_use\", \"id\": \"toolu_01D7FLrfh4GYq7yT1ULFeyMV\", \"name\": \"get_stock_price\", \"input\": { \"ticker\": \"^GSPC\" } } ] ``` You might then run your `get_stock_price` tool with `{\"ticker\": \"^GSPC\"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { \"type\": \"tool_result\", \"tool_use_id\": \"toolu_01D7FLrfh4GYq7yT1ULFeyMV\", \"content\": \"259.75 USD\" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details." }, "top_k": { "type": "integer", "description": "Only sample from the top K options for each subsequent token. Used to remove \"long tail\" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only." }, "top_p": { "type": "number", "description": "Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only." } }, "required": [ "PCID", "max_tokens", "messages", "model" ] } ```` *** ## anthropic\_create\_message\_batch Create a Message Batch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | | `anthropic-user-profile-id` | string | No | — | The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. | | `requests` | object\[] | Yes | — | List of requests for prompt completion. Each is an individual request to create a Message. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." }, "anthropic-user-profile-id": { "type": "string", "description": "The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored." }, "requests": { "type": "array", "items": { "type": "object", "properties": { "custom_id": { "type": "string", "description": "Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch." }, "params": { "type": "object", "description": "The params value" } }, "required": [ "custom_id", "params" ] }, "description": "List of requests for prompt completion. Each is an individual request to create a Message." } }, "required": [ "PCID", "requests" ] } ``` *** ## anthropic\_create\_skill Create Skill **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | | | `display_title` | string | null | No | — | Display title for the skill. This is a human-readable label that is not included in the prompt sent to the model. | | `files` | string\[] | Yes | — | Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." }, "display_title": { "type": [ "string", "null" ], "description": "Display title for the skill. This is a human-readable label that is not included in the prompt sent to the model." }, "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory." } }, "required": [ "PCID", "files" ] } ``` *** ## anthropic\_create\_skill\_version Create Skill Version **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `skill_id` | string | Yes | — | Unique identifier for the skill. The format and length of IDs may change over time. | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | | `files` | string\[] | Yes | — | Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skill_id": { "type": "string", "description": "Unique identifier for the skill. The format and length of IDs may change over time." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." }, "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory." } }, "required": [ "PCID", "skill_id", "files" ] } ``` *** ## anthropic\_delete\_file Delete File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `file_id` | string | Yes | — | ID of the File. | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file_id": { "type": "string", "description": "ID of the File." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "file_id" ] } ``` *** ## anthropic\_delete\_message\_batch Delete a Message Batch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `message_batch_id` | string | Yes | — | ID of the Message Batch. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "message_batch_id": { "type": "string", "description": "ID of the Message Batch." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "message_batch_id" ] } ``` *** ## anthropic\_delete\_skill Delete Skill **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `skill_id` | string | Yes | — | Unique identifier for the skill. The format and length of IDs may change over time. | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skill_id": { "type": "string", "description": "Unique identifier for the skill. The format and length of IDs may change over time." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "skill_id" ] } ``` *** ## anthropic\_delete\_skill\_version Delete Skill Version **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `skill_id` | string | Yes | — | Unique identifier for the skill. The format and length of IDs may change over time. | | `version` | string | Yes | — | Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skill_id": { "type": "string", "description": "Unique identifier for the skill. The format and length of IDs may change over time." }, "version": { "type": "string", "description": "Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., \"1759178010641129\")." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "skill_id", "version" ] } ``` *** ## anthropic\_download\_file Download File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `file_id` | string | Yes | — | ID of the File. | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file_id": { "type": "string", "description": "ID of the File." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "file_id" ] } ``` *** ## anthropic\_get\_file Get File Metadata **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `file_id` | string | Yes | — | ID of the File. | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file_id": { "type": "string", "description": "ID of the File." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "file_id" ] } ``` *** ## anthropic\_get\_message\_batch Retrieve a Message Batch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `message_batch_id` | string | Yes | — | ID of the Message Batch. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "message_batch_id": { "type": "string", "description": "ID of the Message Batch." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "message_batch_id" ] } ``` *** ## anthropic\_get\_message\_batch\_results Retrieve Message Batch results **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `message_batch_id` | string | Yes | — | ID of the Message Batch. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "message_batch_id": { "type": "string", "description": "ID of the Message Batch." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "message_batch_id" ] } ``` *** ## anthropic\_get\_model Get a Model **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `model_id` | string | Yes | — | Model identifier or alias. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "model_id": { "type": "string", "description": "Model identifier or alias." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." } }, "required": [ "PCID", "model_id" ] } ``` *** ## anthropic\_get\_skill Get Skill **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `skill_id` | string | Yes | — | Unique identifier for the skill. The format and length of IDs may change over time. | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skill_id": { "type": "string", "description": "Unique identifier for the skill. The format and length of IDs may change over time." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "skill_id" ] } ``` *** ## anthropic\_get\_skill\_version Get Skill Version **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `skill_id` | string | Yes | — | Unique identifier for the skill. The format and length of IDs may change over time. | | `version` | string | Yes | — | Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skill_id": { "type": "string", "description": "Unique identifier for the skill. The format and length of IDs may change over time." }, "version": { "type": "string", "description": "Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., \"1759178010641129\")." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "skill_id", "version" ] } ``` *** ## anthropic\_list\_files List Files **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `before_id` | string | No | — | ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. | | `after_id` | string | No | — | ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. | | `limit` | integer | No | — | Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. | | `scope_id` | string | No | — | Filter by scope ID. Only returns files associated with the specified scope (e.g., a session ID). | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "before_id": { "type": "string", "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object." }, "after_id": { "type": "string", "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object." }, "limit": { "type": "integer", "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`." }, "scope_id": { "type": "string", "description": "Filter by scope ID. Only returns files associated with the specified scope (e.g., a session ID)." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID" ] } ``` *** ## anthropic\_list\_message\_batches List Message Batches **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `before_id` | string | No | — | ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. | | `after_id` | string | No | — | ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. | | `limit` | integer | No | — | Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "before_id": { "type": "string", "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object." }, "after_id": { "type": "string", "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object." }, "limit": { "type": "integer", "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID" ] } ``` *** ## anthropic\_list\_models List Models **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `before_id` | string | No | — | ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. | | `after_id` | string | No | — | ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. | | `limit` | integer | No | — | Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "before_id": { "type": "string", "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object." }, "after_id": { "type": "string", "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object." }, "limit": { "type": "integer", "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." } }, "required": [ "PCID" ] } ``` *** ## anthropic\_list\_skill\_versions List Skill Versions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `skill_id` | string | Yes | — | Unique identifier for the skill. The format and length of IDs may change over time. | | `page` | string | No | — | Optionally set to the `next_page` token from the previous response. | | `limit` | integer | No | — | Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skill_id": { "type": "string", "description": "Unique identifier for the skill. The format and length of IDs may change over time." }, "page": { "type": "string", "description": "Optionally set to the `next_page` token from the previous response." }, "limit": { "type": "integer", "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`." }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID", "skill_id" ] } ``` *** ## anthropic\_list\_skills List Skills **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | string | No | — | Pagination token for fetching a specific page of results. Pass the value from a previous response's `next_page` field to get the next page of results. | | `limit` | integer | No | — | Number of results to return per page. Maximum value is 100. Defaults to 20. | | `source` | string | No | — | Filter skills by source. If provided, only skills from the specified source will be returned: \* `"custom"`: only return user-created skills \* `"anthropic"`: only return Anthropic-created skills | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "string", "description": "Pagination token for fetching a specific page of results. Pass the value from a previous response's `next_page` field to get the next page of results." }, "limit": { "type": "integer", "description": "Number of results to return per page. Maximum value is 100. Defaults to 20." }, "source": { "type": "string", "description": "Filter skills by source. If provided, only skills from the specified source will be returned: * `\"custom\"`: only return user-created skills * `\"anthropic\"`: only return Anthropic-created skills" }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." } }, "required": [ "PCID" ] } ``` *** ## anthropic\_upload\_file Upload File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `anthropic-beta` | string | No | — | Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. | | `anthropic-version` | string | No | — | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). | | `file` | string | Yes | — | The file to upload | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "anthropic-beta": { "type": "string", "description": "Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta." }, "anthropic-version": { "type": "string", "description": "The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning)." }, "file": { "type": "string", "description": "The file to upload" } }, "required": [ "PCID", "file" ] } ``` # apify Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/apify Web scraping and automation **Server path:** `/apify` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`apify_abort_run`](#apify_abort_run) | Abort a running actor run. Use this to stop a run that is taking too long or is no longer needed. | | [`apify_get_actor_details`](#apify_get_actor_details) | Retrieve detailed information about a specific Actor including its input schema, README, and version info. | | [`apify_get_dataset`](#apify_get_dataset) | Get metadata about a specific dataset including item count, size, and creation date. | | [`apify_get_dataset_items`](#apify_get_dataset_items) | Retrieve items from an Apify dataset. Datasets store structured data from actor runs. Use this to get the scraped/extracted data after an actor run completes. | | [`apify_get_dataset_schema`](#apify_get_dataset_schema) | Generate a JSON schema from the items in a dataset. Useful for understanding the structure of scraped data. | | [`apify_get_doc`](#apify_get_doc) | Fetch the full content of an Apify documentation page by its URL. Use after searching to get detailed information. | | [`apify_get_key_value_store`](#apify_get_key_value_store) | Get metadata about a specific key-value store including record count and size. | | [`apify_get_key_value_store_record`](#apify_get_key_value_store_record) | Get a specific record from a key-value store. Key-value stores hold various data like screenshots, HTML snapshots, or JSON configuration. | | [`apify_get_run`](#apify_get_run) | Get the status and details of an actor run. Use this to check if a run has completed and to retrieve its results. | | [`apify_get_run_log`](#apify_get_run_log) | Retrieve the logs for a specific Actor run. Useful for debugging failed runs or monitoring progress. | | [`apify_list_actors`](#apify_list_actors) | List actors owned by the authenticated user. Use this to discover available actors in your account. | | [`apify_list_datasets`](#apify_list_datasets) | List all datasets available to the user. Datasets store structured data from actor runs. | | [`apify_list_key_value_store_keys`](#apify_list_key_value_store_keys) | List all keys within a specific key-value store. Use this to discover what data is stored. | | [`apify_list_key_value_stores`](#apify_list_key_value_stores) | List all key-value stores available to the user. Key-value stores hold various data like screenshots, HTML, or JSON. | | [`apify_list_runs`](#apify_list_runs) | List runs of a specific actor or all runs. Use this to see the history of actor executions. | | [`apify_run_actor`](#apify_run_actor) | Run an Apify Actor with the specified input. Actors are pre-built automation tools for web scraping, data extraction, and browser automation. Use this to start a new run of any actor from the Apify Store or your own actors. | | [`apify_search_docs`](#apify_search_docs) | Search the Apify documentation for relevant pages. Use this to find information about Apify features, APIs, and best practices. | | [`apify_search_store_actors`](#apify_search_store_actors) | Search for actors in the Apify Store. Use this to discover pre-built actors for web scraping, automation, and data extraction tasks. | *** ## apify\_abort\_run Abort a running actor run. Use this to stop a run that is taking too long or is no longer needed. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `runId` | string | Yes | — | The ID of the actor run to abort | | `gracefully` | boolean | No | `false` | If true, the actor run will be given some time to clean up before being aborted. Default: false | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "runId": { "type": "string", "description": "The ID of the actor run to abort" }, "gracefully": { "type": "boolean", "default": false, "description": "If true, the actor run will be given some time to clean up before being aborted. Default: false" } }, "required": [ "PCID", "runId" ] } ``` *** ## apify\_get\_actor\_details Retrieve detailed information about a specific Actor including its input schema, README, and version info. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `actorId` | string | Yes | — | Actor ID (e.g., "nwua9Gu5YrADL7ZDj") or username~~actorName format (e.g., "apify~~web-scraper"). Note: Use tilde (\~) separator, not slash. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "actorId": { "type": "string", "description": "Actor ID (e.g., \"nwua9Gu5YrADL7ZDj\") or username~actorName format (e.g., \"apify~web-scraper\"). Note: Use tilde (~) separator, not slash." } }, "required": [ "PCID", "actorId" ] } ``` *** ## apify\_get\_dataset Get metadata about a specific dataset including item count, size, and creation date. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `datasetId` | string | Yes | — | Dataset ID. Get this from an actor run result (defaultDatasetId). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "datasetId": { "type": "string", "description": "Dataset ID. Get this from an actor run result (defaultDatasetId)." } }, "required": [ "PCID", "datasetId" ] } ``` *** ## apify\_get\_dataset\_items Retrieve items from an Apify dataset. Datasets store structured data from actor runs. Use this to get the scraped/extracted data after an actor run completes. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `datasetId` | string | Yes | — | Dataset ID. Get this from the actor run result (defaultDatasetId) or use "default" for the default dataset. | | `offset` | number | No | `0` | Number of items to skip from the beginning. Default: 0 | | `limit` | number | No | `100` | Maximum number of items to return. Default: 100, Max: 250000 | | `clean` | boolean | No | — | If true, returns only non-empty items and skips hidden fields (starting with #) | | `fields` | string\[] | No | — | List of fields to include in the output. If not provided, all fields are returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "datasetId": { "type": "string", "description": "Dataset ID. Get this from the actor run result (defaultDatasetId) or use \"default\" for the default dataset." }, "offset": { "type": "number", "default": 0, "description": "Number of items to skip from the beginning. Default: 0" }, "limit": { "type": "number", "default": 100, "description": "Maximum number of items to return. Default: 100, Max: 250000" }, "clean": { "type": "boolean", "description": "If true, returns only non-empty items and skips hidden fields (starting with #)" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "List of fields to include in the output. If not provided, all fields are returned." } }, "required": [ "PCID", "datasetId" ] } ``` *** ## apify\_get\_dataset\_schema Generate a JSON schema from the items in a dataset. Useful for understanding the structure of scraped data. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `datasetId` | string | Yes | — | Dataset ID to generate schema from | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "datasetId": { "type": "string", "description": "Dataset ID to generate schema from" } }, "required": [ "PCID", "datasetId" ] } ``` *** ## apify\_get\_doc Fetch the full content of an Apify documentation page by its URL. Use after searching to get detailed information. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `url` | string | Yes | — | URL of the Apify documentation page (e.g., "[https://docs.apify.com/platform/actors](https://docs.apify.com/platform/actors)") | ```json theme={null} { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the Apify documentation page (e.g., \"https://docs.apify.com/platform/actors\")" } }, "required": [ "url" ] } ``` *** ## apify\_get\_key\_value\_store Get metadata about a specific key-value store including record count and size. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `storeId` | string | Yes | — | Key-value store ID. Get this from an actor run result (defaultKeyValueStoreId). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "storeId": { "type": "string", "description": "Key-value store ID. Get this from an actor run result (defaultKeyValueStoreId)." } }, "required": [ "PCID", "storeId" ] } ``` *** ## apify\_get\_key\_value\_store\_record Get a specific record from a key-value store. Key-value stores hold various data like screenshots, HTML snapshots, or JSON configuration. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `storeId` | string | Yes | — | Key-value store ID. Get this from actor run result (defaultKeyValueStoreId) or use a named store ID. | | `key` | string | Yes | — | The key of the record to retrieve (e.g., "OUTPUT", "INPUT", "screenshot.png") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "storeId": { "type": "string", "description": "Key-value store ID. Get this from actor run result (defaultKeyValueStoreId) or use a named store ID." }, "key": { "type": "string", "description": "The key of the record to retrieve (e.g., \"OUTPUT\", \"INPUT\", \"screenshot.png\")" } }, "required": [ "PCID", "storeId", "key" ] } ``` *** ## apify\_get\_run Get the status and details of an actor run. Use this to check if a run has completed and to retrieve its results. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `runId` | string | Yes | — | The ID of the actor run to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "runId": { "type": "string", "description": "The ID of the actor run to retrieve" } }, "required": [ "PCID", "runId" ] } ``` *** ## apify\_get\_run\_log Retrieve the logs for a specific Actor run. Useful for debugging failed runs or monitoring progress. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `runId` | string | Yes | — | The ID of the actor run to get logs for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "runId": { "type": "string", "description": "The ID of the actor run to get logs for" } }, "required": [ "PCID", "runId" ] } ``` *** ## apify\_list\_actors List actors owned by the authenticated user. Use this to discover available actors in your account. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | number | No | `0` | Number of actors to skip. Default: 0 | | `limit` | number | No | `20` | Maximum number of actors to return. Default: 20 | | `desc` | boolean | No | — | If true, sort by createdAt in descending order | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "offset": { "type": "number", "default": 0, "description": "Number of actors to skip. Default: 0" }, "limit": { "type": "number", "default": 20, "description": "Maximum number of actors to return. Default: 20" }, "desc": { "type": "boolean", "description": "If true, sort by createdAt in descending order" } }, "required": [ "PCID" ] } ``` *** ## apify\_list\_datasets List all datasets available to the user. Datasets store structured data from actor runs. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | number | No | `0` | Number of datasets to skip. Default: 0 | | `limit` | number | No | `20` | Maximum number of datasets to return. Default: 20 | | `unnamed` | boolean | No | `true` | If true, include unnamed datasets. Default: true | | `desc` | boolean | No | — | If true, sort by createdAt in descending order | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "offset": { "type": "number", "default": 0, "description": "Number of datasets to skip. Default: 0" }, "limit": { "type": "number", "default": 20, "description": "Maximum number of datasets to return. Default: 20" }, "unnamed": { "type": "boolean", "default": true, "description": "If true, include unnamed datasets. Default: true" }, "desc": { "type": "boolean", "description": "If true, sort by createdAt in descending order" } }, "required": [ "PCID" ] } ``` *** ## apify\_list\_key\_value\_store\_keys List all keys within a specific key-value store. Use this to discover what data is stored. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `storeId` | string | Yes | — | Key-value store ID | | `exclusiveStartKey` | string | No | — | Key to start listing from (for pagination) | | `limit` | number | No | `100` | Maximum number of keys to return. Default: 100 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "storeId": { "type": "string", "description": "Key-value store ID" }, "exclusiveStartKey": { "type": "string", "description": "Key to start listing from (for pagination)" }, "limit": { "type": "number", "default": 100, "description": "Maximum number of keys to return. Default: 100" } }, "required": [ "PCID", "storeId" ] } ``` *** ## apify\_list\_key\_value\_stores List all key-value stores available to the user. Key-value stores hold various data like screenshots, HTML, or JSON. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | number | No | `0` | Number of stores to skip. Default: 0 | | `limit` | number | No | `20` | Maximum number of stores to return. Default: 20 | | `unnamed` | boolean | No | `true` | If true, include unnamed stores. Default: true | | `desc` | boolean | No | — | If true, sort by createdAt in descending order | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "offset": { "type": "number", "default": 0, "description": "Number of stores to skip. Default: 0" }, "limit": { "type": "number", "default": 20, "description": "Maximum number of stores to return. Default: 20" }, "unnamed": { "type": "boolean", "default": true, "description": "If true, include unnamed stores. Default: true" }, "desc": { "type": "boolean", "description": "If true, sort by createdAt in descending order" } }, "required": [ "PCID" ] } ``` *** ## apify\_list\_runs List runs of a specific actor or all runs. Use this to see the history of actor executions. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `actorId` | string | No | — | Actor ID to filter runs. If not provided, lists all runs across all actors. | | `offset` | number | No | `0` | Number of runs to skip. Default: 0 | | `limit` | number | No | `20` | Maximum number of runs to return. Default: 20 | | `status` | string | No | — | Filter by run status | | `desc` | boolean | No | `true` | If true, sort by startedAt in descending order. Default: true | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "actorId": { "type": "string", "description": "Actor ID to filter runs. If not provided, lists all runs across all actors." }, "offset": { "type": "number", "default": 0, "description": "Number of runs to skip. Default: 0" }, "limit": { "type": "number", "default": 20, "description": "Maximum number of runs to return. Default: 20" }, "status": { "type": "string", "enum": [ "READY", "RUNNING", "SUCCEEDED", "FAILED", "ABORTING", "ABORTED", "TIMED-OUT" ], "description": "Filter by run status" }, "desc": { "type": "boolean", "default": true, "description": "If true, sort by startedAt in descending order. Default: true" } }, "required": [ "PCID" ] } ``` *** ## apify\_run\_actor Run an Apify Actor with the specified input. Actors are pre-built automation tools for web scraping, data extraction, and browser automation. Use this to start a new run of any actor from the Apify Store or your own actors. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `actorId` | string | Yes | — | Actor ID (e.g., "nwua9Gu5YrADL7ZDj") or username~~actorName format (e.g., "apify~~web-scraper", "apify~~instagram-scraper"). Note: Use tilde (~~) separator, not slash. | | `input` | object | No | — | Input object for the actor. The schema depends on the specific actor. Check the actor documentation for required fields. | | `build` | string | No | — | Tag or number of the actor build to run. Defaults to the latest build. | | `timeoutSecs` | number | No | — | Timeout for the actor run in seconds. Default depends on the actor settings. | | `memoryMbytes` | number | No | — | Memory limit for the actor run in megabytes (128, 256, 512, 1024, 2048, 4096, etc.) | | `waitForFinish` | number | No | `60` | Maximum time to wait for the actor to finish in seconds. Set to 0 for async execution. Default: 60 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "actorId": { "type": "string", "description": "Actor ID (e.g., \"nwua9Gu5YrADL7ZDj\") or username~actorName format (e.g., \"apify~web-scraper\", \"apify~instagram-scraper\"). Note: Use tilde (~) separator, not slash." }, "input": { "type": "object", "additionalProperties": true, "description": "Input object for the actor. The schema depends on the specific actor. Check the actor documentation for required fields." }, "build": { "type": "string", "description": "Tag or number of the actor build to run. Defaults to the latest build." }, "timeoutSecs": { "type": "number", "description": "Timeout for the actor run in seconds. Default depends on the actor settings." }, "memoryMbytes": { "type": "number", "description": "Memory limit for the actor run in megabytes (128, 256, 512, 1024, 2048, 4096, etc.)" }, "waitForFinish": { "type": "number", "default": 60, "description": "Maximum time to wait for the actor to finish in seconds. Set to 0 for async execution. Default: 60" } }, "required": [ "PCID", "actorId" ] } ``` *** ## apify\_search\_docs Search the Apify documentation for relevant pages. Use this to find information about Apify features, APIs, and best practices. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `query` | string | Yes | — | Search query to find relevant documentation pages | ```json theme={null} { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to find relevant documentation pages" } }, "required": [ "query" ] } ``` *** ## apify\_search\_store\_actors Search for actors in the Apify Store. Use this to discover pre-built actors for web scraping, automation, and data extraction tasks. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `search` | string | No | — | Search term to filter actors by name, title, or description | | `category` | string | No | — | Filter by category (e.g., "ECOMMERCE", "SOCIAL\_MEDIA", "TRAVEL") | | `offset` | number | No | `0` | Number of actors to skip. Default: 0 | | `limit` | number | No | `20` | Maximum number of actors to return. Default: 20 | | `sortBy` | string | No | — | Sort order for results | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "PinkConnect ID for Apify connection" }, "search": { "type": "string", "description": "Search term to filter actors by name, title, or description" }, "category": { "type": "string", "description": "Filter by category (e.g., \"ECOMMERCE\", \"SOCIAL_MEDIA\", \"TRAVEL\")" }, "offset": { "type": "number", "default": 0, "description": "Number of actors to skip. Default: 0" }, "limit": { "type": "number", "default": 20, "description": "Maximum number of actors to return. Default: 20" }, "sortBy": { "type": "string", "enum": [ "popularity", "newest", "lastUpdate" ], "description": "Sort order for results" } }, "required": [ "PCID" ] } ``` # apollo Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/apollo Prospecting and enrichment **Server path:** `/apollo` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`apollo_create_account`](#apollo_create_account) | Create a new account in Apollo CRM. An account is a company your team has explicitly added. Apollo does not deduplicate - if entry has same name/domain as existing account, a new account is created. | | [`apollo_create_contact`](#apollo_create_contact) | Create a new contact in Apollo CRM. By default, Apollo does not deduplicate - set run\_dedupe to true to enable. | | [`apollo_create_deal`](#apollo_create_deal) | Create new deals/opportunities in Apollo. Deals track account activity including monetary values, owners, and stages. | | [`apollo_create_task`](#apollo_create_task) | Create tasks in Apollo for you and your team. Tasks track upcoming actions like emailing or calling a contact. REQUIRED: user\_id (from apollo\_list\_users) and contact\_ids (from apollo\_search\_contacts). If multiple contact\_ids provided, individual tasks are created for each contact. | | [`apollo_enrich_organization`](#apollo_enrich_organization) | Enrich an organization/company record using Apollo's data. Get detailed company information by domain. | | [`apollo_enrich_person`](#apollo_enrich_person) | Enrich a person record using Apollo's data. Find detailed information about a person by email, name, or other identifiers. | | [`apollo_get_account`](#apollo_get_account) | Retrieve details for an existing account in your Apollo database. To find account IDs, use apollo\_search\_accounts first. | | [`apollo_get_contact`](#apollo_get_contact) | Retrieve details for an existing contact in your Apollo database. Use apollo\_search\_contacts to find contact IDs. | | [`apollo_get_deal`](#apollo_get_deal) | Get details of a specific deal by ID. | | [`apollo_get_organization_info`](#apollo_get_organization_info) | Get complete information about a specific organization by its Apollo ID. IMPORTANT: You MUST first call apollo\_search\_organizations to get an organization\_id. This tool does NOT accept domain names - only organization\_id from search results. | | [`apollo_list_account_stages`](#apollo_list_account_stages) | List all available account stages in Apollo. | | [`apollo_list_contact_stages`](#apollo_list_contact_stages) | List all available contact stages in Apollo. | | [`apollo_list_deal_stages`](#apollo_list_deal_stages) | List all available deal/opportunity stages in Apollo. | | [`apollo_list_deals`](#apollo_list_deals) | List all deals/opportunities in Apollo CRM. | | [`apollo_list_users`](#apollo_list_users) | Retrieve IDs for all users (teammates) in your Apollo account. User IDs are used in apollo\_create\_deal, apollo\_create\_account, and apollo\_create\_task tools. | | [`apollo_search_accounts`](#apollo_search_accounts) | Search for accounts that have been added to your Apollo CRM. Only returns accounts in your database - use apollo\_search\_organizations to search the full Apollo database. | | [`apollo_search_contacts`](#apollo_search_contacts) | Search for contacts in your Apollo CRM. This returns only contacts your team has added. Display limit: 50,000 records (100 per page, up to 500 pages). | | [`apollo_search_organizations`](#apollo_search_organizations) | Search for organizations/companies in Apollo's database using various filters. Consumes credits. | | [`apollo_search_people`](#apollo_search_people) | Search for people/contacts in Apollo's database using various filters like job titles, company, location, etc. Does not return emails or phone numbers - use People Enrichment for that. | | [`apollo_search_tasks`](#apollo_search_tasks) | Search for tasks your team has created in Apollo. Display limit: 50,000 records (100 per page, up to 500 pages). | | [`apollo_update_account`](#apollo_update_account) | Update an existing account in Apollo CRM. To find account IDs, use apollo\_search\_accounts first. | | [`apollo_update_contact`](#apollo_update_contact) | Update an existing contact in Apollo CRM. To find contact IDs, use apollo\_search\_contacts first. | | [`apollo_update_deal`](#apollo_update_deal) | Update an existing deal/opportunity in Apollo CRM. To find deal IDs, use apollo\_list\_deals first. | *** ## apollo\_create\_account Create a new account in Apollo CRM. An account is a company your team has explicitly added. Apollo does not deduplicate - if entry has same name/domain as existing account, a new account is created. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Human-readable account name. Example: "The Irish Copywriters" | | `domain` | string | No | — | Domain name for the account. Do not include [www](http://www). Examples: "apollo.io", "microsoft.com" | | `owner_id` | string | No | — | ID of the account owner within your Apollo account. Use apollo\_list\_users tool to retrieve IDs. Example: "66302798d03b9601c7934ebf" | | `account_stage_id` | string | No | — | Apollo ID for the account stage. Call apollo\_list\_account\_stages to get IDs. If not specified, Apollo auto-assigns a stage. Example: "6095a710bd01d100a506d4b9" | | `phone` | string | No | — | Primary phone number. Can be HQ, branch, or direct dial. Any format accepted. Examples: "555-303-1234", "+44 7911 123456" | | `raw_address` | string | No | — | Corporate location (city, state, country). Apollo matches to pre-defined locations. Examples: "Belfield, Dublin 4, Ireland", "Dallas, United States" | | `typed_custom_fields` | object | No | — | Custom fields as key-value pairs. Keys are custom field IDs from Apollo API. Example: \{"60c39ed82bd02f01154c470a": "2025-08-07"} | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "name": { "type": "string", "description": "Human-readable account name. Example: \"The Irish Copywriters\"" }, "domain": { "type": "string", "description": "Domain name for the account. Do not include www. Examples: \"apollo.io\", \"microsoft.com\"" }, "owner_id": { "type": "string", "description": "ID of the account owner within your Apollo account. Use apollo_list_users tool to retrieve IDs. Example: \"66302798d03b9601c7934ebf\"" }, "account_stage_id": { "type": "string", "description": "Apollo ID for the account stage. Call apollo_list_account_stages to get IDs. If not specified, Apollo auto-assigns a stage. Example: \"6095a710bd01d100a506d4b9\"" }, "phone": { "type": "string", "description": "Primary phone number. Can be HQ, branch, or direct dial. Any format accepted. Examples: \"555-303-1234\", \"+44 7911 123456\"" }, "raw_address": { "type": "string", "description": "Corporate location (city, state, country). Apollo matches to pre-defined locations. Examples: \"Belfield, Dublin 4, Ireland\", \"Dallas, United States\"" }, "typed_custom_fields": { "type": "object", "additionalProperties": true, "description": "Custom fields as key-value pairs. Keys are custom field IDs from Apollo API. Example: {\"60c39ed82bd02f01154c470a\": \"2025-08-07\"}" } }, "required": [ "PCID", "name" ] } ``` *** ## apollo\_create\_contact Create a new contact in Apollo CRM. By default, Apollo does not deduplicate - set run\_dedupe to true to enable. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `first_name` | string | Yes | — | Contact first name. Example: "Tim" | | `last_name` | string | Yes | — | Contact last name. Example: "Zheng" | | `organization_name` | string | No | — | Contact's employer company name. Example: "apollo" | | `title` | string | No | — | Job title. Example: "Software Engineer" | | `account_id` | string | No | — | Apollo account ID to link this contact to a CRM account. Use apollo\_search\_accounts or apollo\_create\_account to get account IDs. Example: "63f53afe4ceeca00016bdd2f" | | `email` | string | No | — | Email address. Example: "[john.smith@example.com](mailto:john.smith@example.com)" | | `website_url` | string | No | — | Corporate website URL. Example: "[https://www.apollo.io/](https://www.apollo.io/)" | | `label_names` | string\[] | No | — | Lists to which the contact belongs | | `contact_stage_id` | string | No | — | Apollo ID for the contact stage. Example: "6095a710bd01d100a506d4ae" | | `owner_id` | string | No | — | Contact owner ID. Use apollo\_list\_users tool to retrieve IDs. | | `present_raw_address` | string | No | — | Personal location for the contact. Example: "Atlanta, United States" | | `direct_phone` | string | No | — | Primary phone number. Example: "555-303-1234" | | `corporate_phone` | string | No | — | Work/office phone number. Example: "+44 7911 123456" | | `mobile_phone` | string | No | — | Mobile phone number. Example: "555-303-1234" | | `home_phone` | string | No | — | Home phone number. Example: "555-303-1234" | | `other_phone` | string | No | — | Alternative phone number. Example: "555-303-1234" | | `typed_custom_fields` | object | No | — | Custom fields object. Keys are custom field IDs from Apollo API. | | `run_dedupe` | boolean | No | `false` | Enable deduplication to prevent duplicate contacts. Default: false | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "first_name": { "type": "string", "description": "Contact first name. Example: \"Tim\"" }, "last_name": { "type": "string", "description": "Contact last name. Example: \"Zheng\"" }, "organization_name": { "type": "string", "description": "Contact's employer company name. Example: \"apollo\"" }, "title": { "type": "string", "description": "Job title. Example: \"Software Engineer\"" }, "account_id": { "type": "string", "description": "Apollo account ID to link this contact to a CRM account. Use apollo_search_accounts or apollo_create_account to get account IDs. Example: \"63f53afe4ceeca00016bdd2f\"" }, "email": { "type": "string", "description": "Email address. Example: \"john.smith@example.com\"" }, "website_url": { "type": "string", "description": "Corporate website URL. Example: \"https://www.apollo.io/\"" }, "label_names": { "type": "array", "items": { "type": "string" }, "description": "Lists to which the contact belongs" }, "contact_stage_id": { "type": "string", "description": "Apollo ID for the contact stage. Example: \"6095a710bd01d100a506d4ae\"" }, "owner_id": { "type": "string", "description": "Contact owner ID. Use apollo_list_users tool to retrieve IDs." }, "present_raw_address": { "type": "string", "description": "Personal location for the contact. Example: \"Atlanta, United States\"" }, "direct_phone": { "type": "string", "description": "Primary phone number. Example: \"555-303-1234\"" }, "corporate_phone": { "type": "string", "description": "Work/office phone number. Example: \"+44 7911 123456\"" }, "mobile_phone": { "type": "string", "description": "Mobile phone number. Example: \"555-303-1234\"" }, "home_phone": { "type": "string", "description": "Home phone number. Example: \"555-303-1234\"" }, "other_phone": { "type": "string", "description": "Alternative phone number. Example: \"555-303-1234\"" }, "typed_custom_fields": { "type": "object", "additionalProperties": true, "description": "Custom fields object. Keys are custom field IDs from Apollo API." }, "run_dedupe": { "type": "boolean", "default": false, "description": "Enable deduplication to prevent duplicate contacts. Default: false" } }, "required": [ "PCID", "first_name", "last_name" ] } ``` *** ## apollo\_create\_deal Create new deals/opportunities in Apollo. Deals track account activity including monetary values, owners, and stages. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Human-readable deal name. Example: "Massive Q3 Deal" | | `owner_id` | string | No | — | Deal owner ID. Use apollo\_list\_users to get IDs. Example: "66302798d03b9601c7934ebf" | | `account_id` | string | No | — | Apollo account ID (CRM account, not organization\_id). Use apollo\_search\_accounts or apollo\_create\_account to get account IDs. Example: "63f53afe4ceeca00016bdd2f" | | `amount` | string | No | — | Monetary value (no commas or currency symbols). Currency from account settings. Example: "55123478" results in \$55,123,478 | | `opportunity_stage_id` | string | No | — | Deal stage ID. Use apollo\_list\_deal\_stages to get IDs. Example: "6095a710bd01d100a506d4bd" | | `closed_date` | string | No | — | Estimated close date (YYYY-MM-DD). Example: "2025-10-30" | | `typed_custom_fields` | object | No | — | Custom fields object. Keys are custom field IDs from Apollo API. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "name": { "type": "string", "description": "Human-readable deal name. Example: \"Massive Q3 Deal\"" }, "owner_id": { "type": "string", "description": "Deal owner ID. Use apollo_list_users to get IDs. Example: \"66302798d03b9601c7934ebf\"" }, "account_id": { "type": "string", "description": "Apollo account ID (CRM account, not organization_id). Use apollo_search_accounts or apollo_create_account to get account IDs. Example: \"63f53afe4ceeca00016bdd2f\"" }, "amount": { "type": "string", "description": "Monetary value (no commas or currency symbols). Currency from account settings. Example: \"55123478\" results in $55,123,478" }, "opportunity_stage_id": { "type": "string", "description": "Deal stage ID. Use apollo_list_deal_stages to get IDs. Example: \"6095a710bd01d100a506d4bd\"" }, "closed_date": { "type": "string", "description": "Estimated close date (YYYY-MM-DD). Example: \"2025-10-30\"" }, "typed_custom_fields": { "type": "object", "additionalProperties": true, "description": "Custom fields object. Keys are custom field IDs from Apollo API." } }, "required": [ "PCID", "name" ] } ``` *** ## apollo\_create\_task Create tasks in Apollo for you and your team. Tasks track upcoming actions like emailing or calling a contact. REQUIRED: user\_id (from apollo\_list\_users) and contact\_ids (from apollo\_search\_contacts). If multiple contact\_ids provided, individual tasks are created for each contact. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user_id` | string | Yes | — | ID of the task owner who will take action. Use apollo\_list\_users to get IDs. Example: "66302798d03b9601c7934ebf" | | `contact_ids` | string\[] | Yes | — | Contact IDs for the task recipients. Use apollo\_search\_contacts to find IDs. Example: \["66e34b81740c50074e3d1bd4"] | | `priority` | string | Yes | — | Task priority. Example: "medium" | | `due_at` | string | Yes | — | Due date/time in ISO 8601 format. Use UTC/GMT timezone (Z suffix) or specify timezone offset. Examples: "2025-02-15T08:10:30Z" (UTC), "2025-03-25T10:15:30+05:00" (UTC+5). For future dates, use "scheduled" status. | | `type` | string | Yes | — | Task type. Use "action\_item" for generic tasks (include note for context). | | `status` | string | Yes | — | Task status. Use "scheduled" for future tasks. Example: "scheduled" | | `note` | string | No | — | Task description. Recommended to provide context for the task owner. Example: "This contact expressed interest in the Sequences feature specifically. Be prepared to discuss." | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "user_id": { "type": "string", "description": "ID of the task owner who will take action. Use apollo_list_users to get IDs. Example: \"66302798d03b9601c7934ebf\"" }, "contact_ids": { "type": "array", "items": { "type": "string" }, "description": "Contact IDs for the task recipients. Use apollo_search_contacts to find IDs. Example: [\"66e34b81740c50074e3d1bd4\"]" }, "priority": { "type": "string", "enum": [ "high", "medium", "low" ], "description": "Task priority. Example: \"medium\"" }, "due_at": { "type": "string", "description": "Due date/time in ISO 8601 format. Use UTC/GMT timezone (Z suffix) or specify timezone offset. Examples: \"2025-02-15T08:10:30Z\" (UTC), \"2025-03-25T10:15:30+05:00\" (UTC+5). For future dates, use \"scheduled\" status." }, "type": { "type": "string", "enum": [ "call", "outreach_manual_email", "linkedin_step_connect", "linkedin_step_message", "linkedin_step_view_profile", "linkedin_step_interact_post", "action_item" ], "description": "Task type. Use \"action_item\" for generic tasks (include note for context)." }, "status": { "type": "string", "enum": [ "scheduled", "completed", "archived" ], "description": "Task status. Use \"scheduled\" for future tasks. Example: \"scheduled\"" }, "note": { "type": "string", "description": "Task description. Recommended to provide context for the task owner. Example: \"This contact expressed interest in the Sequences feature specifically. Be prepared to discuss.\"" } }, "required": [ "PCID", "user_id", "contact_ids", "priority", "due_at", "type", "status" ] } ``` *** ## apollo\_enrich\_organization Enrich an organization/company record using Apollo's data. Get detailed company information by domain. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `domain` | string | Yes | — | Company domain to enrich (e.g., "apollo.io") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "domain": { "type": "string", "description": "Company domain to enrich (e.g., \"apollo.io\")" } }, "required": [ "PCID", "domain" ] } ``` *** ## apollo\_enrich\_person Enrich a person record using Apollo's data. Find detailed information about a person by email, name, or other identifiers. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `first_name` | string | No | — | First name of the person. Typically used in combination with last\_name | | `last_name` | string | No | — | Last name of the person. Typically used in combination with first\_name | | `name` | string | No | — | Full name of the person. If provided, you do not need to use first\_name and last\_name | | `email` | string | No | — | Email address of the person to enrich | | `hashed_email` | string | No | — | SHA256 hashed email. Use either this OR email, not both | | `organization_name` | string | No | — | Name of the person's employer. Can be current or previous employer | | `domain` | string | No | — | Domain name for the person's employer (e.g., "microsoft.com") | | `apollo_person_id` | string | No | — | Apollo ID for the person. Each person in Apollo database is assigned a unique ID | | `linkedin_url` | string | No | — | LinkedIn URL for the person (e.g., "[https://www.linkedin.com/in/john-doe](https://www.linkedin.com/in/john-doe)") | | `reveal_personal_emails` | boolean | No | `false` | Set to true to enrich the person's data with personal emails. Requires credits | | `reveal_phone_number` | boolean | No | `false` | Set to true to enrich the person's data with phone numbers. Requires credits | | `webhook_url` | string | No | — | Required if reveal\_phone\_number is true. URL where Apollo sends the phone number response. Use UTF-8 encoding if needed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "first_name": { "type": "string", "description": "First name of the person. Typically used in combination with last_name" }, "last_name": { "type": "string", "description": "Last name of the person. Typically used in combination with first_name" }, "name": { "type": "string", "description": "Full name of the person. If provided, you do not need to use first_name and last_name" }, "email": { "type": "string", "description": "Email address of the person to enrich" }, "hashed_email": { "type": "string", "description": "SHA256 hashed email. Use either this OR email, not both" }, "organization_name": { "type": "string", "description": "Name of the person's employer. Can be current or previous employer" }, "domain": { "type": "string", "description": "Domain name for the person's employer (e.g., \"microsoft.com\")" }, "apollo_person_id": { "type": "string", "description": "Apollo ID for the person. Each person in Apollo database is assigned a unique ID" }, "linkedin_url": { "type": "string", "description": "LinkedIn URL for the person (e.g., \"https://www.linkedin.com/in/john-doe\")" }, "reveal_personal_emails": { "type": "boolean", "default": false, "description": "Set to true to enrich the person's data with personal emails. Requires credits" }, "reveal_phone_number": { "type": "boolean", "default": false, "description": "Set to true to enrich the person's data with phone numbers. Requires credits" }, "webhook_url": { "type": "string", "description": "Required if reveal_phone_number is true. URL where Apollo sends the phone number response. Use UTF-8 encoding if needed" } }, "required": [ "PCID" ] } ``` *** ## apollo\_get\_account Retrieve details for an existing account in your Apollo database. To find account IDs, use apollo\_search\_accounts first. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `account_id` | string | Yes | — | Apollo ID of the account to retrieve. Use apollo\_search\_accounts to find IDs. Example: "6518c6184f20350001a0b9c0" | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "account_id": { "type": "string", "description": "Apollo ID of the account to retrieve. Use apollo_search_accounts to find IDs. Example: \"6518c6184f20350001a0b9c0\"" } }, "required": [ "PCID", "account_id" ] } ``` *** ## apollo\_get\_contact Retrieve details for an existing contact in your Apollo database. Use apollo\_search\_contacts to find contact IDs. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contact_id` | string | Yes | — | Apollo ID of the contact to retrieve. Use apollo\_search\_contacts to find IDs. Example: "66e34b81740c50074e3d1bd4" | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "contact_id": { "type": "string", "description": "Apollo ID of the contact to retrieve. Use apollo_search_contacts to find IDs. Example: \"66e34b81740c50074e3d1bd4\"" } }, "required": [ "PCID", "contact_id" ] } ``` *** ## apollo\_get\_deal Get details of a specific deal by ID. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opportunity_id` | string | Yes | — | ID of the deal to retrieve. Use apollo\_list\_deals to find IDs. Example: "66e09ea8e3cfcf01b2208ec7" | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "opportunity_id": { "type": "string", "description": "ID of the deal to retrieve. Use apollo_list_deals to find IDs. Example: \"66e09ea8e3cfcf01b2208ec7\"" } }, "required": [ "PCID", "opportunity_id" ] } ``` *** ## apollo\_get\_organization\_info Get complete information about a specific organization by its Apollo ID. IMPORTANT: You MUST first call apollo\_search\_organizations to get an organization\_id. This tool does NOT accept domain names - only organization\_id from search results. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `organization_id` | string | Yes | — | Apollo organization ID (required). To find IDs, call apollo\_search\_organizations and identify the organization\_id value. Example: "5e66b6381e05b4008c8331b8" | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "organization_id": { "type": "string", "description": "Apollo organization ID (required). To find IDs, call apollo_search_organizations and identify the organization_id value. Example: \"5e66b6381e05b4008c8331b8\"" } }, "required": [ "PCID", "organization_id" ] } ``` *** ## apollo\_list\_account\_stages List all available account stages in Apollo. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" } }, "required": [ "PCID" ] } ``` *** ## apollo\_list\_contact\_stages List all available contact stages in Apollo. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" } }, "required": [ "PCID" ] } ``` *** ## apollo\_list\_deal\_stages List all available deal/opportunity stages in Apollo. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" } }, "required": [ "PCID" ] } ``` *** ## apollo\_list\_deals List all deals/opportunities in Apollo CRM. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sort_by_field` | string | No | — | Sort by field: amount (largest first), is\_closed (closed first), is\_won (won first) | | `page` | number | No | — | Page number. Example: 4 | | `per_page` | number | No | — | Results per page. Example: 10 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "sort_by_field": { "type": "string", "enum": [ "amount", "is_closed", "is_won" ], "description": "Sort by field: amount (largest first), is_closed (closed first), is_won (won first)" }, "page": { "type": "number", "description": "Page number. Example: 4" }, "per_page": { "type": "number", "description": "Results per page. Example: 10" } }, "required": [ "PCID" ] } ``` *** ## apollo\_list\_users Retrieve IDs for all users (teammates) in your Apollo account. User IDs are used in apollo\_create\_deal, apollo\_create\_account, and apollo\_create\_task tools. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | number | No | `1` | Page number. Example: 4 | | `per_page` | number | No | `25` | Results per page. Example: 10 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "page": { "type": "number", "default": 1, "description": "Page number. Example: 4" }, "per_page": { "type": "number", "default": 25, "description": "Results per page. Example: 10" } }, "required": [ "PCID" ] } ``` *** ## apollo\_search\_accounts Search for accounts that have been added to your Apollo CRM. Only returns accounts in your database - use apollo\_search\_organizations to search the full Apollo database. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `q_organization_name` | string | No | — | Keywords to search account names. Must match part of name. Examples: "apollo", "microsoft", "marketing" | | `account_stage_ids` | string\[] | No | — | Filter by account stage IDs. Call apollo\_list\_account\_stages to get IDs. Example: "61b8e913e0f4d2012e3af74e" | | `account_label_ids` | string\[] | No | — | Filter by label IDs. Example: \["6095a710bd01d100a506d4ae"] | | `sort_by_field` | string | No | — | Sort field for results | | `sort_ascending` | boolean | No | `false` | Set to true for ascending order. Must be used with sort\_by\_field | | `page` | number | No | `1` | Page number for pagination | | `per_page` | number | No | `25` | Results per page (max 100) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "q_organization_name": { "type": "string", "description": "Keywords to search account names. Must match part of name. Examples: \"apollo\", \"microsoft\", \"marketing\"" }, "account_stage_ids": { "type": "array", "items": { "type": "string" }, "description": "Filter by account stage IDs. Call apollo_list_account_stages to get IDs. Example: \"61b8e913e0f4d2012e3af74e\"" }, "account_label_ids": { "type": "array", "items": { "type": "string" }, "description": "Filter by label IDs. Example: [\"6095a710bd01d100a506d4ae\"]" }, "sort_by_field": { "type": "string", "enum": [ "account_last_activity_date", "account_created_at", "account_updated_at" ], "description": "Sort field for results" }, "sort_ascending": { "type": "boolean", "default": false, "description": "Set to true for ascending order. Must be used with sort_by_field" }, "page": { "type": "number", "default": 1, "description": "Page number for pagination" }, "per_page": { "type": "number", "default": 25, "description": "Results per page (max 100)" } }, "required": [ "PCID" ] } ``` *** ## apollo\_search\_contacts Search for contacts in your Apollo CRM. This returns only contacts your team has added. Display limit: 50,000 records (100 per page, up to 500 pages). **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `q_keywords` | string | No | — | Keywords to search (names, job titles, employers, emails). Examples: "tim zheng", "senior research analyst", "microsoft" | | `contact_stage_ids` | string\[] | No | — | Filter by contact stage IDs. Call apollo\_list\_contact\_stages to get IDs. Example: \["6095a710bd01d100a506d4ae"] | | `contact_label_ids` | string\[] | No | — | Filter by contact label IDs. Example: \["6095a710bd01d100a506d4ae"] | | `owner_id` | string | No | — | Filter by owner ID | | `account_ids` | string\[] | No | — | Filter by account IDs | | `sort_by_field` | string | No | — | Field to sort results by | | `sort_ascending` | boolean | No | `false` | Sort order: true for ascending, false for descending | | `page` | number | No | `1` | Page number (max 500) | | `per_page` | number | No | `25` | Results per page (max 100). Example: 10 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "q_keywords": { "type": "string", "description": "Keywords to search (names, job titles, employers, emails). Examples: \"tim zheng\", \"senior research analyst\", \"microsoft\"" }, "contact_stage_ids": { "type": "array", "items": { "type": "string" }, "description": "Filter by contact stage IDs. Call apollo_list_contact_stages to get IDs. Example: [\"6095a710bd01d100a506d4ae\"]" }, "contact_label_ids": { "type": "array", "items": { "type": "string" }, "description": "Filter by contact label IDs. Example: [\"6095a710bd01d100a506d4ae\"]" }, "owner_id": { "type": "string", "description": "Filter by owner ID" }, "account_ids": { "type": "array", "items": { "type": "string" }, "description": "Filter by account IDs" }, "sort_by_field": { "type": "string", "enum": [ "contact_last_activity_date", "contact_email_last_opened_at", "contact_email_last_clicked_at", "contact_created_at", "contact_updated_at" ], "description": "Field to sort results by" }, "sort_ascending": { "type": "boolean", "default": false, "description": "Sort order: true for ascending, false for descending" }, "page": { "type": "number", "default": 1, "description": "Page number (max 500)" }, "per_page": { "type": "number", "default": 25, "description": "Results per page (max 100). Example: 10" } }, "required": [ "PCID" ] } ``` *** ## apollo\_search\_organizations Search for organizations/companies in Apollo's database using various filters. Consumes credits. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `q_organization_domains_list` | string\[] | No | — | Company domains to search. Up to 1,000 domains. Do not include [www](http://www). or @ symbol. Examples: "apollo.io", "microsoft.com" | | `organization_num_employees_ranges` | string\[] | No | — | Employee count ranges. Examples: "1,10", "250,500", "10000,20000" | | `organization_locations` | string\[] | No | — | Company HQ locations (cities, states, countries). Examples: "texas", "tokyo", "spain" | | `organization_not_locations` | string\[] | No | — | Locations to exclude from results. Examples: "minnesota", "ireland", "seoul" | | `revenue_range_min` | number | No | — | Minimum company revenue (no currency symbols or commas). Example: 300000 | | `revenue_range_max` | number | No | — | Maximum company revenue (no currency symbols or commas). Example: 50000000 | | `currently_using_any_of_technology_uids` | string\[] | No | — | Filter by companies using any of these technologies. Use underscores for spaces. Examples: "salesforce", "google\_analytics", "wordpress\_org" | | `q_organization_keyword_tags` | string\[] | No | — | Keywords associated with companies. Examples: "mining", "sales strategy", "consulting" | | `q_organization_name` | string | No | — | Company name to search. Partial matches accepted. Examples: "apollo", "mining" | | `organization_ids` | string\[] | No | — | Apollo organization IDs to filter by. Example: "5e66b6381e05b4008c8331b8" | | `latest_funding_amount_range_min` | number | No | — | Minimum amount from most recent funding round. Example: 5000000 | | `latest_funding_amount_range_max` | number | No | — | Maximum amount from most recent funding round. Example: 15000000 | | `total_funding_range_min` | number | No | — | Minimum total funding across all rounds. Example: 50000000 | | `total_funding_range_max` | number | No | — | Maximum total funding across all rounds. Example: 350000000 | | `latest_funding_date_range_min` | string | No | — | Earliest date of most recent funding (YYYY-MM-DD). Example: "2025-07-25" | | `latest_funding_date_range_max` | string | No | — | Latest date of most recent funding (YYYY-MM-DD). Example: "2025-09-25" | | `q_organization_job_titles` | string\[] | No | — | Job titles in active postings. Examples: "sales manager", "research analyst" | | `organization_job_locations` | string\[] | No | — | Locations of job postings. Examples: "atlanta", "japan" | | `organization_num_jobs_range_min` | number | No | — | Minimum number of active job postings. Examples: 50, 500 | | `organization_num_jobs_range_max` | number | No | — | Maximum number of active job postings. Examples: 50, 500 | | `organization_job_posted_at_range_min` | string | No | — | Earliest job posting date (YYYY-MM-DD). Example: "2025-07-25" | | `organization_job_posted_at_range_max` | string | No | — | Latest job posting date (YYYY-MM-DD). Example: "2025-09-25" | | `page` | number | No | `1` | Page number for pagination | | `per_page` | number | No | `25` | Results per page (max 100) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "q_organization_domains_list": { "type": "array", "items": { "type": "string" }, "description": "Company domains to search. Up to 1,000 domains. Do not include www. or @ symbol. Examples: \"apollo.io\", \"microsoft.com\"" }, "organization_num_employees_ranges": { "type": "array", "items": { "type": "string" }, "description": "Employee count ranges. Examples: \"1,10\", \"250,500\", \"10000,20000\"" }, "organization_locations": { "type": "array", "items": { "type": "string" }, "description": "Company HQ locations (cities, states, countries). Examples: \"texas\", \"tokyo\", \"spain\"" }, "organization_not_locations": { "type": "array", "items": { "type": "string" }, "description": "Locations to exclude from results. Examples: \"minnesota\", \"ireland\", \"seoul\"" }, "revenue_range_min": { "type": "number", "description": "Minimum company revenue (no currency symbols or commas). Example: 300000" }, "revenue_range_max": { "type": "number", "description": "Maximum company revenue (no currency symbols or commas). Example: 50000000" }, "currently_using_any_of_technology_uids": { "type": "array", "items": { "type": "string" }, "description": "Filter by companies using any of these technologies. Use underscores for spaces. Examples: \"salesforce\", \"google_analytics\", \"wordpress_org\"" }, "q_organization_keyword_tags": { "type": "array", "items": { "type": "string" }, "description": "Keywords associated with companies. Examples: \"mining\", \"sales strategy\", \"consulting\"" }, "q_organization_name": { "type": "string", "description": "Company name to search. Partial matches accepted. Examples: \"apollo\", \"mining\"" }, "organization_ids": { "type": "array", "items": { "type": "string" }, "description": "Apollo organization IDs to filter by. Example: \"5e66b6381e05b4008c8331b8\"" }, "latest_funding_amount_range_min": { "type": "number", "description": "Minimum amount from most recent funding round. Example: 5000000" }, "latest_funding_amount_range_max": { "type": "number", "description": "Maximum amount from most recent funding round. Example: 15000000" }, "total_funding_range_min": { "type": "number", "description": "Minimum total funding across all rounds. Example: 50000000" }, "total_funding_range_max": { "type": "number", "description": "Maximum total funding across all rounds. Example: 350000000" }, "latest_funding_date_range_min": { "type": "string", "description": "Earliest date of most recent funding (YYYY-MM-DD). Example: \"2025-07-25\"" }, "latest_funding_date_range_max": { "type": "string", "description": "Latest date of most recent funding (YYYY-MM-DD). Example: \"2025-09-25\"" }, "q_organization_job_titles": { "type": "array", "items": { "type": "string" }, "description": "Job titles in active postings. Examples: \"sales manager\", \"research analyst\"" }, "organization_job_locations": { "type": "array", "items": { "type": "string" }, "description": "Locations of job postings. Examples: \"atlanta\", \"japan\"" }, "organization_num_jobs_range_min": { "type": "number", "description": "Minimum number of active job postings. Examples: 50, 500" }, "organization_num_jobs_range_max": { "type": "number", "description": "Maximum number of active job postings. Examples: 50, 500" }, "organization_job_posted_at_range_min": { "type": "string", "description": "Earliest job posting date (YYYY-MM-DD). Example: \"2025-07-25\"" }, "organization_job_posted_at_range_max": { "type": "string", "description": "Latest job posting date (YYYY-MM-DD). Example: \"2025-09-25\"" }, "page": { "type": "number", "default": 1, "description": "Page number for pagination" }, "per_page": { "type": "number", "default": 25, "description": "Results per page (max 100)" } }, "required": [ "PCID" ] } ``` *** ## apollo\_search\_people Search for people/contacts in Apollo's database using various filters like job titles, company, location, etc. Does not return emails or phone numbers - use People Enrichment for that. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `q_keywords` | string | No | — | Keywords to filter the results | | `person_titles` | string\[] | No | — | Job titles to filter by. Results include similar titles. Examples: "sales development representative", "marketing manager" | | `include_similar_titles` | boolean | No | `true` | Whether to include people with similar job titles. Set to false for exact matches only | | `person_seniorities` | string\[] | No | — | Seniority levels to filter by | | `person_locations` | string\[] | No | — | Personal locations (cities, states, countries). Examples: "california", "ireland", "chicago" | | `contact_email_status` | string\[] | No | — | Email statuses to filter by | | `organization_ids` | string\[] | No | — | Apollo organization IDs to filter by | | `q_organization_domains_list` | string\[] | No | — | Company domains to filter by. Up to 1,000 domains. Examples: "apollo.io", "microsoft.com" | | `organization_locations` | string\[] | No | — | Company HQ locations (cities, states, countries). Examples: "texas", "tokyo", "spain" | | `organization_num_employees_ranges` | string\[] | No | — | Employee count ranges. Examples: "1,10", "11,50", "51,200", "201,500", "501,1000", "1001,2000", "2001,5000", "5001,10000", "10001+" | | `revenue_range_min` | number | No | — | Minimum company revenue (no currency symbols or commas) | | `revenue_range_max` | number | No | — | Maximum company revenue (no currency symbols or commas) | | `currently_using_any_of_technology_uids` | string\[] | No | — | Filter by companies using ANY of these technologies. Examples: "salesforce", "google\_analytics" | | `currently_using_all_of_technology_uids` | string\[] | No | — | Filter by companies using ALL of these technologies. Examples: "salesforce", "google\_analytics" | | `currently_not_using_any_of_technology_uids` | string\[] | No | — | Exclude companies using any of these technologies. Examples: "salesforce", "google\_analytics" | | `q_organization_job_titles` | string\[] | No | — | Job titles from active job postings at the company. Examples: "sales manager", "research analyst" | | `organization_job_locations` | string\[] | No | — | Locations of job postings at the company. Examples: "atlanta", "rome" | | `organization_num_jobs_range_min` | number | No | — | Minimum number of active job postings | | `organization_num_jobs_range_max` | number | No | — | Maximum number of active job postings | | `organization_job_posted_at_range_min` | string | No | — | Earliest job posting date (YYYY-MM-DD format) | | `organization_job_posted_at_range_max` | string | No | — | Latest job posting date (YYYY-MM-DD format) | | `page` | number | No | `1` | Page number for pagination | | `per_page` | number | No | `25` | Results per page (max 100) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "q_keywords": { "type": "string", "description": "Keywords to filter the results" }, "person_titles": { "type": "array", "items": { "type": "string" }, "description": "Job titles to filter by. Results include similar titles. Examples: \"sales development representative\", \"marketing manager\"" }, "include_similar_titles": { "type": "boolean", "default": true, "description": "Whether to include people with similar job titles. Set to false for exact matches only" }, "person_seniorities": { "type": "array", "items": { "type": "string", "enum": [ "owner", "founder", "c_suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ] }, "description": "Seniority levels to filter by" }, "person_locations": { "type": "array", "items": { "type": "string" }, "description": "Personal locations (cities, states, countries). Examples: \"california\", \"ireland\", \"chicago\"" }, "contact_email_status": { "type": "array", "items": { "type": "string", "enum": [ "verified", "guessed", "likely_to_engage", "unavailable" ] }, "description": "Email statuses to filter by" }, "organization_ids": { "type": "array", "items": { "type": "string" }, "description": "Apollo organization IDs to filter by" }, "q_organization_domains_list": { "type": "array", "items": { "type": "string" }, "description": "Company domains to filter by. Up to 1,000 domains. Examples: \"apollo.io\", \"microsoft.com\"" }, "organization_locations": { "type": "array", "items": { "type": "string" }, "description": "Company HQ locations (cities, states, countries). Examples: \"texas\", \"tokyo\", \"spain\"" }, "organization_num_employees_ranges": { "type": "array", "items": { "type": "string" }, "description": "Employee count ranges. Examples: \"1,10\", \"11,50\", \"51,200\", \"201,500\", \"501,1000\", \"1001,2000\", \"2001,5000\", \"5001,10000\", \"10001+\"" }, "revenue_range_min": { "type": "number", "description": "Minimum company revenue (no currency symbols or commas)" }, "revenue_range_max": { "type": "number", "description": "Maximum company revenue (no currency symbols or commas)" }, "currently_using_any_of_technology_uids": { "type": "array", "items": { "type": "string" }, "description": "Filter by companies using ANY of these technologies. Examples: \"salesforce\", \"google_analytics\"" }, "currently_using_all_of_technology_uids": { "type": "array", "items": { "type": "string" }, "description": "Filter by companies using ALL of these technologies. Examples: \"salesforce\", \"google_analytics\"" }, "currently_not_using_any_of_technology_uids": { "type": "array", "items": { "type": "string" }, "description": "Exclude companies using any of these technologies. Examples: \"salesforce\", \"google_analytics\"" }, "q_organization_job_titles": { "type": "array", "items": { "type": "string" }, "description": "Job titles from active job postings at the company. Examples: \"sales manager\", \"research analyst\"" }, "organization_job_locations": { "type": "array", "items": { "type": "string" }, "description": "Locations of job postings at the company. Examples: \"atlanta\", \"rome\"" }, "organization_num_jobs_range_min": { "type": "number", "description": "Minimum number of active job postings" }, "organization_num_jobs_range_max": { "type": "number", "description": "Maximum number of active job postings" }, "organization_job_posted_at_range_min": { "type": "string", "description": "Earliest job posting date (YYYY-MM-DD format)" }, "organization_job_posted_at_range_max": { "type": "string", "description": "Latest job posting date (YYYY-MM-DD format)" }, "page": { "type": "number", "default": 1, "description": "Page number for pagination" }, "per_page": { "type": "number", "default": 25, "description": "Results per page (max 100)" } }, "required": [ "PCID" ] } ``` *** ## apollo\_search\_tasks Search for tasks your team has created in Apollo. Display limit: 50,000 records (100 per page, up to 500 pages). **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `q_keywords` | string | No | — | Search keywords | | `status` | string | No | — | Task status filter | | `priority` | string | No | — | Priority filter | | `type` | string | No | — | Task type filter | | `user_id` | string | No | — | Filter by assigned user ID | | `sort_by_field` | string | No | — | Sort field. task\_due\_at: most future-dated first. task\_priority: highest priority first. | | `open_factor_names` | string\[] | No | — | Enter "task\_types" to return count of tasks by task type in faceting.task\_types | | `page` | number | No | `1` | Page number (max 500). Example: 4 | | `per_page` | number | No | `25` | Results per page (max 100). Example: 10 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "q_keywords": { "type": "string", "description": "Search keywords" }, "status": { "type": "string", "enum": [ "scheduled", "completed", "archived" ], "description": "Task status filter" }, "priority": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Priority filter" }, "type": { "type": "string", "enum": [ "call", "outreach_manual_email", "linkedin_step_connect", "linkedin_step_message", "linkedin_step_view_profile", "linkedin_step_interact_post", "action_item" ], "description": "Task type filter" }, "user_id": { "type": "string", "description": "Filter by assigned user ID" }, "sort_by_field": { "type": "string", "enum": [ "task_due_at", "task_priority" ], "description": "Sort field. task_due_at: most future-dated first. task_priority: highest priority first." }, "open_factor_names": { "type": "array", "items": { "type": "string" }, "description": "Enter \"task_types\" to return count of tasks by task type in faceting.task_types" }, "page": { "type": "number", "default": 1, "description": "Page number (max 500). Example: 4" }, "per_page": { "type": "number", "default": 25, "description": "Results per page (max 100). Example: 10" } }, "required": [ "PCID" ] } ``` *** ## apollo\_update\_account Update an existing account in Apollo CRM. To find account IDs, use apollo\_search\_accounts first. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `account_id` | string | Yes | — | Apollo ID of the account to update. Use apollo\_search\_accounts to find IDs. Example: "66e9abf95ac32901b20d1a0d" | | `name` | string | No | — | Updated account name. Example: "The Fast Irish Copywriters" | | `domain` | string | No | — | Updated domain name. Do not include [www](http://www). Examples: "apollo.io", "microsoft.com" | | `owner_id` | string | No | — | Updated owner ID. Use apollo\_list\_users tool to retrieve IDs. Example: "66302798d03b9601c7934ebf" | | `account_stage_id` | string | No | — | Updated account stage ID. Call apollo\_list\_account\_stages to get IDs. Example: "61b8e913e0f4d2012e3af74e" | | `raw_address` | string | No | — | Updated corporate location (city, state, country). Examples: "Belfield, Dublin 4, Ireland", "Dallas, United States" | | `phone` | string | No | — | Updated phone number. Any format accepted. Examples: "555-303-1234", "+44 7911 123456" | | `typed_custom_fields` | object | No | — | Custom fields as key-value pairs. Example: \{"60c39ed82bd02f01154c470a": "2025-08-07"} | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "account_id": { "type": "string", "description": "Apollo ID of the account to update. Use apollo_search_accounts to find IDs. Example: \"66e9abf95ac32901b20d1a0d\"" }, "name": { "type": "string", "description": "Updated account name. Example: \"The Fast Irish Copywriters\"" }, "domain": { "type": "string", "description": "Updated domain name. Do not include www. Examples: \"apollo.io\", \"microsoft.com\"" }, "owner_id": { "type": "string", "description": "Updated owner ID. Use apollo_list_users tool to retrieve IDs. Example: \"66302798d03b9601c7934ebf\"" }, "account_stage_id": { "type": "string", "description": "Updated account stage ID. Call apollo_list_account_stages to get IDs. Example: \"61b8e913e0f4d2012e3af74e\"" }, "raw_address": { "type": "string", "description": "Updated corporate location (city, state, country). Examples: \"Belfield, Dublin 4, Ireland\", \"Dallas, United States\"" }, "phone": { "type": "string", "description": "Updated phone number. Any format accepted. Examples: \"555-303-1234\", \"+44 7911 123456\"" }, "typed_custom_fields": { "type": "object", "additionalProperties": true, "description": "Custom fields as key-value pairs. Example: {\"60c39ed82bd02f01154c470a\": \"2025-08-07\"}" } }, "required": [ "PCID", "account_id" ] } ``` *** ## apollo\_update\_contact Update an existing contact in Apollo CRM. To find contact IDs, use apollo\_search\_contacts first. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contact_id` | string | Yes | — | Apollo ID of the contact to update. Use apollo\_search\_contacts to find IDs. Example: "66e34b81740c50074e3d1bd4" | | `first_name` | string | No | — | Updated first name | | `last_name` | string | No | — | Updated last name | | `email` | string | No | — | Updated email address | | `website_url` | string | No | — | Updated employer website URL. Example: "[https://www.apollo.io/](https://www.apollo.io/)" | | `title` | string | No | — | Updated job title | | `organization_name` | string | No | — | Updated organization name | | `owner_id` | string | No | — | Updated owner ID | | `contact_stage_id` | string | No | — | Updated contact stage ID | | `account_id` | string | No | — | Updated account ID. Use apollo\_search\_accounts to find account IDs. | | `present_raw_address` | string | No | — | Updated present raw address | | `direct_phone` | string | No | — | Updated direct phone | | `corporate_phone` | string | No | — | Updated corporate phone | | `mobile_phone` | string | No | — | Updated mobile phone | | `home_phone` | string | No | — | Updated home phone | | `other_phone` | string | No | — | Updated other phone | | `label_names` | string\[] | No | — | Updated label names | | `typed_custom_fields` | object | No | — | Updated custom fields | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "contact_id": { "type": "string", "description": "Apollo ID of the contact to update. Use apollo_search_contacts to find IDs. Example: \"66e34b81740c50074e3d1bd4\"" }, "first_name": { "type": "string", "description": "Updated first name" }, "last_name": { "type": "string", "description": "Updated last name" }, "email": { "type": "string", "description": "Updated email address" }, "website_url": { "type": "string", "description": "Updated employer website URL. Example: \"https://www.apollo.io/\"" }, "title": { "type": "string", "description": "Updated job title" }, "organization_name": { "type": "string", "description": "Updated organization name" }, "owner_id": { "type": "string", "description": "Updated owner ID" }, "contact_stage_id": { "type": "string", "description": "Updated contact stage ID" }, "account_id": { "type": "string", "description": "Updated account ID. Use apollo_search_accounts to find account IDs." }, "present_raw_address": { "type": "string", "description": "Updated present raw address" }, "direct_phone": { "type": "string", "description": "Updated direct phone" }, "corporate_phone": { "type": "string", "description": "Updated corporate phone" }, "mobile_phone": { "type": "string", "description": "Updated mobile phone" }, "home_phone": { "type": "string", "description": "Updated home phone" }, "other_phone": { "type": "string", "description": "Updated other phone" }, "label_names": { "type": "array", "items": { "type": "string" }, "description": "Updated label names" }, "typed_custom_fields": { "type": "object", "additionalProperties": true, "description": "Updated custom fields" } }, "required": [ "PCID", "contact_id" ] } ``` *** ## apollo\_update\_deal Update an existing deal/opportunity in Apollo CRM. To find deal IDs, use apollo\_list\_deals first. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opportunity_id` | string | Yes | — | Apollo ID of the deal to update. Use apollo\_list\_deals to find IDs. Example: "66e09ea8e3cfcf01b2208ec7" | | `name` | string | No | — | Updated deal name | | `owner_id` | string | No | — | Updated owner ID | | `account_id` | string | No | — | Updated account ID. Use apollo\_search\_accounts to find account IDs. | | `amount` | string | No | — | Updated monetary value (no commas or currency symbols) | | `opportunity_stage_id` | string | No | — | Updated deal stage ID | | `closed_date` | string | No | — | Updated expected close date (YYYY-MM-DD) | | `typed_custom_fields` | object | No | — | Updated custom fields | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for Apollo connection" }, "opportunity_id": { "type": "string", "description": "Apollo ID of the deal to update. Use apollo_list_deals to find IDs. Example: \"66e09ea8e3cfcf01b2208ec7\"" }, "name": { "type": "string", "description": "Updated deal name" }, "owner_id": { "type": "string", "description": "Updated owner ID" }, "account_id": { "type": "string", "description": "Updated account ID. Use apollo_search_accounts to find account IDs." }, "amount": { "type": "string", "description": "Updated monetary value (no commas or currency symbols)" }, "opportunity_stage_id": { "type": "string", "description": "Updated deal stage ID" }, "closed_date": { "type": "string", "description": "Updated expected close date (YYYY-MM-DD)" }, "typed_custom_fields": { "type": "object", "additionalProperties": true, "description": "Updated custom fields" } }, "required": [ "PCID", "opportunity_id" ] } ``` # appveyor Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/appveyor Appveyor CI/CD **Server path:** `/appveyor` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`appveyor_add_environment`](#appveyor_add_environment) | Add environment | | [`appveyor_add_project`](#appveyor_add_project) | Add project | | [`appveyor_add_role`](#appveyor_add_role) | Add role | | [`appveyor_cancel_build`](#appveyor_cancel_build) | Cancel build | | [`appveyor_cancel_deployment`](#appveyor_cancel_deployment) | Cancel deployment | | [`appveyor_cancel_user_invitation`](#appveyor_cancel_user_invitation) | Cancel user invitation | | [`appveyor_delete_collaborator`](#appveyor_delete_collaborator) | Delete collaborator | | [`appveyor_delete_environment`](#appveyor_delete_environment) | Delete environment | | [`appveyor_delete_project`](#appveyor_delete_project) | Delete project | | [`appveyor_delete_project_build_cache`](#appveyor_delete_project_build_cache) | Delete project build cache | | [`appveyor_delete_role`](#appveyor_delete_role) | Delete role | | [`appveyor_delete_user`](#appveyor_delete_user) | Delete user | | [`appveyor_encrypt_value`](#appveyor_encrypt_value) | Encrypt a value for use in StoredValue. | | [`appveyor_get_build_artifact`](#appveyor_get_build_artifact) | Download build artifact | | [`appveyor_get_build_artifacts`](#appveyor_get_build_artifacts) | Get build artifacts | | [`appveyor_get_build_log`](#appveyor_get_build_log) | Download build log | | [`appveyor_get_collaborator`](#appveyor_get_collaborator) | Get collaborator | | [`appveyor_get_collaborators`](#appveyor_get_collaborators) | Get collaborators | | [`appveyor_get_deployment`](#appveyor_get_deployment) | Get deployment | | [`appveyor_get_environment_deployments`](#appveyor_get_environment_deployments) | Get environment deployments | | [`appveyor_get_environment_settings`](#appveyor_get_environment_settings) | Get environment settings | | [`appveyor_get_environments`](#appveyor_get_environments) | Get environments | | [`appveyor_get_project_artifact`](#appveyor_get_project_artifact) | Get last successful build artifact | | [`appveyor_get_project_branch_status_badge`](#appveyor_get_project_branch_status_badge) | Get project branch status badge image | | [`appveyor_get_project_build_by_version`](#appveyor_get_project_build_by_version) | Get project build by version | | [`appveyor_get_project_deployments`](#appveyor_get_project_deployments) | Get project deployments | | [`appveyor_get_project_environment_variables`](#appveyor_get_project_environment_variables) | Get project environment variables | | [`appveyor_get_project_history`](#appveyor_get_project_history) | Get project history | | [`appveyor_get_project_last_build`](#appveyor_get_project_last_build) | Get project last build | | [`appveyor_get_project_last_build_branch`](#appveyor_get_project_last_build_branch) | Get project last branch build | | [`appveyor_get_project_settings`](#appveyor_get_project_settings) | Get project settings | | [`appveyor_get_project_settings_yaml`](#appveyor_get_project_settings_yaml) | Get project settings in YAML | | [`appveyor_get_project_status_badge`](#appveyor_get_project_status_badge) | Get project status badge image | | [`appveyor_get_projects`](#appveyor_get_projects) | Get projects | | [`appveyor_get_public_project_status_badge`](#appveyor_get_public_project_status_badge) | Get status badge image for a project with a public repository | | [`appveyor_get_role`](#appveyor_get_role) | Get role | | [`appveyor_get_roles`](#appveyor_get_roles) | Get roles | | [`appveyor_get_user`](#appveyor_get_user) | Get user | | [`appveyor_get_user_invitations`](#appveyor_get_user_invitations) | Get user invitations | | [`appveyor_get_users`](#appveyor_get_users) | Get users | | [`appveyor_invite_user`](#appveyor_invite_user) | Invite user | | [`appveyor_join_account`](#appveyor_join_account) | Join Account | | [`appveyor_re_run_build`](#appveyor_re_run_build) | Re-run build | | [`appveyor_start_build`](#appveyor_start_build) | Start build of branch most recent commit | | [`appveyor_start_deployment`](#appveyor_start_deployment) | Start deployment | | [`appveyor_update_collaborator`](#appveyor_update_collaborator) | Update collaborator | | [`appveyor_update_environment`](#appveyor_update_environment) | Update environment | | [`appveyor_update_project`](#appveyor_update_project) | Update project | | [`appveyor_update_project_build_number`](#appveyor_update_project_build_number) | Update project build number | | [`appveyor_update_project_environment_variables`](#appveyor_update_project_environment_variables) | Update project environment variables | | [`appveyor_update_project_settings_yaml`](#appveyor_update_project_settings_yaml) | Update project settings in YAML | | [`appveyor_update_role`](#appveyor_update_role) | Update role | | [`appveyor_update_user`](#appveyor_update_user) | Update user | *** ## appveyor\_add\_environment Add environment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | The name value | | `provider` | string | Yes | — | The provider value | | `settings` | object | Yes | — | The settings value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name value" }, "provider": { "type": "string", "description": "The provider value", "enum": [ "Agent", "AzureBlob", "AzureCS", "AzureWebJob", "BinTray", "FTP", "GitHub", "NuGet", "S3", "SqlDatabase", "WebDeploy", "Webhook" ] }, "settings": { "type": "object", "description": "The settings value", "properties": { "providerSettings": { "type": "array", "items": { "type": "object" }, "description": "Provider Settings" }, "environmentVariables": { "type": "array", "items": { "type": "object" }, "description": "Environment Variables" }, "notifications": { "type": "array", "items": { "type": "object" }, "description": "The notifications value" } } } }, "required": [ "PCID", "name", "provider", "settings" ] } ``` *** ## appveyor\_add\_project Add project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repositoryAuthentication` | string | No | — | Repository Authentication | | `repositoryName` | string | Yes | — | URL when repositoryProvider is git, mercurial, subversion username/project when repositoryProvider is gitHub | | `repositoryPassword` | string | No | — | Required if repositoryAuthentication is credentials | | `repositoryProvider` | string | Yes | — | Repository Provider | | `repositoryUsername` | string | No | — | Required if repositoryAuthentication is credentials | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repositoryAuthentication": { "type": "string", "description": "Repository Authentication", "enum": [ "credentials", "ssh" ] }, "repositoryName": { "type": "string", "description": "URL when repositoryProvider is git, mercurial, subversion username/project when repositoryProvider is gitHub" }, "repositoryPassword": { "type": "string", "description": "Required if repositoryAuthentication is credentials" }, "repositoryProvider": { "type": "string", "description": "Repository Provider", "enum": [ "bitBucket", "git", "gitHub", "gitLab", "kiln", "mercurial", "stash", "subversion", "vso" ] }, "repositoryUsername": { "type": "string", "description": "Required if repositoryAuthentication is credentials" } }, "required": [ "PCID", "repositoryName", "repositoryProvider" ] } ``` *** ## appveyor\_add\_role Add role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "name" ] } ``` *** ## appveyor\_cancel\_build Cancel build **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `buildVersion` | string | Yes | — | Build Version (`version` property of `Build`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "buildVersion": { "type": "string", "description": "Build Version (`version` property of `Build`)" } }, "required": [ "PCID", "accountName", "projectSlug", "buildVersion" ] } ``` *** ## appveyor\_cancel\_deployment Cancel deployment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deploymentId` | integer | Yes | — | Deployment Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deploymentId": { "type": "integer", "description": "Deployment Id" } }, "required": [ "PCID", "deploymentId" ] } ``` *** ## appveyor\_cancel\_user\_invitation Cancel user invitation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userInvitationId` | string | Yes | — | User Invitation ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userInvitationId": { "type": "string", "description": "User Invitation ID" } }, "required": [ "PCID", "userInvitationId" ] } ``` *** ## appveyor\_delete\_collaborator Delete collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | integer | Yes | — | User ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "integer", "description": "User ID" } }, "required": [ "PCID", "userId" ] } ``` *** ## appveyor\_delete\_environment Delete environment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deploymentEnvironmentId` | integer | Yes | — | Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deploymentEnvironmentId": { "type": "integer", "description": "Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`)" } }, "required": [ "PCID", "deploymentEnvironmentId" ] } ``` *** ## appveyor\_delete\_project Delete project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_delete\_project\_build\_cache Delete project build cache **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_delete\_role Delete role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `roleId` | integer | Yes | — | Role ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "roleId": { "type": "integer", "description": "Role ID" } }, "required": [ "PCID", "roleId" ] } ``` *** ## appveyor\_delete\_user Delete user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | integer | Yes | — | User ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "integer", "description": "User ID" } }, "required": [ "PCID", "userId" ] } ``` *** ## appveyor\_encrypt\_value Encrypt a value for use in StoredValue. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `plainValue` | string | No | — | Plain Value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "plainValue": { "type": "string", "description": "Plain Value" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_build\_artifact Download build artifact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `jobId` | string | Yes | — | Build ID (`jobId` property of `BuildJob`) | | `artifactFileName` | string | Yes | — | File name (or path) of a build artifact file. Corresponds to the `fileName` property of `ArtifactModel`. URL-encoding of slashes in parameter values is optional. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Build ID (`jobId` property of `BuildJob`)" }, "artifactFileName": { "type": "string", "description": "File name (or path) of a build artifact file. Corresponds to the `fileName` property of `ArtifactModel`. URL-encoding of slashes in parameter values is optional." } }, "required": [ "PCID", "jobId", "artifactFileName" ] } ``` *** ## appveyor\_get\_build\_artifacts Get build artifacts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `jobId` | string | Yes | — | Build ID (`jobId` property of `BuildJob`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Build ID (`jobId` property of `BuildJob`)" } }, "required": [ "PCID", "jobId" ] } ``` *** ## appveyor\_get\_build\_log Download build log **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `jobId` | string | Yes | — | Build ID (`jobId` property of `BuildJob`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Build ID (`jobId` property of `BuildJob`)" } }, "required": [ "PCID", "jobId" ] } ``` *** ## appveyor\_get\_collaborator Get collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | integer | Yes | — | User ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "integer", "description": "User ID" } }, "required": [ "PCID", "userId" ] } ``` *** ## appveyor\_get\_collaborators Get collaborators ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_deployment Get deployment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deploymentId` | integer | Yes | — | Deployment ID (`deploymentId` property of `Deployment`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deploymentId": { "type": "integer", "description": "Deployment ID (`deploymentId` property of `Deployment`)" } }, "required": [ "PCID", "deploymentId" ] } ``` *** ## appveyor\_get\_environment\_deployments Get environment deployments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deploymentEnvironmentId` | integer | Yes | — | Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deploymentEnvironmentId": { "type": "integer", "description": "Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`)" } }, "required": [ "PCID", "deploymentEnvironmentId" ] } ``` *** ## appveyor\_get\_environment\_settings Get environment settings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deploymentEnvironmentId` | integer | Yes | — | Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deploymentEnvironmentId": { "type": "integer", "description": "Deployment Environment ID (`deploymentEnvironmentId` property of `DeploymentEnvironment`)" } }, "required": [ "PCID", "deploymentEnvironmentId" ] } ``` *** ## appveyor\_get\_environments Get environments ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_project\_artifact Get last successful build artifact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `artifactFileName` | string | Yes | — | File name (or path) of a build artifact file. Corresponds to the `fileName` property of `ArtifactModel`. URL-encoding of slashes in parameter values is optional. | | `branch` | string | No | — | Repository Branch | | `tag` | string | No | — | A git (or other VCS) tag | | `job` | string | No | — | Name of the build job. | | `all` | boolean | No | — | Include not only `successful`, but also jobs with `failed`, and `cancelled` status. | | `pr` | boolean | No | — | Include PR builds in the search results? `true` - take artifact from PR builds only; `false` - do not look for artifact in PR builds; default/unspecified - look for artifact in both PR an non-PR builds. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "artifactFileName": { "type": "string", "description": "File name (or path) of a build artifact file. Corresponds to the `fileName` property of `ArtifactModel`. URL-encoding of slashes in parameter values is optional." }, "branch": { "type": "string", "description": "Repository Branch" }, "tag": { "type": "string", "description": "A git (or other VCS) tag" }, "job": { "type": "string", "description": "Name of the build job." }, "all": { "type": "boolean", "description": "Include not only `successful`, but also jobs with `failed`, and `cancelled` status." }, "pr": { "type": "boolean", "description": "Include PR builds in the search results? `true` - take artifact from PR builds only; `false` - do not look for artifact in PR builds; default/unspecified - look for artifact in both PR an non-PR builds." } }, "required": [ "PCID", "accountName", "projectSlug", "artifactFileName" ] } ``` *** ## appveyor\_get\_project\_branch\_status\_badge Get project branch status badge image **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `statusBadgeId` | string | Yes | — | ID of the status badge (`statusBadgeId` from `ProjectWithConfiguration`). | | `buildBranch` | string | Yes | — | Build Branch | | `svg` | boolean | No | — | Return an SVG image instead of PNG? Exclusive with `retina`. | | `retina` | boolean | No | — | Return a larger image suitable for retina displays? Exclusive with `svg`. | | `passingText` | string | No | — | Text to show in badge when build is passing. | | `failingText` | string | No | — | Text to show in badge when build is failing. | | `pendingText` | string | No | — | Text to show in badge when build is pending. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "statusBadgeId": { "type": "string", "description": "ID of the status badge (`statusBadgeId` from `ProjectWithConfiguration`)." }, "buildBranch": { "type": "string", "description": "Build Branch" }, "svg": { "type": "boolean", "description": "Return an SVG image instead of PNG? Exclusive with `retina`." }, "retina": { "type": "boolean", "description": "Return a larger image suitable for retina displays? Exclusive with `svg`." }, "passingText": { "type": "string", "description": "Text to show in badge when build is passing." }, "failingText": { "type": "string", "description": "Text to show in badge when build is failing." }, "pendingText": { "type": "string", "description": "Text to show in badge when build is pending." } }, "required": [ "PCID", "statusBadgeId", "buildBranch" ] } ``` *** ## appveyor\_get\_project\_build\_by\_version Get project build by version **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `buildVersion` | string | Yes | — | Build Version (`version` property of `Build`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "buildVersion": { "type": "string", "description": "Build Version (`version` property of `Build`)" } }, "required": [ "PCID", "accountName", "projectSlug", "buildVersion" ] } ``` *** ## appveyor\_get\_project\_deployments Get project deployments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `recordsNumber` | integer | Yes | — | Number of results to include in the response. getProjectDeployments is documented to have a maximum of 20. It currently returns 500 Internal Server Error for recordsNumber \<= 5. In the past it has returned 500 Internal Server Error for many different values which did not match the value used by the ci.appveyor.com web interface at the time. As of 2018-09-08, the value used by the web interface is 10. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "recordsNumber": { "type": "integer", "description": "Number of results to include in the response. getProjectDeployments is documented to have a maximum of 20. It currently returns 500 Internal Server Error for recordsNumber <= 5. In the past it has returned 500 Internal Server Error for many different values which did not match the value used by the ci.appveyor.com web interface at the time. As of 2018-09-08, the value used by the web interface is 10." } }, "required": [ "PCID", "accountName", "projectSlug", "recordsNumber" ] } ``` *** ## appveyor\_get\_project\_environment\_variables Get project environment variables **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_get\_project\_history Get project history **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `recordsNumber` | integer | Yes | — | Number of results to include in the response. getProjectDeployments is documented to have a maximum of 20. It currently returns 500 Internal Server Error for recordsNumber \<= 5. In the past it has returned 500 Internal Server Error for many different values which did not match the value used by the ci.appveyor.com web interface at the time. As of 2018-09-08, the value used by the web interface is 10. | | `startBuildId` | integer | No | — | Maximum `buildId` to include in the results (exclusive). | | `branch` | string | No | — | Repository Branch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "recordsNumber": { "type": "integer", "description": "Number of results to include in the response. getProjectDeployments is documented to have a maximum of 20. It currently returns 500 Internal Server Error for recordsNumber <= 5. In the past it has returned 500 Internal Server Error for many different values which did not match the value used by the ci.appveyor.com web interface at the time. As of 2018-09-08, the value used by the web interface is 10." }, "startBuildId": { "type": "integer", "description": "Maximum `buildId` to include in the results (exclusive)." }, "branch": { "type": "string", "description": "Repository Branch" } }, "required": [ "PCID", "accountName", "projectSlug", "recordsNumber" ] } ``` *** ## appveyor\_get\_project\_last\_build Get project last build **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_get\_project\_last\_build\_branch Get project last branch build **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `buildBranch` | string | Yes | — | Build Branch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "buildBranch": { "type": "string", "description": "Build Branch" } }, "required": [ "PCID", "accountName", "projectSlug", "buildBranch" ] } ``` *** ## appveyor\_get\_project\_settings Get project settings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_get\_project\_settings\_yaml Get project settings in YAML **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_get\_project\_status\_badge Get project status badge image **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `statusBadgeId` | string | Yes | — | ID of the status badge (`statusBadgeId` from `ProjectWithConfiguration`). | | `svg` | boolean | No | — | Return an SVG image instead of PNG? Exclusive with `retina`. | | `retina` | boolean | No | — | Return a larger image suitable for retina displays? Exclusive with `svg`. | | `passingText` | string | No | — | Text to show in badge when build is passing. | | `failingText` | string | No | — | Text to show in badge when build is failing. | | `pendingText` | string | No | — | Text to show in badge when build is pending. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "statusBadgeId": { "type": "string", "description": "ID of the status badge (`statusBadgeId` from `ProjectWithConfiguration`)." }, "svg": { "type": "boolean", "description": "Return an SVG image instead of PNG? Exclusive with `retina`." }, "retina": { "type": "boolean", "description": "Return a larger image suitable for retina displays? Exclusive with `svg`." }, "passingText": { "type": "string", "description": "Text to show in badge when build is passing." }, "failingText": { "type": "string", "description": "Text to show in badge when build is failing." }, "pendingText": { "type": "string", "description": "Text to show in badge when build is pending." } }, "required": [ "PCID", "statusBadgeId" ] } ``` *** ## appveyor\_get\_projects Get projects ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_public\_project\_status\_badge Get status badge image for a project with a public repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `badgeRepoProvider` | string | Yes | — | Repository provider supported for badges | | `repoAccountName` | string | Yes | — | Account name with repository provider | | `repoSlug` | string | Yes | — | Slug (URL component) of repository. | | `branch` | string | No | — | Repository Branch | | `svg` | boolean | No | — | Return an SVG image instead of PNG? Exclusive with `retina`. | | `retina` | boolean | No | — | Return a larger image suitable for retina displays? Exclusive with `svg`. | | `passingText` | string | No | — | Text to show in badge when build is passing. | | `failingText` | string | No | — | Text to show in badge when build is failing. | | `pendingText` | string | No | — | Text to show in badge when build is pending. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "badgeRepoProvider": { "type": "string", "description": "Repository provider supported for badges", "enum": [ "bitBucket", "gitHub" ] }, "repoAccountName": { "type": "string", "description": "Account name with repository provider" }, "repoSlug": { "type": "string", "description": "Slug (URL component) of repository." }, "branch": { "type": "string", "description": "Repository Branch" }, "svg": { "type": "boolean", "description": "Return an SVG image instead of PNG? Exclusive with `retina`." }, "retina": { "type": "boolean", "description": "Return a larger image suitable for retina displays? Exclusive with `svg`." }, "passingText": { "type": "string", "description": "Text to show in badge when build is passing." }, "failingText": { "type": "string", "description": "Text to show in badge when build is failing." }, "pendingText": { "type": "string", "description": "Text to show in badge when build is pending." } }, "required": [ "PCID", "badgeRepoProvider", "repoAccountName", "repoSlug" ] } ``` *** ## appveyor\_get\_role Get role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `roleId` | integer | Yes | — | Role ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "roleId": { "type": "integer", "description": "Role ID" } }, "required": [ "PCID", "roleId" ] } ``` *** ## appveyor\_get\_roles Get roles ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_user Get user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | integer | Yes | — | User ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "integer", "description": "User ID" } }, "required": [ "PCID", "userId" ] } ``` *** ## appveyor\_get\_user\_invitations Get user invitations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_get\_users Get users ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_invite\_user Invite user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `email` | string | Yes | — | The email value | | `roleId` | integer | Yes | — | Role Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email": { "type": "string", "description": "The email value" }, "roleId": { "type": "integer", "description": "Role Id" } }, "required": [ "PCID", "email", "roleId" ] } ``` *** ## appveyor\_join\_account Join Account **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `invitationId` | string | Yes | — | Invitation Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "invitationId": { "type": "string", "description": "Invitation Id" } }, "required": [ "PCID", "invitationId" ] } ``` *** ## appveyor\_re\_run\_build Re-run build **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `buildId` | integer | Yes | — | Build Id | | `reRunIncomplete` | boolean | No | — | Set `reRunIncomplete` set to `false` (default value) for full build re-run. Set it set to `true` to rerun only failed or cancelled jobs in multijob build. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "buildId": { "type": "integer", "description": "Build Id" }, "reRunIncomplete": { "type": "boolean", "description": "Set `reRunIncomplete` set to `false` (default value) for full build re-run. Set it set to `true` to rerun only failed or cancelled jobs in multijob build." } }, "required": [ "PCID", "buildId" ] } ``` *** ## appveyor\_start\_build Start build of branch most recent commit **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | Account Name | | `branch` | string | No | — | The branch value | | `commitId` | string | No | — | Commit Id | | `environmentVariables` | object | No | — | Environment Variables | | `projectSlug` | string | Yes | — | Project Slug | | `pullRequestId` | integer | No | — | Can not be used with `branch` or `commitId` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "Account Name" }, "branch": { "type": "string", "description": "The branch value" }, "commitId": { "type": "string", "description": "Commit Id" }, "environmentVariables": { "type": "object", "description": "Environment Variables" }, "projectSlug": { "type": "string", "description": "Project Slug" }, "pullRequestId": { "type": "integer", "description": "Can not be used with `branch` or `commitId`" } }, "required": [ "PCID", "accountName", "projectSlug" ] } ``` *** ## appveyor\_start\_deployment Start deployment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | Account Name | | `buildJobId` | string | No | — | Optional job id with artifacts if build contains multiple jobs. | | `buildVersion` | string | Yes | — | Build to deploy | | `environmentName` | string | Yes | — | Environment Name | | `environmentVariables` | object | No | — | Environment Variables | | `projectSlug` | string | Yes | — | Project Slug | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "Account Name" }, "buildJobId": { "type": "string", "description": "Optional job id with artifacts if build contains multiple jobs." }, "buildVersion": { "type": "string", "description": "Build to deploy" }, "environmentName": { "type": "string", "description": "Environment Name" }, "environmentVariables": { "type": "object", "description": "Environment Variables" }, "projectSlug": { "type": "string", "description": "Project Slug" } }, "required": [ "PCID", "accountName", "buildVersion", "environmentName", "projectSlug" ] } ``` *** ## appveyor\_update\_collaborator Update collaborator **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `roleId` | integer | Yes | — | Role Id | | `userId` | integer | Yes | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "roleId": { "type": "integer", "description": "Role Id" }, "userId": { "type": "integer", "description": "User Id" } }, "required": [ "PCID", "roleId", "userId" ] } ``` *** ## appveyor\_update\_environment Update environment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountId` | integer | No | — | Account Id | | `deploymentEnvironmentId` | integer | No | — | Deployment Environment Id | | `environmentAccessKey` | string | No | — | Environment Access Key | | `name` | string | No | — | The name value | | `projects` | object\[] | No | — | Projects available for selection in UI | | `projectsMode` | integer | No | — | Project selection mode for deployment environments. | | `provider` | string | No | — | The provider value | | `securityDescriptor` | object | No | — | Security Descriptor | | `selectedProjects` | integer\[] | No | — | Project IDs of selected projects | | `settings` | object | No | — | The settings value | | `tags` | string | No | — | The tags value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountId": { "type": "integer", "description": "Account Id" }, "deploymentEnvironmentId": { "type": "integer", "description": "Deployment Environment Id" }, "environmentAccessKey": { "type": "string", "description": "Environment Access Key" }, "name": { "type": "string", "description": "The name value" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "integer", "description": "Project Id" }, "name": { "type": "string", "description": "The name value" }, "isSelected": { "type": "boolean", "description": "Is Selected" } }, "required": [ "projectId", "name", "isSelected" ] }, "description": "Projects available for selection in UI" }, "projectsMode": { "type": "integer", "description": "Project selection mode for deployment environments.", "enum": [ 0, 1, 2 ] }, "provider": { "type": "string", "description": "The provider value", "enum": [ "Agent", "AzureBlob", "AzureCS", "AzureWebJob", "BinTray", "FTP", "GitHub", "NuGet", "S3", "SqlDatabase", "WebDeploy", "Webhook" ] }, "securityDescriptor": { "type": "object", "description": "Security Descriptor", "properties": { "accessRightDefinitions": { "type": "array", "items": { "type": "object" }, "description": "Access Right Definitions" }, "roleAces": { "type": "array", "items": { "type": "object" }, "description": "Role Aces" } } }, "selectedProjects": { "type": "array", "items": { "type": "integer" }, "description": "Project IDs of selected projects" }, "settings": { "type": "object", "description": "The settings value", "properties": { "providerSettings": { "type": "array", "items": { "type": "object" }, "description": "Provider Settings" }, "environmentVariables": { "type": "array", "items": { "type": "object" }, "description": "Environment Variables" }, "notifications": { "type": "array", "items": { "type": "object" }, "description": "The notifications value" } } }, "tags": { "type": "string", "description": "The tags value" } }, "required": [ "PCID" ] } ``` *** ## appveyor\_update\_project Update project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | No | — | Account Name | | `alwaysBuildClosedPullRequests` | boolean | No | — | Always Build Closed Pull Requests | | `buildPriority` | integer | No | — | Build Priority | | `configuration` | object | No | — | The configuration value | | `enableDeploymentInPullRequests` | boolean | No | — | Enable Deployment In Pull Requests | | `enableSecureVariablesInPullRequests` | boolean | No | — | Enable Secure Variables In Pull Requests | | `isPrivate` | boolean | No | — | Is Private | | `name` | string | No | — | The name value | | `nextBuildNumber` | integer | No | — | Next Build Number | | `nuGetFeed` | object | No | — | NuGet feed configuration for the project | | `projectId` | integer | Yes | — | Project Id | | `repositoryName` | string | No | — | Repository Name | | `repositoryScm` | string | No | — | Repository Scm | | `repositoryType` | string | No | — | Repository Type | | `saveBuildCacheInPullRequests` | boolean | No | — | Save Build Cache In Pull Requests | | `scheduleCrontabExpression` | string | No | — | Schedule Crontab Expression | | `securityDescriptor` | object | No | — | Security Descriptor | | `skipBranchesWithoutAppveyorYml` | boolean | No | — | Skip Branches Without Appveyor Yml | | `slug` | string | No | — | The slug value | | `versionFormat` | string | No | — | Version Format | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "Account Name" }, "alwaysBuildClosedPullRequests": { "type": "boolean", "description": "Always Build Closed Pull Requests" }, "buildPriority": { "type": "integer", "description": "Build Priority" }, "configuration": { "type": "object", "description": "The configuration value", "properties": { "doNotIncrementBuildNumberOnPullRequests": { "type": "boolean", "description": "Do Not Increment Build Number On Pull Requests" }, "hotFixScripts": { "type": "array", "items": { "type": "object" }, "description": "Hot Fix Scripts" }, "initScripts": { "type": "array", "items": { "type": "object" }, "description": "Init Scripts" }, "branchesMode": { "type": "string", "description": "Branches Mode", "enum": [ "exclude", "include" ] }, "includeBranches": { "type": "array", "items": { "type": "object" }, "description": "Include Branches" }, "excludeBranches": { "type": "array", "items": { "type": "object" }, "description": "Exclude Branches" }, "skipTags": { "type": "boolean", "description": "Skip Tags" }, "skipNonTags": { "type": "boolean", "description": "Skip Non Tags" }, "skipBranchWithPullRequests": { "type": "boolean", "description": "Skip Branch With Pull Requests" }, "skipCommitsFiles": { "type": "array", "items": { "type": "object" }, "description": "Skip Commits Files" }, "onlyCommitsFiles": { "type": "array", "items": { "type": "object" }, "description": "Only Commits Files" }, "cloneScripts": { "type": "array", "items": { "type": "object" }, "description": "Clone Scripts" }, "onBuildSuccessScripts": { "type": "array", "items": { "type": "object" }, "description": "On Build Success Scripts" }, "onBuildErrorScripts": { "type": "array", "items": { "type": "object" }, "description": "On Build Error Scripts" }, "onBuildFinishScripts": { "type": "array", "items": { "type": "object" }, "description": "On Build Finish Scripts" }, "patchAssemblyInfo": { "type": "boolean", "description": "Patch Assembly Info" }, "assemblyInfoFile": { "type": "string", "description": "Assembly Info File" }, "assemblyVersionFormat": { "type": "string", "description": "Assembly Version Format" }, "assemblyFileVersionFormat": { "type": "string", "description": "Assembly File Version Format" }, "assemblyInformationalVersionFormat": { "type": "string", "description": "Assembly Informational Version Format" }, "patchDotnetCsproj": { "type": "boolean", "description": "Patch Dotnet Csproj" }, "dotnetCsprojFile": { "type": "string", "description": "Dotnet Csproj File" }, "dotnetCsprojVersionFormat": { "type": "string", "description": "Dotnet Csproj Version Format" }, "dotnetCsprojAssemblyVersionFormat": { "type": "string", "description": "Dotnet Csproj Assembly Version Format" }, "dotnetCsprojFileVersionFormat": { "type": "string", "description": "Dotnet Csproj File Version Format" }, "dotnetCsprojInformationalVersionFormat": { "type": "string", "description": "Dotnet Csproj Informational Version Format" }, "dotnetCsprojPackageVersionFormat": { "type": "string", "description": "Dotnet Csproj Package Version Format" }, "maxJobs": { "type": "integer", "description": "Max Jobs" }, "buildCloud": { "type": "array", "items": { "type": "object" }, "description": "Build Cloud" }, "operatingSystem": { "type": "array", "items": { "type": "object" }, "description": "Operating System" }, "services": { "type": "array", "items": { "type": "object" }, "description": "The services value" }, "stacks": { "type": "array", "items": { "type": "string", "enum": [ "unknown" ] }, "description": "The stacks value" }, "cloneFolder": { "type": "string", "description": "Clone Folder" }, "shallowClone": { "type": "boolean", "description": "Shallow Clone" }, "forceHttpsClone": { "type": "boolean", "description": "Force Https Clone" }, "cloneDepth": { "type": "integer", "description": "Clone Depth" }, "environmentVariables": { "type": "array", "items": { "type": "object" }, "description": "Environment Variables" }, "environmentVariablesMatrix": { "type": "array", "items": { "type": "object" }, "description": "Environment Variables Matrix" }, "installScripts": { "type": "array", "items": { "type": "object" }, "description": "Install Scripts" }, "hostsEntries": { "type": "array", "items": { "type": "object" }, "description": "Hosts Entries" }, "cacheEntries": { "type": "array", "items": { "type": "object" }, "description": "Cache Entries" }, "configureNuGetProjectSource": { "type": "boolean", "description": "Configure Nu Get Project Source" }, "configureNuGetAccountSource": { "type": "boolean", "description": "Configure Nu Get Account Source" }, "disableNuGetPublishOnPullRequests": { "type": "boolean", "description": "Disable Nu Get Publish On Pull Requests" }, "disableNuGetPublishForOctopusPackages": { "type": "boolean", "description": "Disable Nu Get Publish For Octopus Packages" }, "buildMode": { "type": "string", "description": "Build Mode", "enum": [ "msbuild", "none", "script" ] }, "platform": { "type": "array", "items": { "type": "object" }, "description": "The platform value" }, "configuration": { "type": "array", "items": { "type": "object" }, "description": "The configuration value" }, "msBuildProjectFileName": { "type": "string", "description": "Ms Build Project File Name" }, "packageWebApplicationProjects": { "type": "boolean", "description": "Package Web Application Projects" }, "packageWebApplicationProjectsXCopy": { "type": "boolean", "description": "Package Web Application Projects X Copy" }, "packageWebApplicationProjectsBeanstalk": { "type": "boolean", "description": "Package Web Application Projects Beanstalk" }, "packageWebApplicationProjectsOctopus": { "type": "boolean", "description": "Package Web Application Projects Octopus" }, "packageAzureCloudServiceProjects": { "type": "boolean", "description": "Package Azure Cloud Service Projects" }, "packageNuGetProjects": { "type": "boolean", "description": "Package Nu Get Projects" }, "packageNuGetSymbols": { "type": "boolean", "description": "Package Nu Get Symbols" }, "packageAspNetCoreProjects": { "type": "boolean", "description": "Package Asp Net Core Projects" }, "packageDotnetConsoleProjects": { "type": "boolean", "description": "Package Dotnet Console Projects" }, "includeNuGetReferences": { "type": "boolean", "description": "Include Nu Get References" }, "msBuildInParallel": { "type": "boolean", "description": "Ms Build In Parallel" }, "msBuildVerbosity": { "type": "string", "description": "Ms Build Verbosity", "enum": [ "quiet", "minimal", "normal", "detailed" ] }, "buildScripts": { "type": "array", "items": { "type": "object" }, "description": "Only set/used when `buildMode` is `script`." }, "beforeBuildScripts": { "type": "array", "items": { "type": "object" }, "description": "Before Build Scripts" }, "beforePackageScripts": { "type": "array", "items": { "type": "object" }, "description": "Before Package Scripts" }, "afterBuildScripts": { "type": "array", "items": { "type": "object" }, "description": "After Build Scripts" }, "testMode": { "type": "string", "description": "Test Mode", "enum": [ "auto", "none", "script" ] }, "testAssemblies": { "type": "array", "items": { "type": "object" }, "description": "Test Assemblies" }, "testCategoriesMode": { "type": "string", "description": "Test Categories Mode", "enum": [ "exclude", "include" ] }, "testCategories": { "type": "array", "items": { "type": "object" }, "description": "Test Categories" }, "testCategoriesMatrix": { "type": "array", "items": { "type": "object" }, "description": "Test Categories Matrix" }, "testScripts": { "type": "array", "items": { "type": "object" }, "description": "Only set/used when `testMode` is `script`." }, "beforeTestScripts": { "type": "array", "items": { "type": "object" }, "description": "Before Test Scripts" }, "afterTestScripts": { "type": "array", "items": { "type": "object" }, "description": "After Test Scripts" }, "deployMode": { "type": "string", "description": "Deploy Mode", "enum": [ "providers", "none", "script" ] }, "deployments": { "type": "array", "items": { "type": "object" }, "description": "The deployments value" }, "deployScripts": { "type": "array", "items": { "type": "object" }, "description": "Deploy Scripts" }, "beforeDeployScripts": { "type": "array", "items": { "type": "object" }, "description": "Before Deploy Scripts" }, "afterDeployScripts": { "type": "array", "items": { "type": "object" }, "description": "After Deploy Scripts" }, "xamarinRegisterAndroidProduct": { "type": "boolean", "description": "Xamarin Register Android Product" }, "xamarinRegisterIosProduct": { "type": "boolean", "description": "Xamarin Register Ios Product" }, "matrixFastFinish": { "type": "boolean", "description": "Matrix Fast Finish" }, "matrixAllowFailures": { "type": "array", "items": { "type": "object" }, "description": "Although the names and values are not enforced, the combinations which are meaningful are documented at https://www.appveyor.com/docs/build-configuration/#allow-failing-jobs" }, "matrixExclude": { "type": "array", "items": { "type": "object" }, "description": "Matrix Exclude" }, "matrixOnly": { "type": "array", "items": { "type": "object" }, "description": "Matrix Only" }, "matrixExcept": { "type": "array", "items": { "type": "object" }, "description": "Matrix Except" }, "artifacts": { "type": "array", "items": { "type": "object" }, "description": "The artifacts value" }, "notifications": { "type": "array", "items": { "type": "object" }, "description": "The notifications value" } } }, "enableDeploymentInPullRequests": { "type": "boolean", "description": "Enable Deployment In Pull Requests" }, "enableSecureVariablesInPullRequests": { "type": "boolean", "description": "Enable Secure Variables In Pull Requests" }, "isPrivate": { "type": "boolean", "description": "Is Private" }, "name": { "type": "string", "description": "The name value" }, "nextBuildNumber": { "type": "integer", "description": "Next Build Number" }, "nuGetFeed": { "type": "object", "description": "NuGet feed configuration for the project" }, "projectId": { "type": "integer", "description": "Project Id" }, "repositoryName": { "type": "string", "description": "Repository Name" }, "repositoryScm": { "type": "string", "description": "Repository Scm", "enum": [ "git", "mercurial", "subversion" ] }, "repositoryType": { "type": "string", "description": "Repository Type", "enum": [ "bitBucket", "git", "gitHub", "gitLab", "kiln", "mercurial", "stash", "subversion", "vso" ] }, "saveBuildCacheInPullRequests": { "type": "boolean", "description": "Save Build Cache In Pull Requests" }, "scheduleCrontabExpression": { "type": "string", "description": "Schedule Crontab Expression" }, "securityDescriptor": { "type": "object", "description": "Security Descriptor", "properties": { "accessRightDefinitions": { "type": "array", "items": { "type": "object" }, "description": "Access Right Definitions" }, "roleAces": { "type": "array", "items": { "type": "object" }, "description": "Role Aces" } } }, "skipBranchesWithoutAppveyorYml": { "type": "boolean", "description": "Skip Branches Without Appveyor Yml" }, "slug": { "type": "string", "description": "The slug value" }, "versionFormat": { "type": "string", "description": "Version Format" } }, "required": [ "PCID", "projectId" ] } ``` *** ## appveyor\_update\_project\_build\_number Update project build number **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `nextBuildNumber` | integer | Yes | — | Next Build Number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "nextBuildNumber": { "type": "integer", "description": "Next Build Number" } }, "required": [ "PCID", "accountName", "projectSlug", "nextBuildNumber" ] } ``` *** ## appveyor\_update\_project\_environment\_variables Update project environment variables **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "body": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "value": { "type": "object", "description": "The value value" } }, "required": [ "name", "value" ] }, "description": "Request body" } }, "required": [ "PCID", "accountName", "projectSlug", "body" ] } ``` *** ## appveyor\_update\_project\_settings\_yaml Update project settings in YAML **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountName` | string | Yes | — | AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`. | | `projectSlug` | string | Yes | — | Project Slug | | `body` | string | Yes | — | The body of requests should contain YAML data. It is unclear how to specify this since the OpenAPI spec requires `schema` without `type` for `in: body` parameters and does not allow `type: file` in `schema`. See [https://github.com/OAI/OpenAPI-Specification/issues/326](https://github.com/OAI/OpenAPI-Specification/issues/326) swagger-codegen (for Java, probably others) allows a binary string body parameter with non-application/json `consumes` to be passed through in the request body without conversion to JSON. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountName": { "type": "string", "description": "AppVeyor account name on which to operate. Accounts for which a user has access are listed on the [Security page of the user profile](https://ci.appveyor.com/security) (when logged in). The user account is also the `accountName` property of `UserAccount`." }, "projectSlug": { "type": "string", "description": "Project Slug" }, "body": { "type": "string", "description": "The body of requests should contain YAML data. It is unclear how to specify this since the OpenAPI spec requires `schema` without `type` for `in: body` parameters and does not allow `type: file` in `schema`. See https://github.com/OAI/OpenAPI-Specification/issues/326 swagger-codegen (for Java, probably others) allows a binary string body parameter with non-application/json `consumes` to be passed through in the request body without conversion to JSON." } }, "required": [ "PCID", "accountName", "projectSlug", "body" ] } ``` *** ## appveyor\_update\_role Update role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `groups` | object\[] | No | — | The groups value | | `isSystem` | boolean | No | — | Is System | | `name` | string | Yes | — | The name value | | `roleId` | integer | Yes | — | Role Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Account", "BuildEnvironment", "Deny", "Environments", "Projects", "Roles", "User", "Users" ], "description": "The name value" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Available permission names. The names correspond to the following groups: #### AccountPermission - ManageApplicationAuthorizations - UpdateAccountDetails - UpdateBillingDetails #### BuildEnvironmentPermission - ConfigureBuildEnvironment #### DenyPermission - DenyAllProjectsEnvironments #### EnvironmentsPermission - DeployToEnvironment - ManageEnvironments - UpdateEnvironmentSettings #### ProjectsPermission - ManageProjects - RunProjectBuild - UpdateProjectSettings #### RolesPermission - AddRole - DeleteRole - UpdateRoleDetails #### UserPermission - ConfigureApiKeys #### UsersPermission - AddUser - DeleteUser - UpdateUserDetails " }, "description": { "type": "string" }, "allowed": { "type": "boolean", "description": "State of the named permission. `true` to allow, `false` to deny, missing to inherit. " } } }, "description": "The permissions value" } }, "required": [ "name", "permissions" ] }, "description": "The groups value" }, "isSystem": { "type": "boolean", "description": "Is System" }, "name": { "type": "string", "description": "The name value" }, "roleId": { "type": "integer", "description": "Role Id" } }, "required": [ "PCID", "name", "roleId" ] } ``` *** ## appveyor\_update\_user Update user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `accountId` | integer | No | — | Account Id | | `accountName` | string | No | — | Account Name | | `created` | string | No | — | The created value | | `email` | string | Yes | — | The email value | | `fullName` | string | Yes | — | Full Name | | `isCollaborator` | boolean | No | — | Is Collaborator | | `isOwner` | boolean | No | — | Is Owner | | `pageSize` | integer | No | — | Number of results per page | | `password` | string | No | — | The password value | | `roleId` | integer | No | — | Role Id | | `roleName` | string | No | — | Role Name | | `twoFactorAuthEnabled` | boolean | No | — | Two Factor Auth Enabled | | `updated` | string | No | — | The updated value | | `userId` | integer | Yes | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountId": { "type": "integer", "description": "Account Id" }, "accountName": { "type": "string", "description": "Account Name" }, "created": { "type": "string", "description": "The created value" }, "email": { "type": "string", "description": "The email value" }, "fullName": { "type": "string", "description": "Full Name" }, "isCollaborator": { "type": "boolean", "description": "Is Collaborator" }, "isOwner": { "type": "boolean", "description": "Is Owner" }, "pageSize": { "type": "integer", "description": "Number of results per page" }, "password": { "type": "string", "description": "The password value" }, "roleId": { "type": "integer", "description": "Role Id" }, "roleName": { "type": "string", "description": "Role Name" }, "twoFactorAuthEnabled": { "type": "boolean", "description": "Two Factor Auth Enabled" }, "updated": { "type": "string", "description": "The updated value" }, "userId": { "type": "integer", "description": "User Id" } }, "required": [ "PCID", "email", "fullName", "userId" ] } ``` # asana-api Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/asana-api Asana — project and task management platform for teams **PinkConnect service:** `asana` | **Type:** Application (parent with child servers) | **PCID required:** Yes asana-api is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [asana-customization](/api-reference/mcp-servers/application/asana-api/asana-customization) | `/asana-customization` | 34 | Asana Customization — manage custom fields, custom types, roles, allocations, budgets, and rates | | [asana-goals](/api-reference/mcp-servers/application/asana-api/asana-goals) | `/asana-goals` | 17 | Asana Goals — create, update, and track goals, metrics, and goal relationships | | [asana-portfolios](/api-reference/mcp-servers/application/asana-api/asana-portfolios) | `/asana-portfolios` | 16 | Asana Portfolios — create, update, and manage portfolios, portfolio items, and memberships | | [asana-projects](/api-reference/mcp-servers/application/asana-api/asana-projects) | `/asana-projects` | 38 | Asana Projects — create, update, and manage projects, briefs, statuses, templates, and project memberships | | [asana-task-details](/api-reference/mcp-servers/application/asana-api/asana-task-details) | `/asana-task-details` | 27 | Asana Task Details — manage comments/stories, sections, tags, time tracking entries, and reactions on tasks | | [asana-tasks](/api-reference/mcp-servers/application/asana-api/asana-tasks) | `/asana-tasks` | 31 | Asana Tasks — create, update, search, and manage tasks, subtasks, dependencies, and task templates | | [asana-users-teams](/api-reference/mcp-servers/application/asana-api/asana-users-teams) | `/asana-users-teams` | 38 | Asana Users & Teams — manage users, teams, team memberships, workspaces, workspace memberships, and user task lists | | [asana-utilities](/api-reference/mcp-servers/application/asana-api/asana-utilities) | `/asana-utilities` | 32 | Asana Utilities — webhooks, attachments, status updates, access requests, exports, events, and other administrative operations | # asana-customization Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/asana-api/asana-customization Asana Customization — manage custom fields, custom types, roles, allocations, budgets, and rates **Server path:** `/asana-customization` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`asana_customization_create_allocation`](#asana_customization_create_allocation) | Create an allocation | | [`asana_customization_create_budget`](#asana_customization_create_budget) | Create a budget | | [`asana_customization_create_custom_field`](#asana_customization_create_custom_field) | Create a custom field | | [`asana_customization_create_enum_option_for_custom_field`](#asana_customization_create_enum_option_for_custom_field) | Create an enum option | | [`asana_customization_create_rate`](#asana_customization_create_rate) | Create a rate | | [`asana_customization_create_role`](#asana_customization_create_role) | Create a role | | [`asana_customization_delete_allocation`](#asana_customization_delete_allocation) | Delete an allocation | | [`asana_customization_delete_budget`](#asana_customization_delete_budget) | Delete a budget | | [`asana_customization_delete_custom_field`](#asana_customization_delete_custom_field) | Delete a custom field | | [`asana_customization_delete_rate`](#asana_customization_delete_rate) | Delete a rate | | [`asana_customization_delete_role`](#asana_customization_delete_role) | Delete a role | | [`asana_customization_get_allocation`](#asana_customization_get_allocation) | Get an allocation | | [`asana_customization_get_allocations`](#asana_customization_get_allocations) | Get multiple allocations | | [`asana_customization_get_budget`](#asana_customization_get_budget) | Get a budget | | [`asana_customization_get_budgets`](#asana_customization_get_budgets) | Get all budgets | | [`asana_customization_get_custom_field`](#asana_customization_get_custom_field) | Get a custom field | | [`asana_customization_get_custom_field_settings_for_goal`](#asana_customization_get_custom_field_settings_for_goal) | Get a goal's custom fields | | [`asana_customization_get_custom_field_settings_for_portfolio`](#asana_customization_get_custom_field_settings_for_portfolio) | Get a portfolio's custom fields | | [`asana_customization_get_custom_field_settings_for_project`](#asana_customization_get_custom_field_settings_for_project) | Get a project's custom fields | | [`asana_customization_get_custom_field_settings_for_team`](#asana_customization_get_custom_field_settings_for_team) | Get a team's custom fields | | [`asana_customization_get_custom_fields_for_workspace`](#asana_customization_get_custom_fields_for_workspace) | Get a workspace's custom fields | | [`asana_customization_get_custom_type`](#asana_customization_get_custom_type) | Get a custom type | | [`asana_customization_get_custom_types`](#asana_customization_get_custom_types) | Get all custom types associated with an object | | [`asana_customization_get_rate`](#asana_customization_get_rate) | Get a rate | | [`asana_customization_get_rates`](#asana_customization_get_rates) | Get multiple rates | | [`asana_customization_get_role`](#asana_customization_get_role) | Get a role | | [`asana_customization_get_roles`](#asana_customization_get_roles) | Get multiple roles | | [`asana_customization_insert_enum_option_for_custom_field`](#asana_customization_insert_enum_option_for_custom_field) | Reorder a custom field's enum | | [`asana_customization_update_allocation`](#asana_customization_update_allocation) | Update an allocation | | [`asana_customization_update_budget`](#asana_customization_update_budget) | Update a budget | | [`asana_customization_update_custom_field`](#asana_customization_update_custom_field) | Update a custom field | | [`asana_customization_update_enum_option`](#asana_customization_update_enum_option) | Update an enum option | | [`asana_customization_update_rate`](#asana_customization_update_rate) | Update a rate | | [`asana_customization_update_role`](#asana_customization_update_role) | Update a role | *** ## asana\_customization\_create\_allocation Create an allocation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "assignee", "assignee.name", "created_by", "created_by.name", "effort", "effort.type", "effort.value", "end_date", "parent", "parent.name", "resource_subtype", "start_date" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_customization\_create\_budget Create a budget **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_customization\_create\_custom\_field Create a custom field **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "asana_created_field", "created_by", "created_by.name", "currency_code", "custom_label", "custom_label_position", "date_value", "date_value.date", "date_value.date_time", "default_access_level", "description", "display_value", "enabled", "enum_options", "enum_options.color", "enum_options.enabled", "enum_options.name", "enum_value", "enum_value.color", "enum_value.enabled", "enum_value.name", "format", "has_notifications_enabled", "id_prefix", "input_restrictions", "is_formula_field", "is_global_to_workspace", "is_value_read_only", "multi_enum_values", "multi_enum_values.color", "multi_enum_values.enabled", "multi_enum_values.name", "name", "number_value", "people_value", "people_value.name", "precision", "privacy_setting", "reference_value", "reference_value.name", "representation_type", "resource_subtype", "text_value", "type" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_customization\_create\_enum\_option\_for\_custom\_field Create an enum option **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `custom_field_gid` | string | Yes | — | Globally unique identifier for the custom field. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom_field_gid": { "type": "string", "description": "Globally unique identifier for the custom field." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "enabled", "name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "custom_field_gid" ] } ``` *** ## asana\_customization\_create\_rate Create a rate **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A generic Asana Resource, containing a globally unique identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_by", "created_by.name", "currency_code", "parent", "parent.name", "rate", "resource", "resource.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A generic Asana Resource, containing a globally unique identifier.", "properties": { "gid": { "type": "string", "description": "Globally unique identifier of the resource, as a string." }, "resource_type": { "type": "string", "description": "The base type of this resource." }, "parent": { "type": "string", "description": "Globally unique ID of the parent object: project." }, "resource": { "type": "string", "description": "Globally unique ID of the resource object: user or placeholder." }, "rate": { "type": "number", "description": "The monetary value of the rate." } }, "required": [ "parent", "resource", "rate" ] } }, "required": [ "PCID" ] } ``` *** ## asana\_customization\_create\_role Create a role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "base_role_type", "creation_time", "description", "is_standard_role", "modified_at", "name", "permissions", "permissions.allowed_guest_invites", "permissions.assign_roles", "permissions.create_and_edit_ai_automations", "permissions.create_app_authorization", "permissions.create_global_custom_fields", "permissions.create_pat_authorization", "permissions.create_team", "permissions.download_mobile_attachments", "permissions.export_project_data", "permissions.import_data", "permissions.manage_roles", "permissions.proactive_ai", "permissions.share_goal_with_domain", "permissions.share_portfolios_with_org", "permissions.standard_ai", "permissions.task_deletion_policy", "permissions.upload_attachments", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_customization\_delete\_allocation Delete an allocation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `allocation_gid` | string | Yes | — | Globally unique identifier for the allocation. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allocation_gid": { "type": "string", "description": "Globally unique identifier for the allocation." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "allocation_gid" ] } ``` *** ## asana\_customization\_delete\_budget Delete a budget **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `budget_gid` | string | Yes | — | Globally unique identifier for the budget. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "budget_gid": { "type": "string", "description": "Globally unique identifier for the budget." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "budget_gid" ] } ``` *** ## asana\_customization\_delete\_custom\_field Delete a custom field **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `custom_field_gid` | string | Yes | — | Globally unique identifier for the custom field. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom_field_gid": { "type": "string", "description": "Globally unique identifier for the custom field." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "custom_field_gid" ] } ``` *** ## asana\_customization\_delete\_rate Delete a rate **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rate_gid` | string | Yes | — | Globally unique identifier for the rate. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rate_gid": { "type": "string", "description": "Globally unique identifier for the rate." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "rate_gid" ] } ``` *** ## asana\_customization\_delete\_role Delete a role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `role_gid` | string | Yes | — | Globally unique identifier for the role. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "role_gid": { "type": "string", "description": "Globally unique identifier for the role." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "role_gid" ] } ``` *** ## asana\_customization\_get\_allocation Get an allocation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `allocation_gid` | string | Yes | — | Globally unique identifier for the allocation. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allocation_gid": { "type": "string", "description": "Globally unique identifier for the allocation." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "assignee", "assignee.name", "created_by", "created_by.name", "effort", "effort.type", "effort.value", "end_date", "parent", "parent.name", "resource_subtype", "start_date" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "allocation_gid" ] } ``` *** ## asana\_customization\_get\_allocations Get multiple allocations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `parent` | string | No | — | Globally unique identifier for the project to filter allocations by. | | `assignee` | string | No | — | Globally unique identifier for the user or placeholder the allocation is assigned to. | | `workspace` | string | No | — | Globally unique identifier for the workspace. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "parent": { "type": "string", "description": "Globally unique identifier for the project to filter allocations by." }, "assignee": { "type": "string", "description": "Globally unique identifier for the user or placeholder the allocation is assigned to." }, "workspace": { "type": "string", "description": "Globally unique identifier for the workspace." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "assignee", "assignee.name", "created_by", "created_by.name", "effort", "effort.type", "effort.value", "end_date", "offset", "parent", "parent.name", "path", "resource_subtype", "start_date", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_customization\_get\_budget Get a budget **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `budget_gid` | string | Yes | — | Globally unique identifier for the budget. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "budget_gid": { "type": "string", "description": "Globally unique identifier for the budget." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual", "actual.billable_status_filter", "actual.units", "actual.value", "budget_type", "estimate", "estimate.billable_status_filter", "estimate.enabled", "estimate.source", "estimate.units", "estimate.value", "parent", "parent.name", "total", "total.enabled", "total.units", "total.value" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "budget_gid" ] } ``` *** ## asana\_customization\_get\_budgets Get all budgets **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `parent` | string | Yes | — | Globally unique identifier for the budget's parent object. This currently can only be a `project`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "parent": { "type": "string", "description": "Globally unique identifier for the budget's parent object. This currently can only be a `project`." } }, "required": [ "PCID", "parent" ] } ``` *** ## asana\_customization\_get\_custom\_field Get a custom field **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `custom_field_gid` | string | Yes | — | Globally unique identifier for the custom field. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom_field_gid": { "type": "string", "description": "Globally unique identifier for the custom field." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "asana_created_field", "created_by", "created_by.name", "currency_code", "custom_label", "custom_label_position", "date_value", "date_value.date", "date_value.date_time", "default_access_level", "description", "display_value", "enabled", "enum_options", "enum_options.color", "enum_options.enabled", "enum_options.name", "enum_value", "enum_value.color", "enum_value.enabled", "enum_value.name", "format", "has_notifications_enabled", "id_prefix", "input_restrictions", "is_formula_field", "is_global_to_workspace", "is_value_read_only", "multi_enum_values", "multi_enum_values.color", "multi_enum_values.enabled", "multi_enum_values.name", "name", "number_value", "people_value", "people_value.name", "precision", "privacy_setting", "reference_value", "reference_value.name", "representation_type", "resource_subtype", "text_value", "type" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "custom_field_gid" ] } ``` *** ## asana\_customization\_get\_custom\_field\_settings\_for\_goal Get a goal's custom fields **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_field", "custom_field.asana_created_field", "custom_field.created_by", "custom_field.created_by.name", "custom_field.currency_code", "custom_field.custom_label", "custom_field.custom_label_position", "custom_field.date_value", "custom_field.date_value.date", "custom_field.date_value.date_time", "custom_field.default_access_level", "custom_field.description", "custom_field.display_value", "custom_field.enabled", "custom_field.enum_options", "custom_field.enum_options.color", "custom_field.enum_options.enabled", "custom_field.enum_options.name", "custom_field.enum_value", "custom_field.enum_value.color", "custom_field.enum_value.enabled", "custom_field.enum_value.name", "custom_field.format", "custom_field.has_notifications_enabled", "custom_field.id_prefix", "custom_field.input_restrictions", "custom_field.is_formula_field", "custom_field.is_global_to_workspace", "custom_field.is_value_read_only", "custom_field.multi_enum_values", "custom_field.multi_enum_values.color", "custom_field.multi_enum_values.enabled", "custom_field.multi_enum_values.name", "custom_field.name", "custom_field.number_value", "custom_field.people_value", "custom_field.people_value.name", "custom_field.precision", "custom_field.privacy_setting", "custom_field.reference_value", "custom_field.reference_value.name", "custom_field.representation_type", "custom_field.resource_subtype", "custom_field.text_value", "custom_field.type", "is_important", "offset", "parent", "parent.name", "path", "project", "project.name", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_customization\_get\_custom\_field\_settings\_for\_portfolio Get a portfolio's custom fields **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_field", "custom_field.asana_created_field", "custom_field.created_by", "custom_field.created_by.name", "custom_field.currency_code", "custom_field.custom_label", "custom_field.custom_label_position", "custom_field.date_value", "custom_field.date_value.date", "custom_field.date_value.date_time", "custom_field.default_access_level", "custom_field.description", "custom_field.display_value", "custom_field.enabled", "custom_field.enum_options", "custom_field.enum_options.color", "custom_field.enum_options.enabled", "custom_field.enum_options.name", "custom_field.enum_value", "custom_field.enum_value.color", "custom_field.enum_value.enabled", "custom_field.enum_value.name", "custom_field.format", "custom_field.has_notifications_enabled", "custom_field.id_prefix", "custom_field.input_restrictions", "custom_field.is_formula_field", "custom_field.is_global_to_workspace", "custom_field.is_value_read_only", "custom_field.multi_enum_values", "custom_field.multi_enum_values.color", "custom_field.multi_enum_values.enabled", "custom_field.multi_enum_values.name", "custom_field.name", "custom_field.number_value", "custom_field.people_value", "custom_field.people_value.name", "custom_field.precision", "custom_field.privacy_setting", "custom_field.reference_value", "custom_field.reference_value.name", "custom_field.representation_type", "custom_field.resource_subtype", "custom_field.text_value", "custom_field.type", "is_important", "offset", "parent", "parent.name", "path", "project", "project.name", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_customization\_get\_custom\_field\_settings\_for\_project Get a project's custom fields **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_field", "custom_field.asana_created_field", "custom_field.created_by", "custom_field.created_by.name", "custom_field.currency_code", "custom_field.custom_label", "custom_field.custom_label_position", "custom_field.date_value", "custom_field.date_value.date", "custom_field.date_value.date_time", "custom_field.default_access_level", "custom_field.description", "custom_field.display_value", "custom_field.enabled", "custom_field.enum_options", "custom_field.enum_options.color", "custom_field.enum_options.enabled", "custom_field.enum_options.name", "custom_field.enum_value", "custom_field.enum_value.color", "custom_field.enum_value.enabled", "custom_field.enum_value.name", "custom_field.format", "custom_field.has_notifications_enabled", "custom_field.id_prefix", "custom_field.input_restrictions", "custom_field.is_formula_field", "custom_field.is_global_to_workspace", "custom_field.is_value_read_only", "custom_field.multi_enum_values", "custom_field.multi_enum_values.color", "custom_field.multi_enum_values.enabled", "custom_field.multi_enum_values.name", "custom_field.name", "custom_field.number_value", "custom_field.people_value", "custom_field.people_value.name", "custom_field.precision", "custom_field.privacy_setting", "custom_field.reference_value", "custom_field.reference_value.name", "custom_field.representation_type", "custom_field.resource_subtype", "custom_field.text_value", "custom_field.type", "is_important", "offset", "parent", "parent.name", "path", "project", "project.name", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_customization\_get\_custom\_field\_settings\_for\_team Get a team's custom fields **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `team_gid` | string | Yes | — | Globally unique identifier for the team. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_gid": { "type": "string", "description": "Globally unique identifier for the team." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_field", "custom_field.asana_created_field", "custom_field.created_by", "custom_field.created_by.name", "custom_field.currency_code", "custom_field.custom_label", "custom_field.custom_label_position", "custom_field.date_value", "custom_field.date_value.date", "custom_field.date_value.date_time", "custom_field.default_access_level", "custom_field.description", "custom_field.display_value", "custom_field.enabled", "custom_field.enum_options", "custom_field.enum_options.color", "custom_field.enum_options.enabled", "custom_field.enum_options.name", "custom_field.enum_value", "custom_field.enum_value.color", "custom_field.enum_value.enabled", "custom_field.enum_value.name", "custom_field.format", "custom_field.has_notifications_enabled", "custom_field.id_prefix", "custom_field.input_restrictions", "custom_field.is_formula_field", "custom_field.is_global_to_workspace", "custom_field.is_value_read_only", "custom_field.multi_enum_values", "custom_field.multi_enum_values.color", "custom_field.multi_enum_values.enabled", "custom_field.multi_enum_values.name", "custom_field.name", "custom_field.number_value", "custom_field.people_value", "custom_field.people_value.name", "custom_field.precision", "custom_field.privacy_setting", "custom_field.reference_value", "custom_field.reference_value.name", "custom_field.representation_type", "custom_field.resource_subtype", "custom_field.text_value", "custom_field.type", "is_important", "parent", "parent.name", "project", "project.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "team_gid" ] } ``` *** ## asana\_customization\_get\_custom\_fields\_for\_workspace Get a workspace's custom fields **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "asana_created_field", "created_by", "created_by.name", "currency_code", "custom_label", "custom_label_position", "date_value", "date_value.date", "date_value.date_time", "default_access_level", "description", "display_value", "enabled", "enum_options", "enum_options.color", "enum_options.enabled", "enum_options.name", "enum_value", "enum_value.color", "enum_value.enabled", "enum_value.name", "format", "has_notifications_enabled", "id_prefix", "input_restrictions", "is_formula_field", "is_global_to_workspace", "is_value_read_only", "multi_enum_values", "multi_enum_values.color", "multi_enum_values.enabled", "multi_enum_values.name", "name", "number_value", "offset", "path", "people_value", "people_value.name", "precision", "privacy_setting", "reference_value", "reference_value.name", "representation_type", "resource_subtype", "text_value", "type", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_customization\_get\_custom\_type Get a custom type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `custom_type_gid` | string | Yes | — | Globally unique identifier for the custom type. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom_type_gid": { "type": "string", "description": "Globally unique identifier for the custom type." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "name", "status_options", "status_options.color", "status_options.completion_state", "status_options.enabled", "status_options.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "custom_type_gid" ] } ``` *** ## asana\_customization\_get\_custom\_types Get all custom types associated with an object **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project` | string | Yes | — | Globally unique identifier for the project, which is used as a filter when retrieving all custom types. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project": { "type": "string", "description": "Globally unique identifier for the project, which is used as a filter when retrieving all custom types." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "name", "offset", "path", "status_options", "status_options.color", "status_options.completion_state", "status_options.enabled", "status_options.name", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project" ] } ``` *** ## asana\_customization\_get\_rate Get a rate **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rate_gid` | string | Yes | — | Globally unique identifier for the rate. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rate_gid": { "type": "string", "description": "Globally unique identifier for the rate." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_by", "created_by.name", "currency_code", "parent", "parent.name", "rate", "resource", "resource.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "rate_gid" ] } ``` *** ## asana\_customization\_get\_rates Get multiple rates **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `parent` | string | No | — | Globally unique identifier for `project`. | | `resource` | string | No | — | Globally unique identifier for `user` or `placeholder`. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "parent": { "type": "string", "description": "Globally unique identifier for `project`." }, "resource": { "type": "string", "description": "Globally unique identifier for `user` or `placeholder`." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "offset", "path", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_customization\_get\_role Get a role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `role_gid` | string | Yes | — | Globally unique identifier for the role. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "role_gid": { "type": "string", "description": "Globally unique identifier for the role." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "base_role_type", "creation_time", "description", "is_standard_role", "modified_at", "name", "permissions", "permissions.allowed_guest_invites", "permissions.assign_roles", "permissions.create_and_edit_ai_automations", "permissions.create_app_authorization", "permissions.create_global_custom_fields", "permissions.create_pat_authorization", "permissions.create_team", "permissions.download_mobile_attachments", "permissions.export_project_data", "permissions.import_data", "permissions.manage_roles", "permissions.proactive_ai", "permissions.share_goal_with_domain", "permissions.share_portfolios_with_org", "permissions.standard_ai", "permissions.task_deletion_policy", "permissions.upload_attachments", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "role_gid" ] } ``` *** ## asana\_customization\_get\_roles Get multiple roles **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `workspace` | string | No | — | The workspace or organization to filter roles on. | | `archived` | boolean | No | — | Only return projects whose `archived` field takes on the value of this parameter. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "workspace": { "type": "string", "description": "The workspace or organization to filter roles on." }, "archived": { "type": "boolean", "description": "Only return projects whose `archived` field takes on the value of this parameter." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "base_role_type", "creation_time", "description", "is_standard_role", "modified_at", "name", "offset", "path", "permissions", "permissions.allowed_guest_invites", "permissions.assign_roles", "permissions.create_and_edit_ai_automations", "permissions.create_app_authorization", "permissions.create_global_custom_fields", "permissions.create_pat_authorization", "permissions.create_team", "permissions.download_mobile_attachments", "permissions.export_project_data", "permissions.import_data", "permissions.manage_roles", "permissions.proactive_ai", "permissions.share_goal_with_domain", "permissions.share_portfolios_with_org", "permissions.standard_ai", "permissions.task_deletion_policy", "permissions.upload_attachments", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_customization\_insert\_enum\_option\_for\_custom\_field Reorder a custom field's enum **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `custom_field_gid` | string | Yes | — | Globally unique identifier for the custom field. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom_field_gid": { "type": "string", "description": "Globally unique identifier for the custom field." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "enabled", "name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "enum_option": { "type": "string", "description": "The gid of the enum option to relocate." }, "before_enum_option": { "type": "string", "description": "An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option." }, "after_enum_option": { "type": "string", "description": "An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option." } }, "required": [ "enum_option" ] } }, "required": [ "PCID", "custom_field_gid" ] } ``` *** ## asana\_customization\_update\_allocation Update an allocation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `allocation_gid` | string | Yes | — | Globally unique identifier for the allocation. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allocation_gid": { "type": "string", "description": "Globally unique identifier for the allocation." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "assignee", "assignee.name", "created_by", "created_by.name", "effort", "effort.type", "effort.value", "end_date", "parent", "parent.name", "resource_subtype", "start_date" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "allocation_gid" ] } ``` *** ## asana\_customization\_update\_budget Update a budget **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `budget_gid` | string | Yes | — | Globally unique identifier for the budget. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "budget_gid": { "type": "string", "description": "Globally unique identifier for the budget." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual", "actual.billable_status_filter", "actual.units", "actual.value", "budget_type", "estimate", "estimate.billable_status_filter", "estimate.enabled", "estimate.source", "estimate.units", "estimate.value", "parent", "parent.name", "total", "total.enabled", "total.units", "total.value" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "budget_gid" ] } ``` *** ## asana\_customization\_update\_custom\_field Update a custom field **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `custom_field_gid` | string | Yes | — | Globally unique identifier for the custom field. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom_field_gid": { "type": "string", "description": "Globally unique identifier for the custom field." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "asana_created_field", "created_by", "created_by.name", "currency_code", "custom_label", "custom_label_position", "date_value", "date_value.date", "date_value.date_time", "default_access_level", "description", "display_value", "enabled", "enum_options", "enum_options.color", "enum_options.enabled", "enum_options.name", "enum_value", "enum_value.color", "enum_value.enabled", "enum_value.name", "format", "has_notifications_enabled", "id_prefix", "input_restrictions", "is_formula_field", "is_global_to_workspace", "is_value_read_only", "multi_enum_values", "multi_enum_values.color", "multi_enum_values.enabled", "multi_enum_values.name", "name", "number_value", "people_value", "people_value.name", "precision", "privacy_setting", "reference_value", "reference_value.name", "representation_type", "resource_subtype", "text_value", "type" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "custom_field_gid" ] } ``` *** ## asana\_customization\_update\_enum\_option Update an enum option **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `enum_option_gid` | string | Yes | — | Globally unique identifier for the enum option. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | Enum options are the possible values which an enum custom field can adopt. An enum custom field must contain at least 1 enum option but no more than 500. You can add enum options to a custom field by using the `POST /custom_fields/custom_field_gid/enum_options` endpoint. **It is not possible to remove or delete an enum option**. Instead, enum options can be disabled by updating the `enabled` field to false with the `PUT /enum_options/enum_option_gid` endpoint. Other attributes can be updated similarly. On creation of an enum option, `enabled` is always set to `true`, meaning the enum option is a selectable value for the custom field. Setting `enabled=false` is equivalent to “trashing” the enum option in the Asana web app within the “Edit Fields” dialog. The enum option will no longer be selectable but, if the enum option value was previously set within a task, the task will retain the value. Enum options are an ordered list and by default new enum options are inserted at the end. Ordering in relation to existing enum options can be specified on creation by using `insert_before` or `insert_after` to reference an existing enum option. Only one of `insert_before` and `insert_after` can be provided when creating a new enum option. An enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` endpoint. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "enum_option_gid": { "type": "string", "description": "Globally unique identifier for the enum option." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "enabled", "name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "Enum options are the possible values which an enum custom field can adopt. An enum custom field must contain at least 1 enum option but no more than 500. You can add enum options to a custom field by using the `POST /custom_fields/custom_field_gid/enum_options` endpoint. **It is not possible to remove or delete an enum option**. Instead, enum options can be disabled by updating the `enabled` field to false with the `PUT /enum_options/enum_option_gid` endpoint. Other attributes can be updated similarly. On creation of an enum option, `enabled` is always set to `true`, meaning the enum option is a selectable value for the custom field. Setting `enabled=false` is equivalent to “trashing” the enum option in the Asana web app within the “Edit Fields” dialog. The enum option will no longer be selectable but, if the enum option value was previously set within a task, the task will retain the value. Enum options are an ordered list and by default new enum options are inserted at the end. Ordering in relation to existing enum options can be specified on creation by using `insert_before` or `insert_after` to reference an existing enum option. Only one of `insert_before` and `insert_after` can be provided when creating a new enum option. An enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` endpoint.", "properties": { "gid": { "type": "string", "description": "Globally unique identifier of the resource, as a string." }, "resource_type": { "type": "string", "description": "The base type of this resource." }, "name": { "type": "string", "description": "The name of the enum option." }, "enabled": { "type": "boolean", "description": "Whether or not the enum option is a selectable value for the custom field." }, "color": { "type": "string", "description": "The color of the enum option. Defaults to `none`." } } } }, "required": [ "PCID", "enum_option_gid" ] } ``` *** ## asana\_customization\_update\_rate Update a rate **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rate_gid` | string | Yes | — | Globally unique identifier for the rate. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A generic Asana Resource, containing a globally unique identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rate_gid": { "type": "string", "description": "Globally unique identifier for the rate." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_by", "created_by.name", "currency_code", "parent", "parent.name", "rate", "resource", "resource.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A generic Asana Resource, containing a globally unique identifier.", "properties": { "gid": { "type": "string", "description": "Globally unique identifier of the resource, as a string." }, "resource_type": { "type": "string", "description": "The base type of this resource." }, "rate": { "type": "number", "description": "The monetary value of the rate." } } } }, "required": [ "PCID", "rate_gid" ] } ``` *** ## asana\_customization\_update\_role Update a role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `role_gid` | string | Yes | — | Globally unique identifier for the role. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "role_gid": { "type": "string", "description": "Globally unique identifier for the role." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "base_role_type", "creation_time", "description", "is_standard_role", "modified_at", "name", "permissions", "permissions.allowed_guest_invites", "permissions.assign_roles", "permissions.create_and_edit_ai_automations", "permissions.create_app_authorization", "permissions.create_global_custom_fields", "permissions.create_pat_authorization", "permissions.create_team", "permissions.download_mobile_attachments", "permissions.export_project_data", "permissions.import_data", "permissions.manage_roles", "permissions.proactive_ai", "permissions.share_goal_with_domain", "permissions.share_portfolios_with_org", "permissions.standard_ai", "permissions.task_deletion_policy", "permissions.upload_attachments", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "role_gid" ] } ``` # asana-goals Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/asana-api/asana-goals Asana Goals — create, update, and track goals, metrics, and goal relationships **Server path:** `/asana-goals` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`asana_goals_add_custom_field_setting_for_goal`](#asana_goals_add_custom_field_setting_for_goal) | Add a custom field to a goal | | [`asana_goals_add_followers`](#asana_goals_add_followers) | Add a collaborator to a goal | | [`asana_goals_add_supporting_relationship`](#asana_goals_add_supporting_relationship) | Add a supporting goal relationship | | [`asana_goals_create_goal`](#asana_goals_create_goal) | Create a goal | | [`asana_goals_create_goal_metric`](#asana_goals_create_goal_metric) | Create a goal metric | | [`asana_goals_delete_goal`](#asana_goals_delete_goal) | Delete a goal | | [`asana_goals_get_goal`](#asana_goals_get_goal) | Get a goal | | [`asana_goals_get_goal_relationship`](#asana_goals_get_goal_relationship) | Get a goal relationship | | [`asana_goals_get_goal_relationships`](#asana_goals_get_goal_relationships) | Get goal relationships | | [`asana_goals_get_goals`](#asana_goals_get_goals) | Get goals | | [`asana_goals_get_parent_goals_for_goal`](#asana_goals_get_parent_goals_for_goal) | Get parent goals from a goal | | [`asana_goals_remove_custom_field_setting_for_goal`](#asana_goals_remove_custom_field_setting_for_goal) | Remove a custom field from a goal | | [`asana_goals_remove_followers`](#asana_goals_remove_followers) | Remove a collaborator from a goal | | [`asana_goals_remove_supporting_relationship`](#asana_goals_remove_supporting_relationship) | Removes a supporting goal relationship | | [`asana_goals_update_goal`](#asana_goals_update_goal) | Update a goal | | [`asana_goals_update_goal_metric`](#asana_goals_update_goal_metric) | Update a goal metric | | [`asana_goals_update_goal_relationship`](#asana_goals_update_goal_relationship) | Update a goal relationship | *** ## asana\_goals\_add\_custom\_field\_setting\_for\_goal Add a custom field to a goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "custom_field": { "description": "Custom Field" }, "is_important": { "type": "boolean", "description": "Whether this field should be considered important to this container (for instance, to display in the list view of items in the container)." }, "insert_before": { "type": "string", "description": "A gid of a Custom Field Setting on this container, before which the new Custom Field Setting will be added. `insert_before` and `insert_after` parameters cannot both be specified." }, "insert_after": { "type": "string", "description": "A gid of a Custom Field Setting on this container, after which the new Custom Field Setting will be added. `insert_before` and `insert_after` parameters cannot both be specified." } }, "required": [ "custom_field" ] } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_add\_followers Add a collaborator to a goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "due_on", "followers", "followers.name", "html_notes", "is_workspace_level", "liked", "likes", "likes.user", "likes.user.name", "metric", "metric.can_manage", "metric.currency_code", "metric.current_display_value", "metric.current_number_value", "metric.initial_number_value", "metric.is_custom_weight", "metric.precision", "metric.progress_source", "metric.resource_subtype", "metric.target_number_value", "metric.unit", "name", "notes", "num_likes", "owner", "owner.name", "start_on", "status", "team", "team.name", "time_period", "time_period.display_name", "time_period.end_on", "time_period.period", "time_period.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "followers": { "type": "array", "items": { "type": "string" }, "description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user." } }, "required": [ "followers" ] } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_add\_supporting\_relationship Add a supporting goal relationship **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "contribution_weight", "resource_subtype", "supported_goal", "supported_goal.name", "supported_goal.owner", "supported_goal.owner.name", "supporting_resource", "supporting_resource.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "supporting_resource": { "type": "string", "description": "The gid of the supporting resource to add to the parent goal. Must be the gid of a goal, project, task, or portfolio." }, "insert_before": { "type": "string", "description": "An id of a subgoal of this parent goal. The new subgoal will be added before the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. Currently only supported when adding a subgoal." }, "insert_after": { "type": "string", "description": "An id of a subgoal of this parent goal. The new subgoal will be added after the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. Currently only supported when adding a subgoal." }, "contribution_weight": { "type": "number", "description": "Defines how much the supporting goal’s progress contributes to the parent goal’s overall progress. When used with automatically calculated [Goal Metrics](/reference/creategoalmetric) (such as `progress_source = subgoal_progress`), this value must be greater than 0 for the subgoal to count toward the parent goal’s progress. Accepts a number between 0 and 1 (inclusive). Defaults to `0`." } }, "required": [ "supporting_resource" ] } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_create\_goal Create a goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "due_on", "followers", "followers.name", "html_notes", "is_workspace_level", "liked", "likes", "likes.user", "likes.user.name", "metric", "metric.can_manage", "metric.currency_code", "metric.current_display_value", "metric.current_number_value", "metric.initial_number_value", "metric.is_custom_weight", "metric.precision", "metric.progress_source", "metric.resource_subtype", "metric.target_number_value", "metric.unit", "name", "notes", "num_likes", "owner", "owner.name", "start_on", "status", "team", "team.name", "time_period", "time_period.display_name", "time_period.end_on", "time_period.period", "time_period.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_goals\_create\_goal\_metric Create a goal metric **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A generic Asana Resource, containing a globally unique identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "due_on", "followers", "followers.name", "html_notes", "is_workspace_level", "liked", "likes", "likes.user", "likes.user.name", "metric", "metric.can_manage", "metric.currency_code", "metric.current_display_value", "metric.current_number_value", "metric.initial_number_value", "metric.is_custom_weight", "metric.precision", "metric.progress_source", "metric.resource_subtype", "metric.target_number_value", "metric.unit", "name", "notes", "num_likes", "owner", "owner.name", "start_on", "status", "team", "team.name", "time_period", "time_period.display_name", "time_period.end_on", "time_period.period", "time_period.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A generic Asana Resource, containing a globally unique identifier.", "properties": { "gid": { "type": "string", "description": "Globally unique identifier of the resource, as a string." }, "resource_type": { "type": "string", "description": "The base type of this resource." }, "resource_subtype": { "type": "string", "description": "The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.", "enum": [ "number" ] }, "precision": { "type": "integer", "description": "*Conditional*. Only relevant for goal metrics of type `Number`. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive. For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%." }, "unit": { "type": "string", "description": "A supported unit of measure for the goal metric, or none.", "enum": [ "none", "currency", "percentage" ] }, "currency_code": { "type": "string", "description": "ISO 4217 currency code to format this custom field. This will be null if the `unit` is not `currency`." }, "initial_number_value": { "type": "number", "description": "This number is the start value of a goal metric of type number." }, "target_number_value": { "type": "number", "description": "This number is the end value of a goal metric of type number. This number cannot equal `initial_number_value`." }, "current_number_value": { "type": "number", "description": "This number is the current value of a goal metric of type number." }, "current_display_value": { "type": "string", "description": "This string is the current value of a goal metric of type string." }, "progress_source": { "type": "string", "description": "This field defines how the progress value of a goal metric is being calculated. A goal's progress can be provided manually by the user, calculated automatically from contributing subgoals, projects, or tasks, or managed by an integration with an external data source, such as Salesforce.", "enum": [ "manual", "subgoal_progress", "project_task_completion", "project_milestone_completion", "task_completion", "external" ] }, "is_custom_weight": { "type": "boolean", "description": "*Conditional*. Only relevant if `metric.progress_source` is one of `subgoal_progress`, `project_task_completion`, `project_milestone_completion`, or `task_completion`. If true, we use the supporting object's custom weight to calculate the goal's progress. If false, we treat all supporting objects as equally weighted" } } } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_delete\_goal Delete a goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_get\_goal Get a goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "due_on", "followers", "followers.name", "html_notes", "is_workspace_level", "liked", "likes", "likes.user", "likes.user.name", "metric", "metric.can_manage", "metric.currency_code", "metric.current_display_value", "metric.current_number_value", "metric.initial_number_value", "metric.is_custom_weight", "metric.precision", "metric.progress_source", "metric.resource_subtype", "metric.target_number_value", "metric.unit", "name", "notes", "num_likes", "owner", "owner.name", "start_on", "status", "team", "team.name", "time_period", "time_period.display_name", "time_period.end_on", "time_period.period", "time_period.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_get\_goal\_relationship Get a goal relationship **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_relationship_gid` | string | Yes | — | Globally unique identifier for the goal relationship. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_relationship_gid": { "type": "string", "description": "Globally unique identifier for the goal relationship." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "contribution_weight", "resource_subtype", "supported_goal", "supported_goal.name", "supported_goal.owner", "supported_goal.owner.name", "supporting_resource", "supporting_resource.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "goal_relationship_gid" ] } ``` *** ## asana\_goals\_get\_goal\_relationships Get goal relationships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `supported_goal` | string | Yes | — | Globally unique identifier for the supported goal in the goal relationship. | | `resource_subtype` | string | No | — | If provided, filter to goal relationships with a given resource\_subtype. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "supported_goal": { "type": "string", "description": "Globally unique identifier for the supported goal in the goal relationship." }, "resource_subtype": { "type": "string", "description": "If provided, filter to goal relationships with a given resource_subtype." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "contribution_weight", "offset", "path", "resource_subtype", "supported_goal", "supported_goal.name", "supported_goal.owner", "supported_goal.owner.name", "supporting_resource", "supporting_resource.name", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "supported_goal" ] } ``` *** ## asana\_goals\_get\_goals Get goals **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `portfolio` | string | No | — | Globally unique identifier for supporting portfolio. | | `project` | string | No | — | Globally unique identifier for supporting project. | | `task` | string | No | — | Globally unique identifier for supporting task. | | `is_workspace_level` | boolean | No | — | Filter to goals with is\_workspace\_level set to query value. Must be used with the workspace parameter. | | `team` | string | No | — | Globally unique identifier for the team. | | `workspace` | string | No | — | Globally unique identifier for the workspace. | | `time_periods` | string\[] | No | — | Globally unique identifiers for the time periods. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "portfolio": { "type": "string", "description": "Globally unique identifier for supporting portfolio." }, "project": { "type": "string", "description": "Globally unique identifier for supporting project." }, "task": { "type": "string", "description": "Globally unique identifier for supporting task." }, "is_workspace_level": { "type": "boolean", "description": "Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter." }, "team": { "type": "string", "description": "Globally unique identifier for the team." }, "workspace": { "type": "string", "description": "Globally unique identifier for the workspace." }, "time_periods": { "type": "array", "items": { "type": "string" }, "description": "Globally unique identifiers for the time periods." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "due_on", "followers", "followers.name", "html_notes", "is_workspace_level", "liked", "likes", "likes.user", "likes.user.name", "metric", "metric.can_manage", "metric.currency_code", "metric.current_display_value", "metric.current_number_value", "metric.initial_number_value", "metric.is_custom_weight", "metric.precision", "metric.progress_source", "metric.resource_subtype", "metric.target_number_value", "metric.unit", "name", "notes", "num_likes", "offset", "owner", "owner.name", "path", "start_on", "status", "team", "team.name", "time_period", "time_period.display_name", "time_period.end_on", "time_period.period", "time_period.start_on", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_goals\_get\_parent\_goals\_for\_goal Get parent goals from a goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "due_on", "followers", "followers.name", "html_notes", "is_workspace_level", "liked", "likes", "likes.user", "likes.user.name", "metric", "metric.can_manage", "metric.currency_code", "metric.current_display_value", "metric.current_number_value", "metric.initial_number_value", "metric.is_custom_weight", "metric.precision", "metric.progress_source", "metric.resource_subtype", "metric.target_number_value", "metric.unit", "name", "notes", "num_likes", "owner", "owner.name", "start_on", "status", "team", "team.name", "time_period", "time_period.display_name", "time_period.end_on", "time_period.period", "time_period.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_remove\_custom\_field\_setting\_for\_goal Remove a custom field from a goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "custom_field": { "type": "string", "description": "The custom field to remove from this portfolio." } }, "required": [ "custom_field" ] } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_remove\_followers Remove a collaborator from a goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "due_on", "followers", "followers.name", "html_notes", "is_workspace_level", "liked", "likes", "likes.user", "likes.user.name", "metric", "metric.can_manage", "metric.currency_code", "metric.current_display_value", "metric.current_number_value", "metric.initial_number_value", "metric.is_custom_weight", "metric.precision", "metric.progress_source", "metric.resource_subtype", "metric.target_number_value", "metric.unit", "name", "notes", "num_likes", "owner", "owner.name", "start_on", "status", "team", "team.name", "time_period", "time_period.display_name", "time_period.end_on", "time_period.period", "time_period.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "followers": { "type": "array", "items": { "type": "string" }, "description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user." } }, "required": [ "followers" ] } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_remove\_supporting\_relationship Removes a supporting goal relationship **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "supporting_resource": { "type": "string", "description": "The gid of the supporting resource to remove from the parent goal. Must be the gid of a goal, project, task, or portfolio." } }, "required": [ "supporting_resource" ] } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_update\_goal Update a goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "due_on", "followers", "followers.name", "html_notes", "is_workspace_level", "liked", "likes", "likes.user", "likes.user.name", "metric", "metric.can_manage", "metric.currency_code", "metric.current_display_value", "metric.current_number_value", "metric.initial_number_value", "metric.is_custom_weight", "metric.precision", "metric.progress_source", "metric.resource_subtype", "metric.target_number_value", "metric.unit", "name", "notes", "num_likes", "owner", "owner.name", "start_on", "status", "team", "team.name", "time_period", "time_period.display_name", "time_period.end_on", "time_period.period", "time_period.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_update\_goal\_metric Update a goal metric **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_gid` | string | Yes | — | Globally unique identifier for the goal. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A generic Asana Resource, containing a globally unique identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_gid": { "type": "string", "description": "Globally unique identifier for the goal." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "due_on", "followers", "followers.name", "html_notes", "is_workspace_level", "liked", "likes", "likes.user", "likes.user.name", "metric", "metric.can_manage", "metric.currency_code", "metric.current_display_value", "metric.current_number_value", "metric.initial_number_value", "metric.is_custom_weight", "metric.precision", "metric.progress_source", "metric.resource_subtype", "metric.target_number_value", "metric.unit", "name", "notes", "num_likes", "owner", "owner.name", "start_on", "status", "team", "team.name", "time_period", "time_period.display_name", "time_period.end_on", "time_period.period", "time_period.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A generic Asana Resource, containing a globally unique identifier.", "properties": { "gid": { "type": "string", "description": "Globally unique identifier of the resource, as a string." }, "resource_type": { "type": "string", "description": "The base type of this resource." }, "current_number_value": { "type": "number", "description": "*Conditional*. This number is the current value of a goal metric of type number." } } } }, "required": [ "PCID", "goal_gid" ] } ``` *** ## asana\_goals\_update\_goal\_relationship Update a goal relationship **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `goal_relationship_gid` | string | Yes | — | Globally unique identifier for the goal relationship. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "goal_relationship_gid": { "type": "string", "description": "Globally unique identifier for the goal relationship." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "contribution_weight", "resource_subtype", "supported_goal", "supported_goal.name", "supported_goal.owner", "supported_goal.owner.name", "supporting_resource", "supporting_resource.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "goal_relationship_gid" ] } ``` # asana-portfolios Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/asana-api/asana-portfolios Asana Portfolios — create, update, and manage portfolios, portfolio items, and memberships **Server path:** `/asana-portfolios` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`asana_portfolios_add_custom_field_setting_for_portfolio`](#asana_portfolios_add_custom_field_setting_for_portfolio) | Add a custom field to a portfolio | | [`asana_portfolios_add_item_for_portfolio`](#asana_portfolios_add_item_for_portfolio) | Add a portfolio item | | [`asana_portfolios_add_members_for_portfolio`](#asana_portfolios_add_members_for_portfolio) | Add users to a portfolio | | [`asana_portfolios_create_portfolio`](#asana_portfolios_create_portfolio) | Create a portfolio | | [`asana_portfolios_delete_portfolio`](#asana_portfolios_delete_portfolio) | Delete a portfolio | | [`asana_portfolios_duplicate_portfolio`](#asana_portfolios_duplicate_portfolio) | Duplicate a portfolio | | [`asana_portfolios_get_items_for_portfolio`](#asana_portfolios_get_items_for_portfolio) | Get portfolio items | | [`asana_portfolios_get_portfolio`](#asana_portfolios_get_portfolio) | Get a portfolio | | [`asana_portfolios_get_portfolio_membership`](#asana_portfolios_get_portfolio_membership) | Get a portfolio membership | | [`asana_portfolios_get_portfolio_memberships`](#asana_portfolios_get_portfolio_memberships) | Get multiple portfolio memberships | | [`asana_portfolios_get_portfolio_memberships_for_portfolio`](#asana_portfolios_get_portfolio_memberships_for_portfolio) | Get memberships from a portfolio | | [`asana_portfolios_get_portfolios`](#asana_portfolios_get_portfolios) | Get multiple portfolios | | [`asana_portfolios_remove_custom_field_setting_for_portfolio`](#asana_portfolios_remove_custom_field_setting_for_portfolio) | Remove a custom field from a portfolio | | [`asana_portfolios_remove_item_for_portfolio`](#asana_portfolios_remove_item_for_portfolio) | Remove a portfolio item | | [`asana_portfolios_remove_members_for_portfolio`](#asana_portfolios_remove_members_for_portfolio) | Remove users from a portfolio | | [`asana_portfolios_update_portfolio`](#asana_portfolios_update_portfolio) | Update a portfolio | *** ## asana\_portfolios\_add\_custom\_field\_setting\_for\_portfolio Add a custom field to a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "custom_field": { "description": "Custom Field" }, "is_important": { "type": "boolean", "description": "Whether this field should be considered important to this container (for instance, to display in the list view of items in the container)." }, "insert_before": { "type": "string", "description": "A gid of a Custom Field Setting on this container, before which the new Custom Field Setting will be added. `insert_before` and `insert_after` parameters cannot both be specified." }, "insert_after": { "type": "string", "description": "A gid of a Custom Field Setting on this container, after which the new Custom Field Setting will be added. `insert_before` and `insert_after` parameters cannot both be specified." } }, "required": [ "custom_field" ] } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_add\_item\_for\_portfolio Add a portfolio item **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "item": { "type": "string", "description": "The item to add to the portfolio." }, "insert_before": { "type": "string", "description": "An id of an item in this portfolio. The new item will be added before the one specified here. `insert_before` and `insert_after` parameters cannot both be specified." }, "insert_after": { "type": "string", "description": "An id of an item in this portfolio. The new item will be added after the one specified here. `insert_before` and `insert_after` parameters cannot both be specified." } }, "required": [ "item" ] } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_add\_members\_for\_portfolio Add users to a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "created_at", "created_by", "created_by.name", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "due_on", "members", "members.name", "name", "owner", "owner.name", "permalink_url", "privacy_setting", "project_templates", "project_templates.name", "public", "start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "members": { "type": "string", "description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user." } }, "required": [ "members" ] } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_create\_portfolio Create a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "created_at", "created_by", "created_by.name", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "due_on", "members", "members.name", "name", "owner", "owner.name", "permalink_url", "privacy_setting", "project_templates", "project_templates.name", "public", "start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_portfolios\_delete\_portfolio Delete a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_duplicate\_portfolio Duplicate a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "new_graph_export", "new_graph_export.completed_at", "new_graph_export.created_at", "new_graph_export.download_url", "new_portfolio", "new_portfolio.name", "new_project", "new_project.name", "new_project_template", "new_project_template.name", "new_resource_export", "new_resource_export.completed_at", "new_resource_export.created_at", "new_resource_export.download_url", "new_task", "new_task.created_by", "new_task.name", "new_task.resource_subtype", "resource_subtype", "status" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "name": { "type": "string", "description": "The name of the new portfolio." }, "include": { "type": "string", "description": "A comma-separated list of elements to include when duplicating a portfolio. **Auto-included fields (non-configurable)** - Custom field settings - Views (tabs) **Optional fields (configurable)** - description - members - permissions - templates - rules - child_projects - child_portfolios" } }, "required": [ "name" ] } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_get\_items\_for\_portfolio Get portfolio items **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "offset", "owner", "path", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_get\_portfolio Get a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "created_at", "created_by", "created_by.name", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "due_on", "members", "members.name", "name", "owner", "owner.name", "permalink_url", "privacy_setting", "project_templates", "project_templates.name", "public", "start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_get\_portfolio\_membership Get a portfolio membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_membership_gid` | string | Yes | — | Portfolio Membership Gid | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_membership_gid": { "type": "string", "description": "Portfolio Membership Gid" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "access_level", "portfolio", "portfolio.name", "user", "user.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "portfolio_membership_gid" ] } ``` *** ## asana\_portfolios\_get\_portfolio\_memberships Get multiple portfolio memberships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio` | string | No | — | The portfolio to filter results on. | | `workspace` | string | No | — | The workspace to filter results on. | | `user` | string | No | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio": { "type": "string", "description": "The portfolio to filter results on." }, "workspace": { "type": "string", "description": "The workspace to filter results on." }, "user": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "access_level", "offset", "path", "portfolio", "portfolio.name", "uri", "user", "user.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_portfolios\_get\_portfolio\_memberships\_for\_portfolio Get memberships from a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `user` | string | No | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "user": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "access_level", "offset", "path", "portfolio", "portfolio.name", "uri", "user", "user.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_get\_portfolios Get multiple portfolios **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `workspace` | string | Yes | — | The workspace or organization to filter portfolios on. | | `owner` | string | No | — | The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own, unless the request is made from a Service Account. In the case of a Service Account, if this parameter is specified, then all portfolios owned by this parameter are returned. Otherwise, all portfolios across the workspace are returned. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "workspace": { "type": "string", "description": "The workspace or organization to filter portfolios on." }, "owner": { "type": "string", "description": "The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own, unless the request is made from a Service Account. In the case of a Service Account, if this parameter is specified, then all portfolios owned by this parameter are returned. Otherwise, all portfolios across the workspace are returned." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "created_at", "created_by", "created_by.name", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "due_on", "members", "members.name", "name", "offset", "owner", "owner.name", "path", "permalink_url", "privacy_setting", "project_templates", "project_templates.name", "public", "start_on", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace" ] } ``` *** ## asana\_portfolios\_remove\_custom\_field\_setting\_for\_portfolio Remove a custom field from a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "custom_field": { "type": "string", "description": "The custom field to remove from this portfolio." } }, "required": [ "custom_field" ] } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_remove\_item\_for\_portfolio Remove a portfolio item **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "item": { "type": "string", "description": "The item to remove from the portfolio." } }, "required": [ "item" ] } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_remove\_members\_for\_portfolio Remove users from a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "created_at", "created_by", "created_by.name", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "due_on", "members", "members.name", "name", "owner", "owner.name", "permalink_url", "privacy_setting", "project_templates", "project_templates.name", "public", "start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "members": { "type": "string", "description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user." } }, "required": [ "members" ] } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_portfolios\_update\_portfolio Update a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "created_at", "created_by", "created_by.name", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "due_on", "members", "members.name", "name", "owner", "owner.name", "permalink_url", "privacy_setting", "project_templates", "project_templates.name", "public", "start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "portfolio_gid" ] } ``` # asana-projects Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/asana-api/asana-projects Asana Projects — create, update, and manage projects, briefs, statuses, templates, and project memberships **Server path:** `/asana-projects` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`asana_projects_add_custom_field_setting_for_project`](#asana_projects_add_custom_field_setting_for_project) | Add a custom field to a project | | [`asana_projects_add_followers_for_project`](#asana_projects_add_followers_for_project) | Add followers to a project | | [`asana_projects_add_members_for_project`](#asana_projects_add_members_for_project) | Add users to a project | | [`asana_projects_create_project`](#asana_projects_create_project) | Create a project | | [`asana_projects_create_project_brief`](#asana_projects_create_project_brief) | Create a project brief | | [`asana_projects_create_project_for_team`](#asana_projects_create_project_for_team) | Create a project in a team | | [`asana_projects_create_project_for_workspace`](#asana_projects_create_project_for_workspace) | Create a project in a workspace | | [`asana_projects_create_project_status_for_project`](#asana_projects_create_project_status_for_project) | Create a project status | | [`asana_projects_delete_project`](#asana_projects_delete_project) | Delete a project | | [`asana_projects_delete_project_brief`](#asana_projects_delete_project_brief) | Delete a project brief | | [`asana_projects_delete_project_status`](#asana_projects_delete_project_status) | Delete a project status | | [`asana_projects_delete_project_template`](#asana_projects_delete_project_template) | Delete a project template | | [`asana_projects_duplicate_project`](#asana_projects_duplicate_project) | Duplicate a project | | [`asana_projects_get_for_task`](#asana_projects_get_for_task) | Get projects a task is in | | [`asana_projects_get_for_workspace`](#asana_projects_get_for_workspace) | Get all projects in a workspace | | [`asana_projects_get_project`](#asana_projects_get_project) | Get a project | | [`asana_projects_get_project_brief`](#asana_projects_get_project_brief) | Get a project brief | | [`asana_projects_get_project_membership`](#asana_projects_get_project_membership) | Get a project membership | | [`asana_projects_get_project_memberships_for_project`](#asana_projects_get_project_memberships_for_project) | Get memberships from a project | | [`asana_projects_get_project_portfolio_setting`](#asana_projects_get_project_portfolio_setting) | Get a project portfolio setting | | [`asana_projects_get_project_portfolio_settings_for_portfolio`](#asana_projects_get_project_portfolio_settings_for_portfolio) | Get project portfolio settings for a portfolio | | [`asana_projects_get_project_portfolio_settings_for_project`](#asana_projects_get_project_portfolio_settings_for_project) | Get project portfolio settings for a project | | [`asana_projects_get_project_status`](#asana_projects_get_project_status) | Get a project status | | [`asana_projects_get_project_statuses_for_project`](#asana_projects_get_project_statuses_for_project) | Get statuses from a project | | [`asana_projects_get_project_template`](#asana_projects_get_project_template) | Get a project template | | [`asana_projects_get_project_templates`](#asana_projects_get_project_templates) | Get multiple project templates | | [`asana_projects_get_project_templates_for_team`](#asana_projects_get_project_templates_for_team) | Get a team's project templates | | [`asana_projects_get_projects`](#asana_projects_get_projects) | Get multiple projects | | [`asana_projects_get_task_counts_for_project`](#asana_projects_get_task_counts_for_project) | Get task count of a project | | [`asana_projects_instantiate_project`](#asana_projects_instantiate_project) | Instantiate a project from a project template | | [`asana_projects_project_save_as_template`](#asana_projects_project_save_as_template) | Create a project template from a project | | [`asana_projects_remove_custom_field_setting_for_project`](#asana_projects_remove_custom_field_setting_for_project) | Remove a custom field from a project | | [`asana_projects_remove_followers_for_project`](#asana_projects_remove_followers_for_project) | Remove followers from a project | | [`asana_projects_remove_members_for_project`](#asana_projects_remove_members_for_project) | Remove users from a project | | [`asana_projects_search_projects_for_workspace`](#asana_projects_search_projects_for_workspace) | Search projects in a workspace | | [`asana_projects_update_project`](#asana_projects_update_project) | Update a project | | [`asana_projects_update_project_brief`](#asana_projects_update_project_brief) | Update a project brief | | [`asana_projects_update_project_portfolio_setting`](#asana_projects_update_project_portfolio_setting) | Update a project portfolio setting | *** ## asana\_projects\_add\_custom\_field\_setting\_for\_project Add a custom field to a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_field", "custom_field.asana_created_field", "custom_field.created_by", "custom_field.created_by.name", "custom_field.currency_code", "custom_field.custom_label", "custom_field.custom_label_position", "custom_field.date_value", "custom_field.date_value.date", "custom_field.date_value.date_time", "custom_field.default_access_level", "custom_field.description", "custom_field.display_value", "custom_field.enabled", "custom_field.enum_options", "custom_field.enum_options.color", "custom_field.enum_options.enabled", "custom_field.enum_options.name", "custom_field.enum_value", "custom_field.enum_value.color", "custom_field.enum_value.enabled", "custom_field.enum_value.name", "custom_field.format", "custom_field.has_notifications_enabled", "custom_field.id_prefix", "custom_field.input_restrictions", "custom_field.is_formula_field", "custom_field.is_global_to_workspace", "custom_field.is_value_read_only", "custom_field.multi_enum_values", "custom_field.multi_enum_values.color", "custom_field.multi_enum_values.enabled", "custom_field.multi_enum_values.name", "custom_field.name", "custom_field.number_value", "custom_field.people_value", "custom_field.people_value.name", "custom_field.precision", "custom_field.privacy_setting", "custom_field.reference_value", "custom_field.reference_value.name", "custom_field.representation_type", "custom_field.resource_subtype", "custom_field.text_value", "custom_field.type", "is_important", "parent", "parent.name", "project", "project.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "custom_field": { "description": "Custom Field" }, "is_important": { "type": "boolean", "description": "Whether this field should be considered important to this container (for instance, to display in the list view of items in the container)." }, "insert_before": { "type": "string", "description": "A gid of a Custom Field Setting on this container, before which the new Custom Field Setting will be added. `insert_before` and `insert_after` parameters cannot both be specified." }, "insert_after": { "type": "string", "description": "A gid of a Custom Field Setting on this container, after which the new Custom Field Setting will be added. `insert_before` and `insert_after` parameters cannot both be specified." } }, "required": [ "custom_field" ] } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_add\_followers\_for\_project Add followers to a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "owner", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "followers": { "type": "string", "description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user." } }, "required": [ "followers" ] } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_add\_members\_for\_project Add users to a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "owner", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "members": { "type": "string", "description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user." } }, "required": [ "members" ] } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_create\_project Create a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "owner", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_projects\_create\_project\_brief Create a project brief **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "html_text", "permalink_url", "project", "project.name", "text", "title" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_create\_project\_for\_team Create a project in a team **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `team_gid` | string | Yes | — | Globally unique identifier for the team. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_gid": { "type": "string", "description": "Globally unique identifier for the team." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "owner", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "team_gid" ] } ``` *** ## asana\_projects\_create\_project\_for\_workspace Create a project in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "owner", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_projects\_create\_project\_status\_for\_project Create a project status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "author", "author.name", "color", "created_at", "created_by", "created_by.name", "html_text", "modified_at", "text", "title" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_delete\_project Delete a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_delete\_project\_brief Delete a project brief **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_brief_gid` | string | Yes | — | Globally unique identifier for the project brief. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_brief_gid": { "type": "string", "description": "Globally unique identifier for the project brief." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "project_brief_gid" ] } ``` *** ## asana\_projects\_delete\_project\_status Delete a project status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_status_gid` | string | Yes | — | The project status update to get. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_status_gid": { "type": "string", "description": "The project status update to get." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "project_status_gid" ] } ``` *** ## asana\_projects\_delete\_project\_template Delete a project template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_template_gid` | string | Yes | — | Globally unique identifier for the project template. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_template_gid": { "type": "string", "description": "Globally unique identifier for the project template." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "project_template_gid" ] } ``` *** ## asana\_projects\_duplicate\_project Duplicate a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "new_graph_export", "new_graph_export.completed_at", "new_graph_export.created_at", "new_graph_export.download_url", "new_portfolio", "new_portfolio.name", "new_project", "new_project.name", "new_project_template", "new_project_template.name", "new_resource_export", "new_resource_export.completed_at", "new_resource_export.created_at", "new_resource_export.download_url", "new_task", "new_task.created_by", "new_task.name", "new_task.resource_subtype", "resource_subtype", "status" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "name": { "type": "string", "description": "The name of the new project." }, "team": { "type": "string", "description": "Sets the team of the new project. If team is not defined, the new project will be in the same team as the the original project." }, "include": { "type": "string", "description": "A comma-separated list of elements to include when duplicating a project. Some elements are automatically included and cannot be excluded, while others are **optional** and must be explicitly specified in this field. **Auto-included fields (non-configurable)** - Tasks - [Project Views](https://asana.com/features/project-management/project-views) (i.e., tabs in a project such as List, Board, Dashboard, etc.) - [Rules](https://help.asana.com/s/article/rules) *Note: The Owner of the Rules copied to the new project is the user who performs the API call. If the duplication is performed using a [Service Account](/docs/authentication#/service-account), note that Service Accounts cannot access the UI to modify or pause Rules. To prevent unwanted automation behavior, consider pausing Rules in the source project before duplication — their active/paused state is preserved in the new project.* **Optional fields (configurable)** - allocations - forms - members - notes - permissions - task_assignee - task_attachments - task_dates - task_dependencies - task_followers - task_notes - task_projects - task_subtasks - task_tags - task_templates - task_type_default" }, "schedule_dates": { "type": "object", "description": "A dictionary of options to auto-shift dates. `task_dates` must be included to use this option. Requires `should_skip_weekends` and either `start_on` or `due_on`, but not both." } }, "required": [ "name" ] } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_get\_for\_task Get projects a task is in **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "offset", "owner", "path", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_projects\_get\_for\_workspace Get all projects in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `archived` | boolean | No | — | Only return projects whose `archived` field takes on the value of this parameter. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "archived": { "type": "boolean", "description": "Only return projects whose `archived` field takes on the value of this parameter." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "offset", "owner", "path", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_projects\_get\_project Get a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "owner", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_get\_project\_brief Get a project brief **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_brief_gid` | string | Yes | — | Globally unique identifier for the project brief. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_brief_gid": { "type": "string", "description": "Globally unique identifier for the project brief." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "html_text", "permalink_url", "project", "project.name", "text", "title" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_brief_gid" ] } ``` *** ## asana\_projects\_get\_project\_membership Get a project membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_membership_gid` | string | Yes | — | Project Membership Gid | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_membership_gid": { "type": "string", "description": "Project Membership Gid" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "access_level", "member", "member.name", "parent", "parent.name", "project", "project.name", "user", "user.name", "write_access" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_membership_gid" ] } ``` *** ## asana\_projects\_get\_project\_memberships\_for\_project Get memberships from a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `user` | string | No | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "user": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "access_level", "member", "member.name", "offset", "parent", "parent.name", "path", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_get\_project\_portfolio\_setting Get a project portfolio setting **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_portfolio_setting_gid` | string | Yes | — | Globally unique identifier for the project portfolio setting. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_portfolio_setting_gid": { "type": "string", "description": "Globally unique identifier for the project portfolio setting." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "is_access_control_inherited", "portfolio", "project" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_portfolio_setting_gid" ] } ``` *** ## asana\_projects\_get\_project\_portfolio\_settings\_for\_portfolio Get project portfolio settings for a portfolio **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `portfolio_gid` | string | Yes | — | Globally unique identifier for the portfolio. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "portfolio_gid": { "type": "string", "description": "Globally unique identifier for the portfolio." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "is_access_control_inherited", "offset", "path", "portfolio", "project", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "portfolio_gid" ] } ``` *** ## asana\_projects\_get\_project\_portfolio\_settings\_for\_project Get project portfolio settings for a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "is_access_control_inherited", "offset", "path", "portfolio", "project", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_get\_project\_status Get a project status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_status_gid` | string | Yes | — | The project status update to get. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_status_gid": { "type": "string", "description": "The project status update to get." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "author", "author.name", "color", "created_at", "created_by", "created_by.name", "html_text", "modified_at", "text", "title" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_status_gid" ] } ``` *** ## asana\_projects\_get\_project\_statuses\_for\_project Get statuses from a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "author", "author.name", "color", "created_at", "created_by", "created_by.name", "html_text", "modified_at", "offset", "path", "text", "title", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_get\_project\_template Get a project template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_template_gid` | string | Yes | — | Globally unique identifier for the project template. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_template_gid": { "type": "string", "description": "Globally unique identifier for the project template." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "description", "html_description", "name", "owner", "public", "requested_dates", "requested_dates.description", "requested_dates.name", "requested_roles", "requested_roles.name", "team", "team.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_template_gid" ] } ``` *** ## asana\_projects\_get\_project\_templates Get multiple project templates **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `workspace` | string | No | — | The workspace to filter results on. | | `team` | string | No | — | The team to filter projects on. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "workspace": { "type": "string", "description": "The workspace to filter results on." }, "team": { "type": "string", "description": "The team to filter projects on." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "description", "html_description", "name", "offset", "owner", "path", "public", "requested_dates", "requested_dates.description", "requested_dates.name", "requested_roles", "requested_roles.name", "team", "team.name", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_projects\_get\_project\_templates\_for\_team Get a team's project templates **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `team_gid` | string | Yes | — | Globally unique identifier for the team. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_gid": { "type": "string", "description": "Globally unique identifier for the team." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "description", "html_description", "name", "offset", "owner", "path", "public", "requested_dates", "requested_dates.description", "requested_dates.name", "requested_roles", "requested_roles.name", "team", "team.name", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "team_gid" ] } ``` *** ## asana\_projects\_get\_projects Get multiple projects **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `workspace` | string | No | — | The workspace or organization to filter projects on. | | `team` | string | No | — | **Deprecated.** The team to filter projects on. Please use `GET /memberships` with `{ member: team, resource_subtype: project_membership }` instead. | | `archived` | boolean | No | — | Only return projects whose `archived` field takes on the value of this parameter. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "workspace": { "type": "string", "description": "The workspace or organization to filter projects on." }, "team": { "type": "string", "description": "**Deprecated.** The team to filter projects on. Please use `GET /memberships` with `{ member: team, resource_subtype: project_membership }` instead." }, "archived": { "type": "boolean", "description": "Only return projects whose `archived` field takes on the value of this parameter." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "offset", "owner", "path", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_projects\_get\_task\_counts\_for\_project Get task count of a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "num_completed_milestones", "num_completed_tasks", "num_incomplete_milestones", "num_incomplete_tasks", "num_milestones", "num_tasks" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_instantiate\_project Instantiate a project from a project template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_template_gid` | string | Yes | — | Globally unique identifier for the project template. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_template_gid": { "type": "string", "description": "Globally unique identifier for the project template." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "new_graph_export", "new_graph_export.completed_at", "new_graph_export.created_at", "new_graph_export.download_url", "new_portfolio", "new_portfolio.name", "new_project", "new_project.name", "new_project_template", "new_project_template.name", "new_resource_export", "new_resource_export.completed_at", "new_resource_export.created_at", "new_resource_export.download_url", "new_task", "new_task.created_by", "new_task.name", "new_task.resource_subtype", "resource_subtype", "status" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "name": { "type": "string", "description": "The name of the new project." }, "team": { "type": "string", "description": "*Optional*. Sets the team of the new project. If the project template exists in an _organization_, you may specify a value for `team`. If no value is provided then it defaults to the same team as the project template." }, "public": { "type": "boolean", "description": "*Deprecated:* new integrations use `privacy_setting` instead." }, "privacy_setting": { "type": "string", "description": "The privacy setting of the project. *Note: Administrators in your organization may restrict the values of `privacy_setting`.* The value `private_to_team` is deprecated. Use `POST /memberships` to share a project with a team after creation.", "enum": [ "public_to_workspace", "private_to_team", "private" ] }, "is_strict": { "type": "boolean", "description": "*Optional*. If set to `true`, the endpoint returns an \"Unprocessable Entity\" error if you fail to provide a calendar date value for any date variable. If set to `false`, a default date is used for each unfulfilled date variable (e.g., the current date is used as the Start Date of a project)." }, "requested_dates": { "type": "array", "items": { "type": "object" }, "description": "*Conditional*. Array of mappings of date variables to calendar dates. This property is required in the instantiation request if the project template includes dates (e.g., a start date on a task)." }, "requested_roles": { "type": "array", "items": { "type": "object" }, "description": "Array of mappings of template roles to user ids" } }, "required": [ "name" ] } }, "required": [ "PCID", "project_template_gid" ] } ``` *** ## asana\_projects\_project\_save\_as\_template Create a project template from a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "new_graph_export", "new_graph_export.completed_at", "new_graph_export.created_at", "new_graph_export.download_url", "new_portfolio", "new_portfolio.name", "new_project", "new_project.name", "new_project_template", "new_project_template.name", "new_resource_export", "new_resource_export.completed_at", "new_resource_export.created_at", "new_resource_export.download_url", "new_task", "new_task.created_by", "new_task.name", "new_task.resource_subtype", "resource_subtype", "status" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "name": { "type": "string", "description": "The name of the new project template." }, "team": { "type": "string", "description": "Sets the team of the new project template. If the project exists in an organization, specify team and not workspace." }, "workspace": { "type": "string", "description": "Sets the workspace of the new project template. Only specify workspace if the project exists in a workspace." }, "public": { "type": "boolean", "description": "Sets the project template to public to its team." } }, "required": [ "name", "public" ] } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_remove\_custom\_field\_setting\_for\_project Remove a custom field from a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "custom_field": { "type": "string", "description": "The custom field to remove from this portfolio." } }, "required": [ "custom_field" ] } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_remove\_followers\_for\_project Remove followers from a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "owner", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "followers": { "type": "string", "description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user." } }, "required": [ "followers" ] } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_remove\_members\_for\_project Remove users from a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "owner", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "members": { "type": "string", "description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user." } }, "required": [ "members" ] } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_search\_projects\_for\_workspace Search projects in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `text` | string | No | — | Performs full-text search on the project name. | | `sort_by` | string | No | — | One of `due_date`, `created_at`, `completed_at`, or `modified_at`, defaults to `modified_at`. | | `sort_ascending` | boolean | No | — | Default `false`. | | `completed` | boolean | No | — | Filter on project completion status. | | `teams.any` | string | No | — | Comma-separated list of team IDs. | | `owner.any` | string | No | — | Comma-separated list of user identifiers to filter on as project owners. | | `members.any` | string | No | — | Comma-separated list of user identifiers to filter on as members. | | `members.not` | string | No | — | Comma-separated list of user identifiers to exclude as members. | | `portfolios.any` | string | No | — | Comma-separated list of portfolio IDs to filter on. | | `completed_on` | string | No | — | ISO 8601 date string or `null`. | | `completed_on.before` | string | No | — | ISO 8601 date string. | | `completed_on.after` | string | No | — | ISO 8601 date string. | | `completed_at.before` | string | No | — | ISO 8601 datetime string. | | `completed_at.after` | string | No | — | ISO 8601 datetime string. | | `created_on` | string | No | — | ISO 8601 date string or `null`. | | `created_on.before` | string | No | — | ISO 8601 date string. | | `created_on.after` | string | No | — | ISO 8601 date string. | | `created_at.before` | string | No | — | ISO 8601 datetime string. | | `created_at.after` | string | No | — | ISO 8601 datetime string. | | `due_on` | string | No | — | ISO 8601 date string or `null`. | | `due_on.before` | string | No | — | ISO 8601 date string. | | `due_on.after` | string | No | — | ISO 8601 date string. | | `due_at.before` | string | No | — | ISO 8601 datetime string. | | `due_at.after` | string | No | — | ISO 8601 datetime string. | | `start_on` | string | No | — | ISO 8601 date string or `null`. | | `start_on.before` | string | No | — | ISO 8601 date string. | | `start_on.after` | string | No | — | ISO 8601 date string. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "text": { "type": "string", "description": "Performs full-text search on the project name." }, "sort_by": { "type": "string", "description": "One of `due_date`, `created_at`, `completed_at`, or `modified_at`, defaults to `modified_at`.", "enum": [ "due_date", "created_at", "completed_at", "modified_at" ] }, "sort_ascending": { "type": "boolean", "description": "Default `false`." }, "completed": { "type": "boolean", "description": "Filter on project completion status." }, "teams.any": { "type": "string", "description": "Comma-separated list of team IDs." }, "owner.any": { "type": "string", "description": "Comma-separated list of user identifiers to filter on as project owners." }, "members.any": { "type": "string", "description": "Comma-separated list of user identifiers to filter on as members." }, "members.not": { "type": "string", "description": "Comma-separated list of user identifiers to exclude as members." }, "portfolios.any": { "type": "string", "description": "Comma-separated list of portfolio IDs to filter on." }, "completed_on": { "type": "string", "description": "ISO 8601 date string or `null`." }, "completed_on.before": { "type": "string", "description": "ISO 8601 date string." }, "completed_on.after": { "type": "string", "description": "ISO 8601 date string." }, "completed_at.before": { "type": "string", "description": "ISO 8601 datetime string." }, "completed_at.after": { "type": "string", "description": "ISO 8601 datetime string." }, "created_on": { "type": "string", "description": "ISO 8601 date string or `null`." }, "created_on.before": { "type": "string", "description": "ISO 8601 date string." }, "created_on.after": { "type": "string", "description": "ISO 8601 date string." }, "created_at.before": { "type": "string", "description": "ISO 8601 datetime string." }, "created_at.after": { "type": "string", "description": "ISO 8601 datetime string." }, "due_on": { "type": "string", "description": "ISO 8601 date string or `null`." }, "due_on.before": { "type": "string", "description": "ISO 8601 date string." }, "due_on.after": { "type": "string", "description": "ISO 8601 date string." }, "due_at.before": { "type": "string", "description": "ISO 8601 datetime string." }, "due_at.after": { "type": "string", "description": "ISO 8601 datetime string." }, "start_on": { "type": "string", "description": "ISO 8601 date string or `null`." }, "start_on.before": { "type": "string", "description": "ISO 8601 date string." }, "start_on.after": { "type": "string", "description": "ISO 8601 date string." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "owner", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_projects\_update\_project Update a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "archived", "color", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_from_template", "created_from_template.name", "current_status", "current_status.author", "current_status.author.name", "current_status.color", "current_status.created_at", "current_status.created_by", "current_status.created_by.name", "current_status.html_text", "current_status.modified_at", "current_status.text", "current_status.title", "current_status_update", "current_status_update.resource_subtype", "current_status_update.title", "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "default_access_level", "default_view", "due_date", "due_on", "followers", "followers.name", "html_notes", "icon", "members", "members.name", "minimum_access_level_for_customization", "minimum_access_level_for_sharing", "modified_at", "name", "notes", "owner", "permalink_url", "privacy_setting", "project_brief", "public", "start_on", "team", "team.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_projects\_update\_project\_brief Update a project brief **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_brief_gid` | string | Yes | — | Globally unique identifier for the project brief. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_brief_gid": { "type": "string", "description": "Globally unique identifier for the project brief." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "html_text", "permalink_url", "project", "project.name", "text", "title" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "project_brief_gid" ] } ``` *** ## asana\_projects\_update\_project\_portfolio\_setting Update a project portfolio setting **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_portfolio_setting_gid` | string | Yes | — | Globally unique identifier for the project portfolio setting. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_portfolio_setting_gid": { "type": "string", "description": "Globally unique identifier for the project portfolio setting." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "is_access_control_inherited", "portfolio", "project" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "is_access_control_inherited": { "type": "boolean", "description": "When true, the portfolio members gain access to the project." } } } }, "required": [ "PCID", "project_portfolio_setting_gid" ] } ``` # asana-task-details Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/asana-api/asana-task-details Asana Task Details — manage comments/stories, sections, tags, time tracking entries, and reactions on tasks **Server path:** `/asana-task-details` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`asana_task_details_add_task_for_section`](#asana_task_details_add_task_for_section) | Add task to section | | [`asana_task_details_create_section_for_project`](#asana_task_details_create_section_for_project) | Create a section in a project | | [`asana_task_details_create_story_for_task`](#asana_task_details_create_story_for_task) | Create a story on a task | | [`asana_task_details_create_tag`](#asana_task_details_create_tag) | Create a tag | | [`asana_task_details_create_tag_for_workspace`](#asana_task_details_create_tag_for_workspace) | Create a tag in a workspace | | [`asana_task_details_create_time_tracking_entry`](#asana_task_details_create_time_tracking_entry) | Create a time tracking entry | | [`asana_task_details_delete_section`](#asana_task_details_delete_section) | Delete a section | | [`asana_task_details_delete_story`](#asana_task_details_delete_story) | Delete a story | | [`asana_task_details_delete_tag`](#asana_task_details_delete_tag) | Delete a tag | | [`asana_task_details_delete_time_tracking_entry`](#asana_task_details_delete_time_tracking_entry) | Delete a time tracking entry | | [`asana_task_details_get_reactions_on_object`](#asana_task_details_get_reactions_on_object) | Get reactions with an emoji base on an object. | | [`asana_task_details_get_section`](#asana_task_details_get_section) | Get a section | | [`asana_task_details_get_sections_for_project`](#asana_task_details_get_sections_for_project) | Get sections in a project | | [`asana_task_details_get_stories_for_task`](#asana_task_details_get_stories_for_task) | Get stories from a task | | [`asana_task_details_get_story`](#asana_task_details_get_story) | Get a story | | [`asana_task_details_get_tag`](#asana_task_details_get_tag) | Get a tag | | [`asana_task_details_get_tags`](#asana_task_details_get_tags) | Get multiple tags | | [`asana_task_details_get_tags_for_task`](#asana_task_details_get_tags_for_task) | Get a task's tags | | [`asana_task_details_get_tags_for_workspace`](#asana_task_details_get_tags_for_workspace) | Get tags in a workspace | | [`asana_task_details_get_time_tracking_entries`](#asana_task_details_get_time_tracking_entries) | Get multiple time tracking entries | | [`asana_task_details_get_time_tracking_entries_for_task`](#asana_task_details_get_time_tracking_entries_for_task) | Get time tracking entries for a task | | [`asana_task_details_get_time_tracking_entry`](#asana_task_details_get_time_tracking_entry) | Get a time tracking entry | | [`asana_task_details_insert_section_for_project`](#asana_task_details_insert_section_for_project) | Move or Insert sections | | [`asana_task_details_update_section`](#asana_task_details_update_section) | Update a section | | [`asana_task_details_update_story`](#asana_task_details_update_story) | Update a story | | [`asana_task_details_update_tag`](#asana_task_details_update_tag) | Update a tag | | [`asana_task_details_update_time_tracking_entry`](#asana_task_details_update_time_tracking_entry) | Update a time tracking entry | *** ## asana\_task\_details\_add\_task\_for\_section Add task to section **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `section_gid` | string | Yes | — | The globally unique identifier for the section. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "section_gid": { "type": "string", "description": "The globally unique identifier for the section." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "task": { "type": "string", "description": "The task to add to this section." }, "insert_before": { "type": "string", "description": "An existing task within this section before which the added task should be inserted. Cannot be provided together with insert_after." }, "insert_after": { "type": "string", "description": "An existing task within this section after which the added task should be inserted. Cannot be provided together with insert_before." } }, "required": [ "task" ] } }, "required": [ "PCID", "section_gid" ] } ``` *** ## asana\_task\_details\_create\_section\_for\_project Create a section in a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "name", "project", "project.name", "projects", "projects.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "name": { "type": "string", "description": "The text to be displayed as the section name. This cannot be an empty string." }, "insert_before": { "type": "string", "description": "An existing section within this project before which the added section should be inserted. Cannot be provided together with insert_after." }, "insert_after": { "type": "string", "description": "An existing section within this project after which the added section should be inserted. Cannot be provided together with insert_before." } }, "required": [ "name" ] } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_task\_details\_create\_story\_for\_task Create a story on a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A story represents an activity associated with an object in the Asana system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "assignee", "assignee.name", "created_at", "created_by", "created_by.name", "custom_field", "custom_field.date_value", "custom_field.date_value.date", "custom_field.date_value.date_time", "custom_field.display_value", "custom_field.enabled", "custom_field.enum_options", "custom_field.enum_options.color", "custom_field.enum_options.enabled", "custom_field.enum_options.name", "custom_field.enum_value", "custom_field.enum_value.color", "custom_field.enum_value.enabled", "custom_field.enum_value.name", "custom_field.id_prefix", "custom_field.input_restrictions", "custom_field.is_formula_field", "custom_field.multi_enum_values", "custom_field.multi_enum_values.color", "custom_field.multi_enum_values.enabled", "custom_field.multi_enum_values.name", "custom_field.name", "custom_field.number_value", "custom_field.representation_type", "custom_field.text_value", "custom_field.type", "dependency", "dependency.created_by", "dependency.name", "dependency.resource_subtype", "duplicate_of", "duplicate_of.created_by", "duplicate_of.name", "duplicate_of.resource_subtype", "duplicated_from", "duplicated_from.created_by", "duplicated_from.name", "duplicated_from.resource_subtype", "follower", "follower.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_text", "is_editable", "is_edited", "is_pinned", "liked", "likes", "likes.user", "likes.user.name", "new_approval_status", "new_date_value", "new_dates", "new_dates.due_at", "new_dates.due_on", "new_dates.start_on", "new_enum_value", "new_enum_value.color", "new_enum_value.enabled", "new_enum_value.name", "new_multi_enum_values", "new_multi_enum_values.color", "new_multi_enum_values.enabled", "new_multi_enum_values.name", "new_name", "new_number_value", "new_people_value", "new_people_value.name", "new_resource_subtype", "new_section", "new_section.name", "new_text_value", "num_hearts", "num_likes", "old_approval_status", "old_date_value", "old_dates", "old_dates.due_at", "old_dates.due_on", "old_dates.start_on", "old_enum_value", "old_enum_value.color", "old_enum_value.enabled", "old_enum_value.name", "old_multi_enum_values", "old_multi_enum_values.color", "old_multi_enum_values.enabled", "old_multi_enum_values.name", "old_name", "old_number_value", "old_people_value", "old_people_value.name", "old_resource_subtype", "old_section", "old_section.name", "old_text_value", "previews", "previews.fallback", "previews.footer", "previews.header", "previews.header_link", "previews.html_text", "previews.text", "previews.title", "previews.title_link", "project", "project.name", "reaction_summary", "reaction_summary.count", "reaction_summary.emoji_base", "reaction_summary.reacted", "reaction_summary.variant", "resource_subtype", "source", "sticker_name", "story", "story.created_at", "story.created_by", "story.created_by.name", "story.resource_subtype", "story.text", "tag", "tag.name", "target", "target.created_by", "target.name", "target.resource_subtype", "task", "task.created_by", "task.name", "task.resource_subtype", "text", "type" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A story represents an activity associated with an object in the Asana system.", "properties": { "gid": { "type": "string", "description": "Globally unique identifier of the resource, as a string." }, "resource_type": { "type": "string", "description": "The base type of this resource." }, "created_at": { "type": "string", "description": "The time at which this resource was created." }, "resource_subtype": { "type": "string", "description": "The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning." }, "text": { "type": "string", "description": "The plain text of the comment to add. Cannot be used with html_text." }, "html_text": { "type": "string", "description": "[Opt In](/docs/inputoutput-options). HTML formatted text for a comment. This will not include the name of the creator." }, "is_pinned": { "type": "boolean", "description": "*Conditional*. Whether the story should be pinned on the resource." }, "sticker_name": { "type": "string", "description": "The name of the sticker in this story. `null` if there is no sticker.", "enum": [ "green_checkmark", "people_dancing", "dancing_unicorn", "heart", "party_popper", "people_waving_flags", "splashing_narwhal", "trophy", "yeti_riding_unicorn", "celebrating_people", "determined_climbers", "phoenix_spreading_love" ] } } } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_task\_details\_create\_tag Create a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "created_at", "followers", "followers.name", "name", "notes", "permalink_url", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_task\_details\_create\_tag\_for\_workspace Create a tag in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "created_at", "followers", "followers.name", "name", "notes", "permalink_url", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_task\_details\_create\_time\_tracking\_entry Create a time tracking entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "approval_status", "attributable_to", "attributable_to.name", "billable_status", "created_at", "created_by", "created_by.name", "description", "duration_minutes", "entered_on", "task", "task.created_by", "task.name", "task.resource_subtype" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "duration_minutes": { "type": "integer", "description": "Time in minutes tracked by the entry. Must be greater than 0" }, "entered_on": { "type": "string", "description": "*Optional*. The day that this entry is logged on. Defaults to today if not specified" }, "attributable_to": { "type": "string", "description": "*Optional*. The gid of the project which the time is attributable to." }, "billable_status": { "type": "string", "description": "*Optional*. The current billable status of the entry.", "enum": [ "billable", "nonBillable", "notApplicable" ] }, "description": { "type": "string", "description": "*Optional*. The description of the entry." } } } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_task\_details\_delete\_section Delete a section **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `section_gid` | string | Yes | — | The globally unique identifier for the section. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "section_gid": { "type": "string", "description": "The globally unique identifier for the section." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "section_gid" ] } ``` *** ## asana\_task\_details\_delete\_story Delete a story **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `story_gid` | string | Yes | — | Globally unique identifier for the story. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story_gid": { "type": "string", "description": "Globally unique identifier for the story." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "story_gid" ] } ``` *** ## asana\_task\_details\_delete\_tag Delete a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `tag_gid` | string | Yes | — | Globally unique identifier for the tag. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag_gid": { "type": "string", "description": "Globally unique identifier for the tag." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "tag_gid" ] } ``` *** ## asana\_task\_details\_delete\_time\_tracking\_entry Delete a time tracking entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `time_tracking_entry_gid` | string | Yes | — | Globally unique identifier for the time tracking entry. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "time_tracking_entry_gid": { "type": "string", "description": "Globally unique identifier for the time tracking entry." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "time_tracking_entry_gid" ] } ``` *** ## asana\_task\_details\_get\_reactions\_on\_object Get reactions with an emoji base on an object. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `target` | string | Yes | — | Globally unique identifier for object to fetch reactions from. Must be a GID for a status update or story. | | `emoji_base` | string | Yes | — | Only return reactions with this emoji base character. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "target": { "type": "string", "description": "Globally unique identifier for object to fetch reactions from. Must be a GID for a status update or story." }, "emoji_base": { "type": "string", "description": "Only return reactions with this emoji base character." } }, "required": [ "PCID", "target", "emoji_base" ] } ``` *** ## asana\_task\_details\_get\_section Get a section **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `section_gid` | string | Yes | — | The globally unique identifier for the section. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "section_gid": { "type": "string", "description": "The globally unique identifier for the section." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "name", "project", "project.name", "projects", "projects.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "section_gid" ] } ``` *** ## asana\_task\_details\_get\_sections\_for\_project Get sections in a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "name", "offset", "path", "project", "project.name", "projects", "projects.name", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_task\_details\_get\_stories\_for\_task Get stories from a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "assignee", "assignee.name", "created_at", "created_by", "created_by.name", "custom_field", "custom_field.date_value", "custom_field.date_value.date", "custom_field.date_value.date_time", "custom_field.display_value", "custom_field.enabled", "custom_field.enum_options", "custom_field.enum_options.color", "custom_field.enum_options.enabled", "custom_field.enum_options.name", "custom_field.enum_value", "custom_field.enum_value.color", "custom_field.enum_value.enabled", "custom_field.enum_value.name", "custom_field.id_prefix", "custom_field.input_restrictions", "custom_field.is_formula_field", "custom_field.multi_enum_values", "custom_field.multi_enum_values.color", "custom_field.multi_enum_values.enabled", "custom_field.multi_enum_values.name", "custom_field.name", "custom_field.number_value", "custom_field.representation_type", "custom_field.text_value", "custom_field.type", "dependency", "dependency.created_by", "dependency.name", "dependency.resource_subtype", "duplicate_of", "duplicate_of.created_by", "duplicate_of.name", "duplicate_of.resource_subtype", "duplicated_from", "duplicated_from.created_by", "duplicated_from.name", "duplicated_from.resource_subtype", "follower", "follower.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_text", "is_editable", "is_edited", "is_pinned", "liked", "likes", "likes.user", "likes.user.name", "new_approval_status", "new_date_value", "new_dates", "new_dates.due_at", "new_dates.due_on", "new_dates.start_on", "new_enum_value", "new_enum_value.color", "new_enum_value.enabled", "new_enum_value.name", "new_multi_enum_values", "new_multi_enum_values.color", "new_multi_enum_values.enabled", "new_multi_enum_values.name", "new_name", "new_number_value", "new_people_value", "new_people_value.name", "new_resource_subtype", "new_section", "new_section.name", "new_text_value", "num_hearts", "num_likes", "offset", "old_approval_status", "old_date_value", "old_dates", "old_dates.due_at", "old_dates.due_on", "old_dates.start_on", "old_enum_value", "old_enum_value.color", "old_enum_value.enabled", "old_enum_value.name", "old_multi_enum_values", "old_multi_enum_values.color", "old_multi_enum_values.enabled", "old_multi_enum_values.name", "old_name", "old_number_value", "old_people_value", "old_people_value.name", "old_resource_subtype", "old_section", "old_section.name", "old_text_value", "path", "previews", "previews.fallback", "previews.footer", "previews.header", "previews.header_link", "previews.html_text", "previews.text", "previews.title", "previews.title_link", "project", "project.name", "reaction_summary", "reaction_summary.count", "reaction_summary.emoji_base", "reaction_summary.reacted", "reaction_summary.variant", "resource_subtype", "source", "sticker_name", "story", "story.created_at", "story.created_by", "story.created_by.name", "story.resource_subtype", "story.text", "tag", "tag.name", "target", "target.created_by", "target.name", "target.resource_subtype", "task", "task.created_by", "task.name", "task.resource_subtype", "text", "type", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_task\_details\_get\_story Get a story **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `story_gid` | string | Yes | — | Globally unique identifier for the story. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story_gid": { "type": "string", "description": "Globally unique identifier for the story." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "assignee", "assignee.name", "created_at", "created_by", "created_by.name", "custom_field", "custom_field.date_value", "custom_field.date_value.date", "custom_field.date_value.date_time", "custom_field.display_value", "custom_field.enabled", "custom_field.enum_options", "custom_field.enum_options.color", "custom_field.enum_options.enabled", "custom_field.enum_options.name", "custom_field.enum_value", "custom_field.enum_value.color", "custom_field.enum_value.enabled", "custom_field.enum_value.name", "custom_field.id_prefix", "custom_field.input_restrictions", "custom_field.is_formula_field", "custom_field.multi_enum_values", "custom_field.multi_enum_values.color", "custom_field.multi_enum_values.enabled", "custom_field.multi_enum_values.name", "custom_field.name", "custom_field.number_value", "custom_field.representation_type", "custom_field.text_value", "custom_field.type", "dependency", "dependency.created_by", "dependency.name", "dependency.resource_subtype", "duplicate_of", "duplicate_of.created_by", "duplicate_of.name", "duplicate_of.resource_subtype", "duplicated_from", "duplicated_from.created_by", "duplicated_from.name", "duplicated_from.resource_subtype", "follower", "follower.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_text", "is_editable", "is_edited", "is_pinned", "liked", "likes", "likes.user", "likes.user.name", "new_approval_status", "new_date_value", "new_dates", "new_dates.due_at", "new_dates.due_on", "new_dates.start_on", "new_enum_value", "new_enum_value.color", "new_enum_value.enabled", "new_enum_value.name", "new_multi_enum_values", "new_multi_enum_values.color", "new_multi_enum_values.enabled", "new_multi_enum_values.name", "new_name", "new_number_value", "new_people_value", "new_people_value.name", "new_resource_subtype", "new_section", "new_section.name", "new_text_value", "num_hearts", "num_likes", "old_approval_status", "old_date_value", "old_dates", "old_dates.due_at", "old_dates.due_on", "old_dates.start_on", "old_enum_value", "old_enum_value.color", "old_enum_value.enabled", "old_enum_value.name", "old_multi_enum_values", "old_multi_enum_values.color", "old_multi_enum_values.enabled", "old_multi_enum_values.name", "old_name", "old_number_value", "old_people_value", "old_people_value.name", "old_resource_subtype", "old_section", "old_section.name", "old_text_value", "previews", "previews.fallback", "previews.footer", "previews.header", "previews.header_link", "previews.html_text", "previews.text", "previews.title", "previews.title_link", "project", "project.name", "reaction_summary", "reaction_summary.count", "reaction_summary.emoji_base", "reaction_summary.reacted", "reaction_summary.variant", "resource_subtype", "source", "sticker_name", "story", "story.created_at", "story.created_by", "story.created_by.name", "story.resource_subtype", "story.text", "tag", "tag.name", "target", "target.created_by", "target.name", "target.resource_subtype", "task", "task.created_by", "task.name", "task.resource_subtype", "text", "type" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "story_gid" ] } ``` *** ## asana\_task\_details\_get\_tag Get a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `tag_gid` | string | Yes | — | Globally unique identifier for the tag. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag_gid": { "type": "string", "description": "Globally unique identifier for the tag." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "created_at", "followers", "followers.name", "name", "notes", "permalink_url", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "tag_gid" ] } ``` *** ## asana\_task\_details\_get\_tags Get multiple tags **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `workspace` | string | No | — | The workspace to filter tags on. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "workspace": { "type": "string", "description": "The workspace to filter tags on." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "created_at", "followers", "followers.name", "name", "notes", "offset", "path", "permalink_url", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_task\_details\_get\_tags\_for\_task Get a task's tags **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "created_at", "followers", "followers.name", "name", "notes", "offset", "path", "permalink_url", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_task\_details\_get\_tags\_for\_workspace Get tags in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "created_at", "followers", "followers.name", "name", "notes", "offset", "path", "permalink_url", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_task\_details\_get\_time\_tracking\_entries Get multiple time tracking entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `task` | string | No | — | Globally unique identifier for the task to filter time tracking entries by. | | `attributable_to` | string | No | — | Globally unique identifier for the project the time tracking entries are attributed to. | | `portfolio` | string | No | — | Globally unique identifier for the portfolio to filter time tracking entries by. | | `user` | string | No | — | Globally unique identifier for the user to filter time tracking entries by. | | `workspace` | string | No | — | Globally unique identifier for the workspace. At least one of `entered_on_start_date` or `entered_on_end_date` must be provided when filtering by workspace. | | `entered_on_start_date` | string | No | — | The start date for filtering time tracking entries by when they were entered. | | `entered_on_end_date` | string | No | — | The end date for filtering time tracking entries by when they were entered. | | `timesheet_approval_status` | string | No | — | Globally unique identifier for the timesheet approval status to filter time tracking entries by. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "task": { "type": "string", "description": "Globally unique identifier for the task to filter time tracking entries by." }, "attributable_to": { "type": "string", "description": "Globally unique identifier for the project the time tracking entries are attributed to." }, "portfolio": { "type": "string", "description": "Globally unique identifier for the portfolio to filter time tracking entries by." }, "user": { "type": "string", "description": "Globally unique identifier for the user to filter time tracking entries by." }, "workspace": { "type": "string", "description": "Globally unique identifier for the workspace. At least one of `entered_on_start_date` or `entered_on_end_date` must be provided when filtering by workspace." }, "entered_on_start_date": { "type": "string", "description": "The start date for filtering time tracking entries by when they were entered." }, "entered_on_end_date": { "type": "string", "description": "The end date for filtering time tracking entries by when they were entered." }, "timesheet_approval_status": { "type": "string", "description": "Globally unique identifier for the timesheet approval status to filter time tracking entries by." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "attributable_to", "attributable_to.name", "created_by", "created_by.name", "duration_minutes", "entered_on", "offset", "path", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_task\_details\_get\_time\_tracking\_entries\_for\_task Get time tracking entries for a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "attributable_to", "attributable_to.name", "created_by", "created_by.name", "duration_minutes", "entered_on", "offset", "path", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_task\_details\_get\_time\_tracking\_entry Get a time tracking entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `time_tracking_entry_gid` | string | Yes | — | Globally unique identifier for the time tracking entry. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "time_tracking_entry_gid": { "type": "string", "description": "Globally unique identifier for the time tracking entry." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "approval_status", "attributable_to", "attributable_to.name", "billable_status", "created_at", "created_by", "created_by.name", "description", "duration_minutes", "entered_on", "task", "task.created_by", "task.name", "task.resource_subtype" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "time_tracking_entry_gid" ] } ``` *** ## asana\_task\_details\_insert\_section\_for\_project Move or Insert sections **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "section": { "type": "string", "description": "The section to reorder." }, "before_section": { "type": "string", "description": "Insert the given section immediately before the section specified by this parameter." }, "after_section": { "type": "string", "description": "Insert the given section immediately after the section specified by this parameter." } }, "required": [ "section" ] } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_task\_details\_update\_section Update a section **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `section_gid` | string | Yes | — | The globally unique identifier for the section. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "section_gid": { "type": "string", "description": "The globally unique identifier for the section." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "name", "project", "project.name", "projects", "projects.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "name": { "type": "string", "description": "The text to be displayed as the section name. This cannot be an empty string." }, "insert_before": { "type": "string", "description": "An existing section within this project before which the added section should be inserted. Cannot be provided together with insert_after." }, "insert_after": { "type": "string", "description": "An existing section within this project after which the added section should be inserted. Cannot be provided together with insert_before." } }, "required": [ "name" ] } }, "required": [ "PCID", "section_gid" ] } ``` *** ## asana\_task\_details\_update\_story Update a story **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `story_gid` | string | Yes | — | Globally unique identifier for the story. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A story represents an activity associated with an object in the Asana system. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "story_gid": { "type": "string", "description": "Globally unique identifier for the story." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "assignee", "assignee.name", "created_at", "created_by", "created_by.name", "custom_field", "custom_field.date_value", "custom_field.date_value.date", "custom_field.date_value.date_time", "custom_field.display_value", "custom_field.enabled", "custom_field.enum_options", "custom_field.enum_options.color", "custom_field.enum_options.enabled", "custom_field.enum_options.name", "custom_field.enum_value", "custom_field.enum_value.color", "custom_field.enum_value.enabled", "custom_field.enum_value.name", "custom_field.id_prefix", "custom_field.input_restrictions", "custom_field.is_formula_field", "custom_field.multi_enum_values", "custom_field.multi_enum_values.color", "custom_field.multi_enum_values.enabled", "custom_field.multi_enum_values.name", "custom_field.name", "custom_field.number_value", "custom_field.representation_type", "custom_field.text_value", "custom_field.type", "dependency", "dependency.created_by", "dependency.name", "dependency.resource_subtype", "duplicate_of", "duplicate_of.created_by", "duplicate_of.name", "duplicate_of.resource_subtype", "duplicated_from", "duplicated_from.created_by", "duplicated_from.name", "duplicated_from.resource_subtype", "follower", "follower.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_text", "is_editable", "is_edited", "is_pinned", "liked", "likes", "likes.user", "likes.user.name", "new_approval_status", "new_date_value", "new_dates", "new_dates.due_at", "new_dates.due_on", "new_dates.start_on", "new_enum_value", "new_enum_value.color", "new_enum_value.enabled", "new_enum_value.name", "new_multi_enum_values", "new_multi_enum_values.color", "new_multi_enum_values.enabled", "new_multi_enum_values.name", "new_name", "new_number_value", "new_people_value", "new_people_value.name", "new_resource_subtype", "new_section", "new_section.name", "new_text_value", "num_hearts", "num_likes", "old_approval_status", "old_date_value", "old_dates", "old_dates.due_at", "old_dates.due_on", "old_dates.start_on", "old_enum_value", "old_enum_value.color", "old_enum_value.enabled", "old_enum_value.name", "old_multi_enum_values", "old_multi_enum_values.color", "old_multi_enum_values.enabled", "old_multi_enum_values.name", "old_name", "old_number_value", "old_people_value", "old_people_value.name", "old_resource_subtype", "old_section", "old_section.name", "old_text_value", "previews", "previews.fallback", "previews.footer", "previews.header", "previews.header_link", "previews.html_text", "previews.text", "previews.title", "previews.title_link", "project", "project.name", "reaction_summary", "reaction_summary.count", "reaction_summary.emoji_base", "reaction_summary.reacted", "reaction_summary.variant", "resource_subtype", "source", "sticker_name", "story", "story.created_at", "story.created_by", "story.created_by.name", "story.resource_subtype", "story.text", "tag", "tag.name", "target", "target.created_by", "target.name", "target.resource_subtype", "task", "task.created_by", "task.name", "task.resource_subtype", "text", "type" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A story represents an activity associated with an object in the Asana system.", "properties": { "gid": { "type": "string", "description": "Globally unique identifier of the resource, as a string." }, "resource_type": { "type": "string", "description": "The base type of this resource." }, "created_at": { "type": "string", "description": "The time at which this resource was created." }, "resource_subtype": { "type": "string", "description": "The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning." }, "text": { "type": "string", "description": "The plain text of the comment to add. Cannot be used with html_text." }, "html_text": { "type": "string", "description": "[Opt In](/docs/inputoutput-options). HTML formatted text for a comment. This will not include the name of the creator." }, "is_pinned": { "type": "boolean", "description": "*Conditional*. Whether the story should be pinned on the resource." }, "sticker_name": { "type": "string", "description": "The name of the sticker in this story. `null` if there is no sticker.", "enum": [ "green_checkmark", "people_dancing", "dancing_unicorn", "heart", "party_popper", "people_waving_flags", "splashing_narwhal", "trophy", "yeti_riding_unicorn", "celebrating_people", "determined_climbers", "phoenix_spreading_love" ] } } } }, "required": [ "PCID", "story_gid" ] } ``` *** ## asana\_task\_details\_update\_tag Update a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `tag_gid` | string | Yes | — | Globally unique identifier for the tag. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag_gid": { "type": "string", "description": "Globally unique identifier for the tag." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "color", "created_at", "followers", "followers.name", "name", "notes", "permalink_url", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "tag_gid" ] } ``` *** ## asana\_task\_details\_update\_time\_tracking\_entry Update a time tracking entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `time_tracking_entry_gid` | string | Yes | — | Globally unique identifier for the time tracking entry. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "time_tracking_entry_gid": { "type": "string", "description": "Globally unique identifier for the time tracking entry." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "approval_status", "attributable_to", "attributable_to.name", "billable_status", "created_at", "created_by", "created_by.name", "description", "duration_minutes", "entered_on", "task", "task.created_by", "task.name", "task.resource_subtype" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "duration_minutes": { "type": "integer", "description": "*Optional*. Time in minutes tracked by the entry" }, "entered_on": { "type": "string", "description": "*Optional*. The day that this entry is logged on. Defaults to today if no day specified" }, "attributable_to": { "type": "string", "description": "*Optional*. The gid of the project which the time is attributable to." }, "billable_status": { "type": "string", "description": "*Optional*. The current billable status of the entry.", "enum": [ "billable", "nonBillable", "notApplicable" ] }, "description": { "type": "string", "description": "*Optional*. The description of the entry." } } } }, "required": [ "PCID", "time_tracking_entry_gid" ] } ``` # asana-tasks Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/asana-api/asana-tasks Asana Tasks — create, update, search, and manage tasks, subtasks, dependencies, and task templates **Server path:** `/asana-tasks` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`asana_tasks_add_dependencies_for_task`](#asana_tasks_add_dependencies_for_task) | Set dependencies for a task | | [`asana_tasks_add_dependents_for_task`](#asana_tasks_add_dependents_for_task) | Set dependents for a task | | [`asana_tasks_add_followers_for_task`](#asana_tasks_add_followers_for_task) | Add followers to a task | | [`asana_tasks_add_project_for_task`](#asana_tasks_add_project_for_task) | Add a project to a task | | [`asana_tasks_add_tag_for_task`](#asana_tasks_add_tag_for_task) | Add a tag to a task | | [`asana_tasks_create_subtask_for_task`](#asana_tasks_create_subtask_for_task) | Create a subtask | | [`asana_tasks_create_task`](#asana_tasks_create_task) | Create a task | | [`asana_tasks_delete_task`](#asana_tasks_delete_task) | Delete a task | | [`asana_tasks_delete_task_template`](#asana_tasks_delete_task_template) | Delete a task template | | [`asana_tasks_duplicate_task`](#asana_tasks_duplicate_task) | Duplicate a task | | [`asana_tasks_get_dependencies_for_task`](#asana_tasks_get_dependencies_for_task) | Get dependencies from a task | | [`asana_tasks_get_dependents_for_task`](#asana_tasks_get_dependents_for_task) | Get dependents from a task | | [`asana_tasks_get_for_project`](#asana_tasks_get_for_project) | Get tasks from a project | | [`asana_tasks_get_for_section`](#asana_tasks_get_for_section) | Get tasks from a section | | [`asana_tasks_get_for_tag`](#asana_tasks_get_for_tag) | Get tasks from a tag | | [`asana_tasks_get_for_user_task_list`](#asana_tasks_get_for_user_task_list) | Get tasks from a user task list | | [`asana_tasks_get_subtasks_for_task`](#asana_tasks_get_subtasks_for_task) | Get subtasks from a task | | [`asana_tasks_get_task`](#asana_tasks_get_task) | Get a task | | [`asana_tasks_get_task_for_custom_id`](#asana_tasks_get_task_for_custom_id) | Get a task for a given custom ID | | [`asana_tasks_get_task_template`](#asana_tasks_get_task_template) | Get a task template | | [`asana_tasks_get_task_templates`](#asana_tasks_get_task_templates) | Get multiple task templates | | [`asana_tasks_get_tasks`](#asana_tasks_get_tasks) | Get multiple tasks | | [`asana_tasks_instantiate_task`](#asana_tasks_instantiate_task) | Instantiate a task from a task template | | [`asana_tasks_remove_dependencies_for_task`](#asana_tasks_remove_dependencies_for_task) | Unlink dependencies from a task | | [`asana_tasks_remove_dependents_for_task`](#asana_tasks_remove_dependents_for_task) | Unlink dependents from a task | | [`asana_tasks_remove_follower_for_task`](#asana_tasks_remove_follower_for_task) | Remove followers from a task | | [`asana_tasks_remove_project_for_task`](#asana_tasks_remove_project_for_task) | Remove a project from a task | | [`asana_tasks_remove_tag_for_task`](#asana_tasks_remove_tag_for_task) | Remove a tag from a task | | [`asana_tasks_search_tasks_for_workspace`](#asana_tasks_search_tasks_for_workspace) | Search tasks in a workspace | | [`asana_tasks_set_parent_for_task`](#asana_tasks_set_parent_for_task) | Set the parent of a task | | [`asana_tasks_update_task`](#asana_tasks_update_task) | Update a task | *** ## asana\_tasks\_add\_dependencies\_for\_task Set dependencies for a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "dependencies": { "type": "array", "items": { "type": "string" }, "description": "An array of task gids that a task depends on." } } } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_add\_dependents\_for\_task Set dependents for a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | A set of dependent tasks. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "A set of dependent tasks.", "properties": { "dependents": { "type": "array", "items": { "type": "string" }, "description": "An array of task gids that are dependents of the given task." } } } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_add\_followers\_for\_task Add followers to a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "followers": { "type": "array", "items": { "type": "string" }, "description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user." } }, "required": [ "followers" ] } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_add\_project\_for\_task Add a project to a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "project": { "type": "string", "description": "The project to add the task to." }, "insert_after": { "type": "string", "description": "A task in the project to insert the task after, or `null` to insert at the beginning of the list. When used with `section`, `null` will insert at the beginning of the specified section, otherwise the task must be in the specified section." }, "insert_before": { "type": "string", "description": "A task in the project to insert the task before, or `null` to insert at the end of the list. When used with `section`, `null` will insert at the end of the specified section, otherwise the task must be in the specified section." }, "section": { "type": "string", "description": "A section in the project to insert the task into. The task will be inserted at the bottom of the section unless combined with `insert_before: null` (end of section) or `insert_after: null` (beginning of section). Can also be combined with non-null `insert_before` or `insert_after` to position relative to a task within the section." } }, "required": [ "project" ] } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_add\_tag\_for\_task Add a tag to a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "tag": { "type": "string", "description": "The tag's gid to add to the task." } }, "required": [ "tag" ] } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_create\_subtask\_for\_task Create a subtask **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_create\_task Create a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_tasks\_delete\_task Delete a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_delete\_task\_template Delete a task template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_template_gid` | string | Yes | — | Globally unique identifier for the task template. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_template_gid": { "type": "string", "description": "Globally unique identifier for the task template." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "task_template_gid" ] } ``` *** ## asana\_tasks\_duplicate\_task Duplicate a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "new_graph_export", "new_graph_export.completed_at", "new_graph_export.created_at", "new_graph_export.download_url", "new_portfolio", "new_portfolio.name", "new_project", "new_project.name", "new_project_template", "new_project_template.name", "new_resource_export", "new_resource_export.completed_at", "new_resource_export.created_at", "new_resource_export.download_url", "new_task", "new_task.created_by", "new_task.name", "new_task.resource_subtype", "resource_subtype", "status" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "name": { "type": "string", "description": "The name of the new task." }, "include": { "type": "string", "description": "A comma-separated list of fields that will be duplicated to the new task. ##### Fields - assignee - attachments - dates - dependencies - followers - notes - parent - projects - subtasks - tags" } } } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_get\_dependencies\_for\_task Get dependencies from a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "offset", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "path", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_get\_dependents\_for\_task Get dependents from a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "offset", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "path", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_get\_for\_project Get tasks from a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `completed_since` | string | No | — | Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. | | `project_gid` | string | Yes | — | Globally unique identifier for the project. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "completed_since": { "type": "string", "description": "Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*." }, "project_gid": { "type": "string", "description": "Globally unique identifier for the project." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "offset", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "path", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "project_gid" ] } ``` *** ## asana\_tasks\_get\_for\_section Get tasks from a section **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `section_gid` | string | Yes | — | The globally unique identifier for the section. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `completed_since` | string | No | — | Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "section_gid": { "type": "string", "description": "The globally unique identifier for the section." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "completed_since": { "type": "string", "description": "Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "offset", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "path", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "section_gid" ] } ``` *** ## asana\_tasks\_get\_for\_tag Get tasks from a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `tag_gid` | string | Yes | — | Globally unique identifier for the tag. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag_gid": { "type": "string", "description": "Globally unique identifier for the tag." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "offset", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "path", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "tag_gid" ] } ``` *** ## asana\_tasks\_get\_for\_user\_task\_list Get tasks from a user task list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `completed_since` | string | No | — | Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. | | `user_task_list_gid` | string | Yes | — | Globally unique identifier for the user task list. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "completed_since": { "type": "string", "description": "Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*." }, "user_task_list_gid": { "type": "string", "description": "Globally unique identifier for the user task list." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "offset", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "path", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "user_task_list_gid" ] } ``` *** ## asana\_tasks\_get\_subtasks\_for\_task Get subtasks from a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "offset", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "path", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_get\_task Get a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_get\_task\_for\_custom\_id Get a task for a given custom ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `custom_id` | string | Yes | — | Generated custom ID for a task. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "custom_id": { "type": "string", "description": "Generated custom ID for a task." } }, "required": [ "PCID", "workspace_gid", "custom_id" ] } ``` *** ## asana\_tasks\_get\_task\_template Get a task template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_template_gid` | string | Yes | — | Globally unique identifier for the task template. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_template_gid": { "type": "string", "description": "Globally unique identifier for the task template." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "created_by", "name", "project", "template" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "task_template_gid" ] } ``` *** ## asana\_tasks\_get\_task\_templates Get multiple task templates **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `project` | string | No | — | The project to filter task templates on. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "project": { "type": "string", "description": "The project to filter task templates on." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "created_by", "name", "project", "template" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_tasks\_get\_tasks Get multiple tasks **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `assignee` | string | No | — | The assignee to filter tasks on. If searching for unassigned tasks, assignee.any = null can be specified. *Note: If you specify `assignee`, you must also specify the `workspace` to filter on.* | | `project` | string | No | — | The project to filter tasks on. | | `section` | string | No | — | The section to filter tasks on. | | `workspace` | string | No | — | The workspace to filter tasks on. *Note: If you specify `workspace`, you must also specify the `assignee` to filter on.* | | `completed_since` | string | No | — | Only return tasks that are either incomplete or that have been completed since this time. | | `modified_since` | string | No | — | Only return tasks that have been modified since the given time. *Note: A task is considered “modified” if any of its properties change, or associations between it and other objects are modified (e.g. a task being added to a project). A task is not considered modified just because another object it is associated with (e.g. a subtask) is modified. Actions that count as modifying the task include assigning, renaming, completing, and adding stories.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "assignee": { "type": "string", "description": "The assignee to filter tasks on. If searching for unassigned tasks, assignee.any = null can be specified. *Note: If you specify `assignee`, you must also specify the `workspace` to filter on.*" }, "project": { "type": "string", "description": "The project to filter tasks on." }, "section": { "type": "string", "description": "The section to filter tasks on." }, "workspace": { "type": "string", "description": "The workspace to filter tasks on. *Note: If you specify `workspace`, you must also specify the `assignee` to filter on.*" }, "completed_since": { "type": "string", "description": "Only return tasks that are either incomplete or that have been completed since this time." }, "modified_since": { "type": "string", "description": "Only return tasks that have been modified since the given time. *Note: A task is considered “modified” if any of its properties change, or associations between it and other objects are modified (e.g. a task being added to a project). A task is not considered modified just because another object it is associated with (e.g. a subtask) is modified. Actions that count as modifying the task include assigning, renaming, completing, and adding stories.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "offset", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "path", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "uri", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_tasks\_instantiate\_task Instantiate a task from a task template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_template_gid` | string | Yes | — | Globally unique identifier for the task template. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_template_gid": { "type": "string", "description": "Globally unique identifier for the task template." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "new_graph_export", "new_graph_export.completed_at", "new_graph_export.created_at", "new_graph_export.download_url", "new_portfolio", "new_portfolio.name", "new_project", "new_project.name", "new_project_template", "new_project_template.name", "new_resource_export", "new_resource_export.completed_at", "new_resource_export.created_at", "new_resource_export.download_url", "new_task", "new_task.created_by", "new_task.name", "new_task.resource_subtype", "resource_subtype", "status" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "name": { "type": "string", "description": "The name of the new task. If not provided, the name of the task template will be used." } } } }, "required": [ "PCID", "task_template_gid" ] } ``` *** ## asana\_tasks\_remove\_dependencies\_for\_task Unlink dependencies from a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "dependencies": { "type": "array", "items": { "type": "string" }, "description": "An array of task gids that a task depends on." } } } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_remove\_dependents\_for\_task Unlink dependents from a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | A set of dependent tasks. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "A set of dependent tasks.", "properties": { "dependents": { "type": "array", "items": { "type": "string" }, "description": "An array of task gids that are dependents of the given task." } } } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_remove\_follower\_for\_task Remove followers from a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "followers": { "type": "array", "items": { "type": "string" }, "description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user." } }, "required": [ "followers" ] } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_remove\_project\_for\_task Remove a project from a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "project": { "type": "string", "description": "The project to remove the task from." } }, "required": [ "project" ] } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_remove\_tag\_for\_task Remove a tag from a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "tag": { "type": "string", "description": "The tag's gid to remove from the task." } }, "required": [ "tag" ] } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_search\_tasks\_for\_workspace Search tasks in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `text` | string | No | — | Performs full-text search on both task name and description | | `resource_subtype` | string | No | — | Filters results by the task's resource\_subtype | | `assignee.any` | string | No | — | Comma-separated list of user identifiers | | `assignee.not` | string | No | — | Comma-separated list of user identifiers | | `portfolios.any` | string | No | — | Comma-separated list of portfolio IDs | | `projects.any` | string | No | — | Comma-separated list of project IDs | | `projects.not` | string | No | — | Comma-separated list of project IDs | | `projects.all` | string | No | — | Comma-separated list of project IDs | | `sections.any` | string | No | — | Comma-separated list of section or column IDs | | `sections.not` | string | No | — | Comma-separated list of section or column IDs | | `sections.all` | string | No | — | Comma-separated list of section or column IDs | | `tags.any` | string | No | — | Comma-separated list of tag IDs | | `tags.not` | string | No | — | Comma-separated list of tag IDs | | `tags.all` | string | No | — | Comma-separated list of tag IDs | | `teams.any` | string | No | — | Comma-separated list of team IDs | | `followers.any` | string | No | — | Comma-separated list of user identifiers | | `followers.not` | string | No | — | Comma-separated list of user identifiers | | `created_by.any` | string | No | — | Comma-separated list of user identifiers | | `created_by.not` | string | No | — | Comma-separated list of user identifiers | | `assigned_by.any` | string | No | — | Comma-separated list of user identifiers | | `assigned_by.not` | string | No | — | Comma-separated list of user identifiers | | `liked_by.not` | string | No | — | Comma-separated list of user identifiers | | `commented_on_by.not` | string | No | — | Comma-separated list of user identifiers | | `due_on.before` | string | No | — | ISO 8601 date string | | `due_on.after` | string | No | — | ISO 8601 date string | | `due_on` | string | No | — | ISO 8601 date string or `null` | | `due_at.before` | string | No | — | ISO 8601 datetime string | | `due_at.after` | string | No | — | ISO 8601 datetime string | | `start_on.before` | string | No | — | ISO 8601 date string | | `start_on.after` | string | No | — | ISO 8601 date string | | `start_on` | string | No | — | ISO 8601 date string or `null` | | `created_on.before` | string | No | — | ISO 8601 date string | | `created_on.after` | string | No | — | ISO 8601 date string | | `created_on` | string | No | — | ISO 8601 date string or `null` | | `created_at.before` | string | No | — | ISO 8601 datetime string | | `created_at.after` | string | No | — | ISO 8601 datetime string | | `completed_on.before` | string | No | — | ISO 8601 date string | | `completed_on.after` | string | No | — | ISO 8601 date string | | `completed_on` | string | No | — | ISO 8601 date string or `null` | | `completed_at.before` | string | No | — | ISO 8601 datetime string | | `completed_at.after` | string | No | — | ISO 8601 datetime string | | `modified_on.before` | string | No | — | ISO 8601 date string | | `modified_on.after` | string | No | — | ISO 8601 date string | | `modified_on` | string | No | — | ISO 8601 date string or `null` | | `modified_at.before` | string | No | — | ISO 8601 datetime string | | `modified_at.after` | string | No | — | ISO 8601 datetime string | | `is_blocking` | boolean | No | — | Filter to incomplete tasks with dependents | | `is_blocked` | boolean | No | — | Filter to tasks with incomplete dependencies | | `has_attachment` | boolean | No | — | Filter to tasks with attachments | | `completed` | boolean | No | — | Filter to completed tasks | | `is_subtask` | boolean | No | — | Filter to subtasks | | `sort_by` | string | No | — | One of `due_date`, `created_at`, `completed_at`, `likes`, or `modified_at`, defaults to `modified_at` | | `sort_ascending` | boolean | No | — | Default `false` | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "text": { "type": "string", "description": "Performs full-text search on both task name and description" }, "resource_subtype": { "type": "string", "description": "Filters results by the task's resource_subtype", "enum": [ "default_task", "milestone", "approval", "custom" ] }, "assignee.any": { "type": "string", "description": "Comma-separated list of user identifiers" }, "assignee.not": { "type": "string", "description": "Comma-separated list of user identifiers" }, "portfolios.any": { "type": "string", "description": "Comma-separated list of portfolio IDs" }, "projects.any": { "type": "string", "description": "Comma-separated list of project IDs" }, "projects.not": { "type": "string", "description": "Comma-separated list of project IDs" }, "projects.all": { "type": "string", "description": "Comma-separated list of project IDs" }, "sections.any": { "type": "string", "description": "Comma-separated list of section or column IDs" }, "sections.not": { "type": "string", "description": "Comma-separated list of section or column IDs" }, "sections.all": { "type": "string", "description": "Comma-separated list of section or column IDs" }, "tags.any": { "type": "string", "description": "Comma-separated list of tag IDs" }, "tags.not": { "type": "string", "description": "Comma-separated list of tag IDs" }, "tags.all": { "type": "string", "description": "Comma-separated list of tag IDs" }, "teams.any": { "type": "string", "description": "Comma-separated list of team IDs" }, "followers.any": { "type": "string", "description": "Comma-separated list of user identifiers" }, "followers.not": { "type": "string", "description": "Comma-separated list of user identifiers" }, "created_by.any": { "type": "string", "description": "Comma-separated list of user identifiers" }, "created_by.not": { "type": "string", "description": "Comma-separated list of user identifiers" }, "assigned_by.any": { "type": "string", "description": "Comma-separated list of user identifiers" }, "assigned_by.not": { "type": "string", "description": "Comma-separated list of user identifiers" }, "liked_by.not": { "type": "string", "description": "Comma-separated list of user identifiers" }, "commented_on_by.not": { "type": "string", "description": "Comma-separated list of user identifiers" }, "due_on.before": { "type": "string", "description": "ISO 8601 date string" }, "due_on.after": { "type": "string", "description": "ISO 8601 date string" }, "due_on": { "type": "string", "description": "ISO 8601 date string or `null`" }, "due_at.before": { "type": "string", "description": "ISO 8601 datetime string" }, "due_at.after": { "type": "string", "description": "ISO 8601 datetime string" }, "start_on.before": { "type": "string", "description": "ISO 8601 date string" }, "start_on.after": { "type": "string", "description": "ISO 8601 date string" }, "start_on": { "type": "string", "description": "ISO 8601 date string or `null`" }, "created_on.before": { "type": "string", "description": "ISO 8601 date string" }, "created_on.after": { "type": "string", "description": "ISO 8601 date string" }, "created_on": { "type": "string", "description": "ISO 8601 date string or `null`" }, "created_at.before": { "type": "string", "description": "ISO 8601 datetime string" }, "created_at.after": { "type": "string", "description": "ISO 8601 datetime string" }, "completed_on.before": { "type": "string", "description": "ISO 8601 date string" }, "completed_on.after": { "type": "string", "description": "ISO 8601 date string" }, "completed_on": { "type": "string", "description": "ISO 8601 date string or `null`" }, "completed_at.before": { "type": "string", "description": "ISO 8601 datetime string" }, "completed_at.after": { "type": "string", "description": "ISO 8601 datetime string" }, "modified_on.before": { "type": "string", "description": "ISO 8601 date string" }, "modified_on.after": { "type": "string", "description": "ISO 8601 date string" }, "modified_on": { "type": "string", "description": "ISO 8601 date string or `null`" }, "modified_at.before": { "type": "string", "description": "ISO 8601 datetime string" }, "modified_at.after": { "type": "string", "description": "ISO 8601 datetime string" }, "is_blocking": { "type": "boolean", "description": "Filter to incomplete tasks with dependents" }, "is_blocked": { "type": "boolean", "description": "Filter to tasks with incomplete dependencies" }, "has_attachment": { "type": "boolean", "description": "Filter to tasks with attachments" }, "completed": { "type": "boolean", "description": "Filter to completed tasks" }, "is_subtask": { "type": "boolean", "description": "Filter to subtasks" }, "sort_by": { "type": "string", "description": "One of `due_date`, `created_at`, `completed_at`, `likes`, or `modified_at`, defaults to `modified_at`", "enum": [ "due_date", "created_at", "completed_at", "likes", "modified_at" ] }, "sort_ascending": { "type": "boolean", "description": "Default `false`" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_tasks\_set\_parent\_for\_task Set the parent of a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "parent": { "type": "string", "description": "The new parent of the task, or `null` for no parent." }, "insert_after": { "type": "string", "description": "A subtask of the parent to insert the task after, or `null` to insert at the beginning of the list." }, "insert_before": { "type": "string", "description": "A subtask of the parent to insert the task before, or `null` to insert at the end of the list." } }, "required": [ "parent" ] } }, "required": [ "PCID", "task_gid" ] } ``` *** ## asana\_tasks\_update\_task Update a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_gid` | string | Yes | — | The task to operate on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_gid": { "type": "string", "description": "The task to operate on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "actual_time_minutes", "approval_status", "assigned_by", "assigned_by.name", "assignee", "assignee.name", "assignee_section", "assignee_section.name", "assignee_status", "completed", "completed_at", "completed_by", "completed_by.name", "created_at", "created_by", "custom_fields", "custom_fields.asana_created_field", "custom_fields.created_by", "custom_fields.created_by.name", "custom_fields.currency_code", "custom_fields.custom_label", "custom_fields.custom_label_position", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.default_access_level", "custom_fields.description", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.format", "custom_fields.has_notifications_enabled", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.is_global_to_workspace", "custom_fields.is_value_read_only", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.people_value", "custom_fields.people_value.name", "custom_fields.precision", "custom_fields.privacy_setting", "custom_fields.reference_value", "custom_fields.reference_value.name", "custom_fields.representation_type", "custom_fields.resource_subtype", "custom_fields.text_value", "custom_fields.type", "custom_type", "custom_type.name", "custom_type_status_option", "custom_type_status_option.name", "dependencies", "dependents", "due_at", "due_on", "external", "external.data", "followers", "followers.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_notes", "is_rendered_as_separator", "liked", "likes", "likes.user", "likes.user.name", "memberships", "memberships.project", "memberships.project.name", "memberships.section", "memberships.section.name", "modified_at", "name", "notes", "num_hearts", "num_likes", "num_subtasks", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "permalink_url", "projects", "projects.name", "resource_subtype", "start_at", "start_on", "tags", "tags.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "task_gid" ] } ``` # asana-users-teams Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/asana-api/asana-users-teams Asana Users & Teams — manage users, teams, team memberships, workspaces, workspace memberships, and user task lists **Server path:** `/asana-users-teams` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`asana_users_teams_add_user_for_team`](#asana_users_teams_add_user_for_team) | Add a user to a team | | [`asana_users_teams_add_user_for_workspace`](#asana_users_teams_add_user_for_workspace) | Add a user to a workspace or organization | | [`asana_users_teams_create_membership`](#asana_users_teams_create_membership) | Create a membership | | [`asana_users_teams_create_team`](#asana_users_teams_create_team) | Create a team | | [`asana_users_teams_delete_membership`](#asana_users_teams_delete_membership) | Delete a membership | | [`asana_users_teams_get_favorites_for_user`](#asana_users_teams_get_favorites_for_user) | Get a user's favorites | | [`asana_users_teams_get_for_team`](#asana_users_teams_get_for_team) | Get users in a team | | [`asana_users_teams_get_for_user`](#asana_users_teams_get_for_user) | Get teams for a user | | [`asana_users_teams_get_for_workspace`](#asana_users_teams_get_for_workspace) | Get users in a workspace or organization | | [`asana_users_teams_get_for_workspace`](#asana_users_teams_get_for_workspace) | Get teams in a workspace | | [`asana_users_teams_get_membership`](#asana_users_teams_get_membership) | Get a membership | | [`asana_users_teams_get_memberships`](#asana_users_teams_get_memberships) | Get multiple memberships | | [`asana_users_teams_get_team`](#asana_users_teams_get_team) | Get a team | | [`asana_users_teams_get_team_membership`](#asana_users_teams_get_team_membership) | Get a team membership | | [`asana_users_teams_get_team_memberships`](#asana_users_teams_get_team_memberships) | Get team memberships | | [`asana_users_teams_get_team_memberships_for_team`](#asana_users_teams_get_team_memberships_for_team) | Get memberships from a team | | [`asana_users_teams_get_team_memberships_for_user`](#asana_users_teams_get_team_memberships_for_user) | Get memberships from a user | | [`asana_users_teams_get_user`](#asana_users_teams_get_user) | Get a user | | [`asana_users_teams_get_user_for_workspace`](#asana_users_teams_get_user_for_workspace) | Get a user in a workspace or organization | | [`asana_users_teams_get_user_task_list`](#asana_users_teams_get_user_task_list) | Get a user task list | | [`asana_users_teams_get_user_task_list_for_user`](#asana_users_teams_get_user_task_list_for_user) | Get a user's task list | | [`asana_users_teams_get_users`](#asana_users_teams_get_users) | Get multiple users | | [`asana_users_teams_get_workspace`](#asana_users_teams_get_workspace) | Get a workspace | | [`asana_users_teams_get_workspace_events`](#asana_users_teams_get_workspace_events) | Get workspace events | | [`asana_users_teams_get_workspace_membership`](#asana_users_teams_get_workspace_membership) | Get a workspace membership | | [`asana_users_teams_get_workspace_memberships_for_user`](#asana_users_teams_get_workspace_memberships_for_user) | Get workspace memberships for a user | | [`asana_users_teams_get_workspace_memberships_for_workspace`](#asana_users_teams_get_workspace_memberships_for_workspace) | Get the workspace memberships for a workspace | | [`asana_users_teams_get_workspace_teams`](#asana_users_teams_get_workspace_teams) | Get teams in a workspace | | [`asana_users_teams_get_workspace_users`](#asana_users_teams_get_workspace_users) | Get users in a workspace or organization | | [`asana_users_teams_get_workspaces`](#asana_users_teams_get_workspaces) | Get multiple workspaces | | [`asana_users_teams_remove_user_for_team`](#asana_users_teams_remove_user_for_team) | Remove a user from a team | | [`asana_users_teams_remove_user_for_workspace`](#asana_users_teams_remove_user_for_workspace) | Remove a user from a workspace or organization | | [`asana_users_teams_typeahead_for_workspace`](#asana_users_teams_typeahead_for_workspace) | Get objects via typeahead | | [`asana_users_teams_update_membership`](#asana_users_teams_update_membership) | Update a membership | | [`asana_users_teams_update_team`](#asana_users_teams_update_team) | Update a team | | [`asana_users_teams_update_user`](#asana_users_teams_update_user) | Update a user | | [`asana_users_teams_update_user_for_workspace`](#asana_users_teams_update_user_for_workspace) | Update a user in a workspace or organization | | [`asana_users_teams_update_workspace`](#asana_users_teams_update_workspace) | Update a workspace | *** ## asana\_users\_teams\_add\_user\_for\_team Add a user to a team **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `team_gid` | string | Yes | — | Globally unique identifier for the team. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A user identification object for specification with the addUser/removeUser endpoints. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_gid": { "type": "string", "description": "Globally unique identifier for the team." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "is_admin", "is_guest", "is_limited_access", "team", "team.name", "user", "user.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A user identification object for specification with the addUser/removeUser endpoints.", "properties": { "user": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." } } } }, "required": [ "PCID", "team_gid" ] } ``` *** ## asana\_users\_teams\_add\_user\_for\_workspace Add a user to a workspace or organization **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A user identification object for specification with the addUser/removeUser endpoints. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "email", "name", "photo", "photo.image_1024x1024", "photo.image_128x128", "photo.image_21x21", "photo.image_27x27", "photo.image_36x36", "photo.image_60x60" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A user identification object for specification with the addUser/removeUser endpoints.", "properties": { "user": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." } } } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_users\_teams\_create\_membership Create a membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_users\_teams\_create\_team Create a team **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "description", "edit_team_name_or_description_access_level", "edit_team_visibility_or_trash_team_access_level", "endorsed", "guest_invite_management_access_level", "html_description", "join_request_management_access_level", "member_invite_management_access_level", "name", "organization", "organization.name", "permalink_url", "team_content_management_access_level", "team_member_removal_access_level", "visibility" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_users\_teams\_delete\_membership Delete a membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `membership_gid` | string | Yes | — | Globally unique identifier for the membership. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "membership_gid": { "type": "string", "description": "Globally unique identifier for the membership." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "membership_gid" ] } ``` *** ## asana\_users\_teams\_get\_favorites\_for\_user Get a user's favorites **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user_gid` | string | Yes | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `resource_type` | string | Yes | — | The resource type of favorites to be returned. | | `workspace` | string | Yes | — | The workspace in which to get favorites. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "user_gid": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "resource_type": { "type": "string", "description": "The resource type of favorites to be returned.", "enum": [ "portfolio", "project", "tag", "task", "user", "project_template" ] }, "workspace": { "type": "string", "description": "The workspace in which to get favorites." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "name", "offset", "path", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "user_gid", "resource_type", "workspace" ] } ``` *** ## asana\_users\_teams\_get\_for\_team Get users in a team **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `team_gid` | string | Yes | — | Globally unique identifier for the team. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_gid": { "type": "string", "description": "Globally unique identifier for the team." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "email", "name", "photo", "photo.image_1024x1024", "photo.image_128x128", "photo.image_21x21", "photo.image_27x27", "photo.image_36x36", "photo.image_60x60", "workspaces", "workspaces.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "team_gid" ] } ``` *** ## asana\_users\_teams\_get\_for\_user Get teams for a user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user_gid` | string | Yes | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `organization` | string | Yes | — | The workspace or organization to filter teams on. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "user_gid": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "organization": { "type": "string", "description": "The workspace or organization to filter teams on." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "description", "edit_team_name_or_description_access_level", "edit_team_visibility_or_trash_team_access_level", "endorsed", "guest_invite_management_access_level", "html_description", "join_request_management_access_level", "member_invite_management_access_level", "name", "offset", "organization", "organization.name", "path", "permalink_url", "team_content_management_access_level", "team_member_removal_access_level", "uri", "visibility" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "user_gid", "organization" ] } ``` *** ## asana\_users\_teams\_get\_for\_workspace Get users in a workspace or organization **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | any\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_users\_teams\_get\_for\_workspace Get teams in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | any\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_users\_teams\_get\_membership Get a membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `membership_gid` | string | Yes | — | Globally unique identifier for the membership. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "membership_gid": { "type": "string", "description": "Globally unique identifier for the membership." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "membership_gid" ] } ``` *** ## asana\_users\_teams\_get\_memberships Get multiple memberships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `parent` | string | No | — | Globally unique identifier for `goal`, `project`, `portfolio`, `custom_type`, or `custom_field`. This parameter is optional when `resource_subtype` is provided along with `member`. | | `member` | string | No | — | Globally unique identifier for `team` or `user`. When used with `resource_subtype` and without `parent`, returns all memberships of the specified subtype for this member. | | `resource_subtype` | string | No | — | The type of membership to return. Required when `parent` is absent. Currently supported value is `project_membership` (when `member` is a team GID, returns all project memberships for that team). | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "parent": { "type": "string", "description": "Globally unique identifier for `goal`, `project`, `portfolio`, `custom_type`, or `custom_field`. This parameter is optional when `resource_subtype` is provided along with `member`." }, "member": { "type": "string", "description": "Globally unique identifier for `team` or `user`. When used with `resource_subtype` and without `parent`, returns all memberships of the specified subtype for this member." }, "resource_subtype": { "type": "string", "description": "The type of membership to return. Required when `parent` is absent. Currently supported value is `project_membership` (when `member` is a team GID, returns all project memberships for that team).", "enum": [ "project_membership" ] }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "offset", "path", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_users\_teams\_get\_team Get a team **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `team_gid` | string | Yes | — | Globally unique identifier for the team. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_gid": { "type": "string", "description": "Globally unique identifier for the team." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "description", "edit_team_name_or_description_access_level", "edit_team_visibility_or_trash_team_access_level", "endorsed", "guest_invite_management_access_level", "html_description", "join_request_management_access_level", "member_invite_management_access_level", "name", "organization", "organization.name", "permalink_url", "team_content_management_access_level", "team_member_removal_access_level", "visibility" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "team_gid" ] } ``` *** ## asana\_users\_teams\_get\_team\_membership Get a team membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `team_membership_gid` | string | Yes | — | Team Membership Gid | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_membership_gid": { "type": "string", "description": "Team Membership Gid" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "is_admin", "is_guest", "is_limited_access", "team", "team.name", "user", "user.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "team_membership_gid" ] } ``` *** ## asana\_users\_teams\_get\_team\_memberships Get team memberships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `team` | string | No | — | Globally unique identifier for the team. | | `user` | string | No | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. This parameter must be used with the workspace parameter. | | `workspace` | string | No | — | Globally unique identifier for the workspace. This parameter must be used with the user parameter. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "team": { "type": "string", "description": "Globally unique identifier for the team." }, "user": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. This parameter must be used with the workspace parameter." }, "workspace": { "type": "string", "description": "Globally unique identifier for the workspace. This parameter must be used with the user parameter." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "is_admin", "is_guest", "is_limited_access", "offset", "path", "team", "team.name", "uri", "user", "user.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_users\_teams\_get\_team\_memberships\_for\_team Get memberships from a team **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `team_gid` | string | Yes | — | Globally unique identifier for the team. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_gid": { "type": "string", "description": "Globally unique identifier for the team." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "is_admin", "is_guest", "is_limited_access", "offset", "path", "team", "team.name", "uri", "user", "user.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "team_gid" ] } ``` *** ## asana\_users\_teams\_get\_team\_memberships\_for\_user Get memberships from a user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user_gid` | string | Yes | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `workspace` | string | Yes | — | Globally unique identifier for the workspace. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "user_gid": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "workspace": { "type": "string", "description": "Globally unique identifier for the workspace." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "is_admin", "is_guest", "is_limited_access", "offset", "path", "team", "team.name", "uri", "user", "user.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "user_gid", "workspace" ] } ``` *** ## asana\_users\_teams\_get\_user Get a user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user_gid` | string | Yes | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `workspace` | string | No | — | The workspace to filter results on. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "user_gid": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "workspace": { "type": "string", "description": "The workspace to filter results on." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "email", "name", "photo", "photo.image_1024x1024", "photo.image_128x128", "photo.image_21x21", "photo.image_27x27", "photo.image_36x36", "photo.image_60x60", "workspaces", "workspaces.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "user_gid" ] } ``` *** ## asana\_users\_teams\_get\_user\_for\_workspace Get a user in a workspace or organization **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `user_gid` | string | Yes | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "user_gid": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "email", "name", "photo", "photo.image_1024x1024", "photo.image_128x128", "photo.image_21x21", "photo.image_27x27", "photo.image_36x36", "photo.image_60x60", "workspaces", "workspaces.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid", "user_gid" ] } ``` *** ## asana\_users\_teams\_get\_user\_task\_list Get a user task list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user_task_list_gid` | string | Yes | — | Globally unique identifier for the user task list. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "user_task_list_gid": { "type": "string", "description": "Globally unique identifier for the user task list." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "name", "owner", "workspace" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "user_task_list_gid" ] } ``` *** ## asana\_users\_teams\_get\_user\_task\_list\_for\_user Get a user's task list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user_gid` | string | Yes | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `workspace` | string | Yes | — | The workspace in which to get the user task list. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "user_gid": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "workspace": { "type": "string", "description": "The workspace in which to get the user task list." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "name", "owner", "workspace" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "user_gid", "workspace" ] } ``` *** ## asana\_users\_teams\_get\_users Get multiple users **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | No | — | The workspace or organization ID to filter users on. | | `team` | string | No | — | The team ID to filter users on. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "The workspace or organization ID to filter users on." }, "team": { "type": "string", "description": "The team ID to filter users on." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "email", "name", "offset", "path", "photo", "photo.image_1024x1024", "photo.image_128x128", "photo.image_21x21", "photo.image_27x27", "photo.image_36x36", "photo.image_60x60", "uri", "workspaces", "workspaces.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_users\_teams\_get\_workspace Get a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "email_domains", "is_organization", "name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_users\_teams\_get\_workspace\_events Get workspace events **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `sync` | string | No | — | A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token. If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.* | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "sync": { "type": "string", "description": "A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token. If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.*" } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_users\_teams\_get\_workspace\_membership Get a workspace membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_membership_gid` | string | Yes | — | Workspace Membership Gid | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_membership_gid": { "type": "string", "description": "Workspace Membership Gid" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "is_active", "is_admin", "is_guest", "is_view_only", "user", "user.name", "user_task_list", "user_task_list.name", "user_task_list.owner", "user_task_list.workspace", "vacation_dates", "vacation_dates.end_on", "vacation_dates.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_membership_gid" ] } ``` *** ## asana\_users\_teams\_get\_workspace\_memberships\_for\_user Get workspace memberships for a user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user_gid` | string | Yes | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "user_gid": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "is_active", "is_admin", "is_guest", "is_view_only", "offset", "path", "uri", "user", "user.name", "user_task_list", "user_task_list.name", "user_task_list.owner", "user_task_list.workspace", "vacation_dates", "vacation_dates.end_on", "vacation_dates.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "user_gid" ] } ``` *** ## asana\_users\_teams\_get\_workspace\_memberships\_for\_workspace Get the workspace memberships for a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `user` | string | No | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "user": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "is_active", "is_admin", "is_guest", "is_view_only", "offset", "path", "uri", "user", "user.name", "user_task_list", "user_task_list.name", "user_task_list.owner", "user_task_list.workspace", "vacation_dates", "vacation_dates.end_on", "vacation_dates.start_on", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_users\_teams\_get\_workspace\_teams Get teams in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "description", "edit_team_name_or_description_access_level", "edit_team_visibility_or_trash_team_access_level", "endorsed", "guest_invite_management_access_level", "html_description", "join_request_management_access_level", "member_invite_management_access_level", "name", "offset", "organization", "organization.name", "path", "permalink_url", "team_content_management_access_level", "team_member_removal_access_level", "uri", "visibility" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_users\_teams\_get\_workspace\_users Get users in a workspace or organization **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "email", "name", "photo", "photo.image_1024x1024", "photo.image_128x128", "photo.image_21x21", "photo.image_27x27", "photo.image_36x36", "photo.image_60x60", "workspaces", "workspaces.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_users\_teams\_get\_workspaces Get multiple workspaces **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "email_domains", "is_organization", "name", "offset", "path", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID" ] } ``` *** ## asana\_users\_teams\_remove\_user\_for\_team Remove a user from a team **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `team_gid` | string | Yes | — | Globally unique identifier for the team. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | A user identification object for specification with the addUser/removeUser endpoints. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_gid": { "type": "string", "description": "Globally unique identifier for the team." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "A user identification object for specification with the addUser/removeUser endpoints.", "properties": { "user": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." } } } }, "required": [ "PCID", "team_gid" ] } ``` *** ## asana\_users\_teams\_remove\_user\_for\_workspace Remove a user from a workspace or organization **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | A user identification object for specification with the addUser/removeUser endpoints. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "A user identification object for specification with the addUser/removeUser endpoints.", "properties": { "user": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." } } } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_users\_teams\_typeahead\_for\_workspace Get objects via typeahead **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `resource_type` | string | Yes | — | The type of values the typeahead should return. You can choose from one of the following: `custom_field`, `goal`, `project`, `project_template`, `portfolio`, `tag`, `task`, `team`, and `user`. Note that unlike in the names of endpoints, the types listed here are in singular form (e.g. `task`). Using multiple types is not yet supported. | | `type` | string | No | — | *Deprecated: new integrations should prefer the resource\_type field.* | | `query` | string | No | — | The string that will be used to search for relevant objects. If an empty string is passed in, the API will return results. | | `count` | integer | No | — | The number of results to return. The default is 20 if this parameter is omitted, with a minimum of 1 and a maximum of 100. If there are fewer results found than requested, all will be returned. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "resource_type": { "type": "string", "description": "The type of values the typeahead should return. You can choose from one of the following: `custom_field`, `goal`, `project`, `project_template`, `portfolio`, `tag`, `task`, `team`, and `user`. Note that unlike in the names of endpoints, the types listed here are in singular form (e.g. `task`). Using multiple types is not yet supported.", "enum": [ "custom_field", "goal", "project", "project_template", "portfolio", "tag", "task", "team", "user" ] }, "type": { "type": "string", "description": "*Deprecated: new integrations should prefer the resource_type field.*", "enum": [ "custom_field", "portfolio", "project", "tag", "task", "user" ] }, "query": { "type": "string", "description": "The string that will be used to search for relevant objects. If an empty string is passed in, the API will return results." }, "count": { "type": "integer", "description": "The number of results to return. The default is 20 if this parameter is omitted, with a minimum of 1 and a maximum of 100. If there are fewer results found than requested, all will be returned." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace_gid", "resource_type" ] } ``` *** ## asana\_users\_teams\_update\_membership Update a membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `membership_gid` | string | Yes | — | Globally unique identifier for the membership. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "membership_gid": { "type": "string", "description": "Globally unique identifier for the membership." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "data": { "type": "object", "description": "The data value", "properties": { "access_level": { "type": "string", "description": "Sets the access level for the member. Goals can have access levels `viewer`, `commenter`, `editor` or `admin`. Projects can have access levels `admin`, `editor` or `commenter`. Portfolios can have access levels `admin`, `editor` or `viewer`. Custom Fields can have access levels `admin`, `editor` or `user`." } } } }, "required": [ "PCID", "membership_gid" ] } ``` *** ## asana\_users\_teams\_update\_team Update a team **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `team_gid` | string | Yes | — | Globally unique identifier for the team. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_gid": { "type": "string", "description": "Globally unique identifier for the team." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_field_settings", "custom_field_settings.custom_field", "custom_field_settings.custom_field.asana_created_field", "custom_field_settings.custom_field.created_by", "custom_field_settings.custom_field.created_by.name", "custom_field_settings.custom_field.currency_code", "custom_field_settings.custom_field.custom_label", "custom_field_settings.custom_field.custom_label_position", "custom_field_settings.custom_field.date_value", "custom_field_settings.custom_field.date_value.date", "custom_field_settings.custom_field.date_value.date_time", "custom_field_settings.custom_field.default_access_level", "custom_field_settings.custom_field.description", "custom_field_settings.custom_field.display_value", "custom_field_settings.custom_field.enabled", "custom_field_settings.custom_field.enum_options", "custom_field_settings.custom_field.enum_options.color", "custom_field_settings.custom_field.enum_options.enabled", "custom_field_settings.custom_field.enum_options.name", "custom_field_settings.custom_field.enum_value", "custom_field_settings.custom_field.enum_value.color", "custom_field_settings.custom_field.enum_value.enabled", "custom_field_settings.custom_field.enum_value.name", "custom_field_settings.custom_field.format", "custom_field_settings.custom_field.has_notifications_enabled", "custom_field_settings.custom_field.id_prefix", "custom_field_settings.custom_field.input_restrictions", "custom_field_settings.custom_field.is_formula_field", "custom_field_settings.custom_field.is_global_to_workspace", "custom_field_settings.custom_field.is_value_read_only", "custom_field_settings.custom_field.multi_enum_values", "custom_field_settings.custom_field.multi_enum_values.color", "custom_field_settings.custom_field.multi_enum_values.enabled", "custom_field_settings.custom_field.multi_enum_values.name", "custom_field_settings.custom_field.name", "custom_field_settings.custom_field.number_value", "custom_field_settings.custom_field.people_value", "custom_field_settings.custom_field.people_value.name", "custom_field_settings.custom_field.precision", "custom_field_settings.custom_field.privacy_setting", "custom_field_settings.custom_field.reference_value", "custom_field_settings.custom_field.reference_value.name", "custom_field_settings.custom_field.representation_type", "custom_field_settings.custom_field.resource_subtype", "custom_field_settings.custom_field.text_value", "custom_field_settings.custom_field.type", "custom_field_settings.is_important", "custom_field_settings.parent", "custom_field_settings.parent.name", "custom_field_settings.project", "custom_field_settings.project.name", "description", "edit_team_name_or_description_access_level", "edit_team_visibility_or_trash_team_access_level", "endorsed", "guest_invite_management_access_level", "html_description", "join_request_management_access_level", "member_invite_management_access_level", "name", "organization", "organization.name", "permalink_url", "team_content_management_access_level", "team_member_removal_access_level", "visibility" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "team_gid" ] } ``` *** ## asana\_users\_teams\_update\_user Update a user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `user_gid` | string | Yes | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `workspace` | string | No | — | The workspace to filter results on. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "user_gid": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "workspace": { "type": "string", "description": "The workspace to filter results on." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "email", "name", "photo", "photo.image_1024x1024", "photo.image_128x128", "photo.image_21x21", "photo.image_27x27", "photo.image_36x36", "photo.image_60x60", "workspaces", "workspaces.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "user_gid" ] } ``` *** ## asana\_users\_teams\_update\_user\_for\_workspace Update a user in a workspace or organization **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `user_gid` | string | Yes | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "user_gid": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "custom_fields", "custom_fields.date_value", "custom_fields.date_value.date", "custom_fields.date_value.date_time", "custom_fields.display_value", "custom_fields.enabled", "custom_fields.enum_options", "custom_fields.enum_options.color", "custom_fields.enum_options.enabled", "custom_fields.enum_options.name", "custom_fields.enum_value", "custom_fields.enum_value.color", "custom_fields.enum_value.enabled", "custom_fields.enum_value.name", "custom_fields.id_prefix", "custom_fields.input_restrictions", "custom_fields.is_formula_field", "custom_fields.multi_enum_values", "custom_fields.multi_enum_values.color", "custom_fields.multi_enum_values.enabled", "custom_fields.multi_enum_values.name", "custom_fields.name", "custom_fields.number_value", "custom_fields.representation_type", "custom_fields.text_value", "custom_fields.type", "email", "name", "photo", "photo.image_1024x1024", "photo.image_128x128", "photo.image_21x21", "photo.image_27x27", "photo.image_36x36", "photo.image_60x60", "workspaces", "workspaces.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID", "workspace_gid", "user_gid" ] } ``` *** ## asana\_users\_teams\_update\_workspace Update a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "email_domains", "is_organization", "name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.", "properties": { "gid": { "type": "string", "description": "Globally unique identifier of the resource, as a string." }, "resource_type": { "type": "string", "description": "The base type of this resource." }, "name": { "type": "string", "description": "The name of the workspace." } } } }, "required": [ "PCID", "workspace_gid" ] } ``` # asana-utilities Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/asana-api/asana-utilities Asana Utilities — webhooks, attachments, status updates, access requests, exports, events, and other administrative operations **Server path:** `/asana-utilities` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`asana_utilities_approve_access_request`](#asana_utilities_approve_access_request) | Approve an access request | | [`asana_utilities_create_access_request`](#asana_utilities_create_access_request) | Create an access request | | [`asana_utilities_create_attachment_for_object`](#asana_utilities_create_attachment_for_object) | Upload an attachment | | [`asana_utilities_create_batch_request`](#asana_utilities_create_batch_request) | Submit parallel requests | | [`asana_utilities_create_graph_export`](#asana_utilities_create_graph_export) | Initiate a graph export | | [`asana_utilities_create_organization_export`](#asana_utilities_create_organization_export) | Create an organization export request | | [`asana_utilities_create_resource_export`](#asana_utilities_create_resource_export) | Initiate a resource export | | [`asana_utilities_create_status_for_object`](#asana_utilities_create_status_for_object) | Create a status update | | [`asana_utilities_create_timesheet_approval_status`](#asana_utilities_create_timesheet_approval_status) | Create a timesheet approval status | | [`asana_utilities_create_webhook`](#asana_utilities_create_webhook) | Establish a webhook | | [`asana_utilities_delete_attachment`](#asana_utilities_delete_attachment) | Delete an attachment | | [`asana_utilities_delete_status`](#asana_utilities_delete_status) | Delete a status update | | [`asana_utilities_delete_webhook`](#asana_utilities_delete_webhook) | Delete a webhook | | [`asana_utilities_get_access_requests`](#asana_utilities_get_access_requests) | Get access requests | | [`asana_utilities_get_attachment`](#asana_utilities_get_attachment) | Get an attachment | | [`asana_utilities_get_attachments_for_object`](#asana_utilities_get_attachments_for_object) | Get attachments from an object | | [`asana_utilities_get_audit_log_events`](#asana_utilities_get_audit_log_events) | Get audit log events | | [`asana_utilities_get_events`](#asana_utilities_get_events) | Get events on a resource | | [`asana_utilities_get_job`](#asana_utilities_get_job) | Get a job by id | | [`asana_utilities_get_organization_export`](#asana_utilities_get_organization_export) | Get details on an org export request | | [`asana_utilities_get_status`](#asana_utilities_get_status) | Get a status update | | [`asana_utilities_get_statuses_for_object`](#asana_utilities_get_statuses_for_object) | Get status updates from an object | | [`asana_utilities_get_time_period`](#asana_utilities_get_time_period) | Get a time period | | [`asana_utilities_get_time_periods`](#asana_utilities_get_time_periods) | Get time periods | | [`asana_utilities_get_timesheet_approval_status`](#asana_utilities_get_timesheet_approval_status) | Get a timesheet approval status | | [`asana_utilities_get_timesheet_approval_statuses`](#asana_utilities_get_timesheet_approval_statuses) | Get multiple timesheet approval statuses | | [`asana_utilities_get_webhook`](#asana_utilities_get_webhook) | Get a webhook | | [`asana_utilities_get_webhooks`](#asana_utilities_get_webhooks) | Get multiple webhooks | | [`asana_utilities_reject_access_request`](#asana_utilities_reject_access_request) | Reject an access request | | [`asana_utilities_trigger_rule`](#asana_utilities_trigger_rule) | Trigger a rule | | [`asana_utilities_update_timesheet_approval_status`](#asana_utilities_update_timesheet_approval_status) | Update a timesheet approval status | | [`asana_utilities_update_webhook`](#asana_utilities_update_webhook) | Update a webhook | *** ## asana\_utilities\_approve\_access\_request Approve an access request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `access_request_gid` | string | Yes | — | Globally unique identifier for the access request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "access_request_gid": { "type": "string", "description": "Globally unique identifier for the access request." } }, "required": [ "PCID", "access_request_gid" ] } ``` *** ## asana\_utilities\_create\_access\_request Create an access request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `data` | object | No | — | A request to create shareable access for a user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "type": "object", "description": "A request to create shareable access for a user.", "properties": { "target": { "type": "string", "description": "The access requestable object that the user is requesting access to. This is the gid of the target. Supports projects and portfolios." }, "message": { "type": "string", "description": "The optional message to include with the access request. This can be used to provide context or additional information about the request." } }, "required": [ "target" ] } }, "required": [ "PCID" ] } ``` *** ## asana\_utilities\_create\_attachment\_for\_object Upload an attachment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `connect_to_app` | boolean | No | — | *Optional*. Only relevant for external attachments with a parent task. A boolean indicating whether the current app should be connected with the attachment for the purposes of showing an app components widget. Requires the app to have been added to a project the parent task is in. This property can only be set if an OAuth token is used to authenticate the request. Criteria for displaying app widget: 1. An OAuth token must be used to authenticate the request 2. The app needs to have its `widget_metadata_url` configured in the developer console 3. The task the attachment is being attached to must be in a project with the app installed | | `file` | string | No | — | Required for `asana` attachments. | | `name` | string | No | — | The name of the external resource being attached. Required for attachments of type `external`. | | `parent` | string | Yes | — | Required identifier of the parent task, project, or project\_brief, as a string. | | `resource_subtype` | string | No | — | The type of the attachment. Must be one of the given values. If not specified, a file attachment of type `asana` will be assumed. Note that if the value of `resource_subtype` is `external`, a `parent`, `name`, and `url` must also be provided. | | `url` | string | No | — | The URL of the external resource being attached. Required for attachments of type `external`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "connected_to_app", "created_at", "download_url", "host", "name", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "permanent_url", "resource_subtype", "size", "view_url" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "connect_to_app": { "type": "boolean", "description": "*Optional*. Only relevant for external attachments with a parent task. A boolean indicating whether the current app should be connected with the attachment for the purposes of showing an app components widget. Requires the app to have been added to a project the parent task is in. This property can only be set if an OAuth token is used to authenticate the request. Criteria for displaying app widget: 1. An OAuth token must be used to authenticate the request 2. The app needs to have its `widget_metadata_url` configured in the developer console 3. The task the attachment is being attached to must be in a project with the app installed" }, "file": { "type": "string", "description": "Required for `asana` attachments." }, "name": { "type": "string", "description": "The name of the external resource being attached. Required for attachments of type `external`." }, "parent": { "type": "string", "description": "Required identifier of the parent task, project, or project_brief, as a string." }, "resource_subtype": { "type": "string", "description": "The type of the attachment. Must be one of the given values. If not specified, a file attachment of type `asana` will be assumed. Note that if the value of `resource_subtype` is `external`, a `parent`, `name`, and `url` must also be provided.", "enum": [ "asana", "external" ] }, "url": { "type": "string", "description": "The URL of the external resource being attached. Required for attachments of type `external`." } }, "required": [ "PCID", "parent" ] } ``` *** ## asana\_utilities\_create\_batch\_request Submit parallel requests **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A request object for use in a batch request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "body", "headers", "status_code" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A request object for use in a batch request.", "properties": { "actions": { "type": "array", "items": { "type": "object" }, "description": "The actions value" } } } }, "required": [ "PCID" ] } ``` *** ## asana\_utilities\_create\_graph\_export Initiate a graph export **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `data` | object | No | — | A *graph\_export* request starts a job to export data starting from a parent object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "type": "object", "description": "A *graph_export* request starts a job to export data starting from a parent object.", "properties": { "parent": { "type": "string", "description": "Globally unique ID of the parent object: goal, project, portfolio, or team." } } } }, "required": [ "PCID" ] } ``` *** ## asana\_utilities\_create\_organization\_export Create an organization export request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | An *organization\_export* request starts a job to export the complete data of the given Organization. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "download_url", "organization", "organization.name", "state" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "An *organization_export* request starts a job to export the complete data of the given Organization.", "properties": { "organization": { "type": "string", "description": "Globally unique identifier for the workspace or organization." } } } }, "required": [ "PCID" ] } ``` *** ## asana\_utilities\_create\_resource\_export Initiate a resource export **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `data` | object | No | — | A *resource\_export* request starts a job to bulk export objects for one or more resources. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "type": "object", "description": "A *resource_export* request starts a job to bulk export objects for one or more resources.", "properties": { "workspace": { "type": "string", "description": "Gid of a workspace." }, "export_request_parameters": { "type": "array", "items": { "type": "object" }, "description": "An object containing the parameters for the export request. The keys of this object are the GIDs of the resources to be exported. The values are objects with additional parameters for each resource." } } } }, "required": [ "PCID" ] } ``` *** ## asana\_utilities\_create\_status\_for\_object Create a status update **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "author", "author.name", "created_at", "created_by", "created_by.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_text", "liked", "likes", "likes.user", "likes.user.name", "modified_at", "num_hearts", "num_likes", "parent", "parent.name", "reaction_summary", "reaction_summary.count", "reaction_summary.emoji_base", "reaction_summary.reacted", "reaction_summary.variant", "resource_subtype", "status_type", "text", "title" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "description": "The data value" } }, "required": [ "PCID" ] } ``` *** ## asana\_utilities\_create\_timesheet\_approval\_status Create a timesheet approval status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A request to create a timesheet approval status. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "approval_status", "created_at", "end_date", "start_date", "user", "user.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A request to create a timesheet approval status.", "properties": { "user": { "type": "string", "description": "Globally unique identifier for the user whose timesheet this is." }, "workspace": { "type": "string", "description": "Globally unique identifier for the workspace." }, "start_date": { "type": "string", "description": "The start date of the timesheet week (must be a Monday)." }, "end_date": { "type": "string", "description": "The end date of the timesheet week (must be the following Sunday)." } }, "required": [ "user", "workspace", "start_date", "end_date" ] } }, "required": [ "PCID" ] } ``` *** ## asana\_utilities\_create\_webhook Establish a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "active", "created_at", "delivery_retry_count", "failure_deletion_timestamp", "filters", "filters.action", "filters.fields", "filters.resource_subtype", "last_failure_at", "last_failure_content", "last_success_at", "next_attempt_after", "resource", "resource.name", "target" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "resource": { "type": "string", "description": "A resource ID to subscribe to. Many Asana resources are valid to create webhooks on, but higher-level resources require filters." }, "target": { "type": "string", "description": "The URL to receive the HTTP POST. The full URL will be used to deliver events from this webhook (including parameters) which allows encoding of application-specific state when the webhook is created." }, "filters": { "type": "array", "description": "An array of WebhookFilter objects to specify a whitelist of filters to apply to events from this webhook. If a webhook event passes any of the filters the event will be delivered; otherwise no event will be sent to the receiving server." } }, "required": [ "resource", "target" ] } }, "required": [ "PCID" ] } ``` *** ## asana\_utilities\_delete\_attachment Delete an attachment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attachment_gid` | string | Yes | — | Globally unique identifier for the attachment. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attachment_gid": { "type": "string", "description": "Globally unique identifier for the attachment." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "attachment_gid" ] } ``` *** ## asana\_utilities\_delete\_status Delete a status update **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `status_update_gid` | string | Yes | — | The status update to get. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "status_update_gid": { "type": "string", "description": "The status update to get." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "status_update_gid" ] } ``` *** ## asana\_utilities\_delete\_webhook Delete a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `webhook_gid` | string | Yes | — | Globally unique identifier for the webhook. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhook_gid": { "type": "string", "description": "Globally unique identifier for the webhook." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." } }, "required": [ "PCID", "webhook_gid" ] } ``` *** ## asana\_utilities\_get\_access\_requests Get access requests **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Globally unique identifier for the target object. | | `user` | string | No | — | A string identifying a user. This can either be the string "me", an email, or the gid of a user. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Globally unique identifier for the target object." }, "user": { "type": "string", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "approval_status", "message", "requester", "requester.name", "target" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "target" ] } ``` *** ## asana\_utilities\_get\_attachment Get an attachment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attachment_gid` | string | Yes | — | Globally unique identifier for the attachment. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attachment_gid": { "type": "string", "description": "Globally unique identifier for the attachment." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "connected_to_app", "created_at", "download_url", "host", "name", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "permanent_url", "resource_subtype", "size", "view_url" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "attachment_gid" ] } ``` *** ## asana\_utilities\_get\_attachments\_for\_object Get attachments from an object **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `parent` | string | Yes | — | Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "parent": { "type": "string", "description": "Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "connected_to_app", "created_at", "download_url", "host", "name", "offset", "parent", "parent.created_by", "parent.name", "parent.resource_subtype", "path", "permanent_url", "resource_subtype", "size", "uri", "view_url" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "parent" ] } ``` *** ## asana\_utilities\_get\_audit\_log\_events Get audit log events **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_gid` | string | Yes | — | Globally unique identifier for the workspace or organization. | | `start_at` | string | No | — | Filter to events created after this time (inclusive). | | `end_at` | string | No | — | Filter to events created before this time (exclusive). | | `event_type` | string | No | — | Filter to events of this type. Refer to the supported audit log events for a full list of values. | | `actor_type` | string | No | — | Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded. | | `actor_gid` | string | No | — | Filter to events triggered by the actor with this ID. | | `resource_gid` | string | No | — | Filter to events with this resource ID. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_gid": { "type": "string", "description": "Globally unique identifier for the workspace or organization." }, "start_at": { "type": "string", "description": "Filter to events created after this time (inclusive)." }, "end_at": { "type": "string", "description": "Filter to events created before this time (exclusive)." }, "event_type": { "type": "string", "description": "Filter to events of this type. Refer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values." }, "actor_type": { "type": "string", "description": "Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded.", "enum": [ "user", "asana", "asana_support", "anonymous", "external_administrator" ] }, "actor_gid": { "type": "string", "description": "Filter to events triggered by the actor with this ID." }, "resource_gid": { "type": "string", "description": "Filter to events with this resource ID." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" } }, "required": [ "PCID", "workspace_gid" ] } ``` *** ## asana\_utilities\_get\_events Get events on a resource **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `resource` | string | Yes | — | A resource ID to subscribe to. The resource can be a task, project, or goal. | | `sync` | string | No | — | A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.* | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "resource": { "type": "string", "description": "A resource ID to subscribe to. The resource can be a task, project, or goal." }, "sync": { "type": "string", "description": "A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.*" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "action", "change", "change.action", "change.added_value", "change.field", "change.new_value", "change.removed_value", "created_at", "parent", "parent.name", "resource", "resource.name", "type", "user", "user.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "resource" ] } ``` *** ## asana\_utilities\_get\_job Get a job by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `job_gid` | string | Yes | — | Globally unique identifier for the job. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "job_gid": { "type": "string", "description": "Globally unique identifier for the job." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "new_graph_export", "new_graph_export.completed_at", "new_graph_export.created_at", "new_graph_export.download_url", "new_portfolio", "new_portfolio.name", "new_project", "new_project.name", "new_project_template", "new_project_template.name", "new_resource_export", "new_resource_export.completed_at", "new_resource_export.created_at", "new_resource_export.download_url", "new_task", "new_task.created_by", "new_task.name", "new_task.resource_subtype", "resource_subtype", "status" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "job_gid" ] } ``` *** ## asana\_utilities\_get\_organization\_export Get details on an org export request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `organization_export_gid` | string | Yes | — | Globally unique identifier for the organization export. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_export_gid": { "type": "string", "description": "Globally unique identifier for the organization export." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "created_at", "download_url", "organization", "organization.name", "state" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "organization_export_gid" ] } ``` *** ## asana\_utilities\_get\_status Get a status update **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `status_update_gid` | string | Yes | — | The status update to get. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "status_update_gid": { "type": "string", "description": "The status update to get." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "author", "author.name", "created_at", "created_by", "created_by.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_text", "liked", "likes", "likes.user", "likes.user.name", "modified_at", "num_hearts", "num_likes", "parent", "parent.name", "reaction_summary", "reaction_summary.count", "reaction_summary.emoji_base", "reaction_summary.reacted", "reaction_summary.variant", "resource_subtype", "status_type", "text", "title" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "status_update_gid" ] } ``` *** ## asana\_utilities\_get\_statuses\_for\_object Get status updates from an object **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `parent` | string | Yes | — | Globally unique identifier for object to fetch statuses from. Must be a GID for a project, portfolio, or goal. | | `created_since` | string | No | — | Only return statuses that have been created since the given time. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "parent": { "type": "string", "description": "Globally unique identifier for object to fetch statuses from. Must be a GID for a project, portfolio, or goal." }, "created_since": { "type": "string", "description": "Only return statuses that have been created since the given time." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "author", "author.name", "created_at", "created_by", "created_by.name", "hearted", "hearts", "hearts.user", "hearts.user.name", "html_text", "liked", "likes", "likes.user", "likes.user.name", "modified_at", "num_hearts", "num_likes", "offset", "parent", "parent.name", "path", "reaction_summary", "reaction_summary.count", "reaction_summary.emoji_base", "reaction_summary.reacted", "reaction_summary.variant", "resource_subtype", "status_type", "text", "title", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "parent" ] } ``` *** ## asana\_utilities\_get\_time\_period Get a time period **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `time_period_gid` | string | Yes | — | Globally unique identifier for the time period. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "time_period_gid": { "type": "string", "description": "Globally unique identifier for the time period." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "display_name", "end_on", "parent", "parent.display_name", "parent.end_on", "parent.period", "parent.start_on", "period", "start_on" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "time_period_gid" ] } ``` *** ## asana\_utilities\_get\_time\_periods Get time periods **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `start_on` | string | No | — | ISO 8601 date string | | `end_on` | string | No | — | ISO 8601 date string | | `workspace` | string | Yes | — | Globally unique identifier for the workspace. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "start_on": { "type": "string", "description": "ISO 8601 date string" }, "end_on": { "type": "string", "description": "ISO 8601 date string" }, "workspace": { "type": "string", "description": "Globally unique identifier for the workspace." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "display_name", "end_on", "offset", "parent", "parent.display_name", "parent.end_on", "parent.period", "parent.start_on", "path", "period", "start_on", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace" ] } ``` *** ## asana\_utilities\_get\_timesheet\_approval\_status Get a timesheet approval status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `timesheet_approval_status_gid` | string | Yes | — | Globally unique identifier for the timesheet approval status. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "timesheet_approval_status_gid": { "type": "string", "description": "Globally unique identifier for the timesheet approval status." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "approval_status", "created_at", "end_date", "start_date", "user", "user.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "timesheet_approval_status_gid" ] } ``` *** ## asana\_utilities\_get\_timesheet\_approval\_statuses Get multiple timesheet approval statuses **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `workspace` | string | Yes | — | Globally unique identifier for the workspace. | | `user` | string | No | — | Globally unique identifier for the user to filter timesheet approval statuses by. | | `from_date` | string | No | — | The start date for filtering timesheet approval statuses. | | `to_date` | string | No | — | The end date for filtering timesheet approval statuses. | | `approval_statuses` | string | No | — | Filter by approval status. Can be one or more of draft, submitted, approved, or rejected. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "workspace": { "type": "string", "description": "Globally unique identifier for the workspace." }, "user": { "type": "string", "description": "Globally unique identifier for the user to filter timesheet approval statuses by." }, "from_date": { "type": "string", "description": "The start date for filtering timesheet approval statuses." }, "to_date": { "type": "string", "description": "The end date for filtering timesheet approval statuses." }, "approval_statuses": { "type": "string", "description": "Filter by approval status. Can be one or more of draft, submitted, approved, or rejected." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "approval_status", "created_at", "end_date", "offset", "path", "start_date", "uri", "user", "user.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace" ] } ``` *** ## asana\_utilities\_get\_webhook Get a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `webhook_gid` | string | Yes | — | Globally unique identifier for the webhook. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhook_gid": { "type": "string", "description": "Globally unique identifier for the webhook." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "active", "created_at", "delivery_retry_count", "failure_deletion_timestamp", "filters", "filters.action", "filters.fields", "filters.resource_subtype", "last_failure_at", "last_failure_content", "last_success_at", "next_attempt_after", "resource", "resource.name", "target" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "webhook_gid" ] } ``` *** ## asana\_utilities\_get\_webhooks Get multiple webhooks **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `limit` | integer | No | — | Results per page. The number of objects to return per page. The value must be between 1 and 100. | | `offset` | string | No | — | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | | `workspace` | string | Yes | — | The workspace to query for webhooks in. | | `resource` | string | No | — | Only return webhooks for the given resource. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "limit": { "type": "integer", "description": "Results per page. The number of objects to return per page. The value must be between 1 and 100." }, "offset": { "type": "string", "description": "Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, "workspace": { "type": "string", "description": "The workspace to query for webhooks in." }, "resource": { "type": "string", "description": "Only return webhooks for the given resource." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "active", "created_at", "delivery_retry_count", "failure_deletion_timestamp", "filters", "filters.action", "filters.fields", "filters.resource_subtype", "last_failure_at", "last_failure_content", "last_success_at", "next_attempt_after", "offset", "path", "resource", "resource.name", "target", "uri" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." } }, "required": [ "PCID", "workspace" ] } ``` *** ## asana\_utilities\_reject\_access\_request Reject an access request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `access_request_gid` | string | Yes | — | Globally unique identifier for the access request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "access_request_gid": { "type": "string", "description": "Globally unique identifier for the access request." } }, "required": [ "PCID", "access_request_gid" ] } ``` *** ## asana\_utilities\_trigger\_rule Trigger a rule **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `rule_trigger_gid` | string | Yes | — | The ID of the incoming web request trigger. This value is a path parameter that is automatically generated for the API endpoint. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "rule_trigger_gid": { "type": "string", "description": "The ID of the incoming web request trigger. This value is a path parameter that is automatically generated for the API endpoint." }, "data": { "type": "object", "description": "The data value", "properties": { "resource": { "type": "string", "description": "The ID of the resource. For the duration of the beta, this resource is always a task, and this task must exist in the project in which the rule is created." }, "action_data": { "type": "object", "description": "The dynamic keys and values of the request. These fields are intended to be used in the action for the rule associated with this trigger." } }, "required": [ "resource", "action_data" ] } }, "required": [ "PCID", "rule_trigger_gid" ] } ``` *** ## asana\_utilities\_update\_timesheet\_approval\_status Update a timesheet approval status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `timesheet_approval_status_gid` | string | Yes | — | Globally unique identifier for the timesheet approval status. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | A request to update a timesheet approval status. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "timesheet_approval_status_gid": { "type": "string", "description": "Globally unique identifier for the timesheet approval status." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "approval_status", "created_at", "end_date", "start_date", "user", "user.name", "workspace", "workspace.name" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "A request to update a timesheet approval status.", "properties": { "approval_status": { "type": "string", "description": "The desired approval status to transition to. Valid transitions depend on the current status of the timesheet approval status.", "enum": [ "submitted", "draft", "approved", "rejected" ] }, "message": { "type": "string", "description": "Optional message to include with the transition (e.g., reason for approval or rejection)." } }, "required": [ "approval_status" ] } }, "required": [ "PCID", "timesheet_approval_status_gid" ] } ``` *** ## asana\_utilities\_update\_webhook Update a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `webhook_gid` | string | Yes | — | Globally unique identifier for the webhook. | | `opt_pretty` | boolean | No | — | Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. | | `opt_fields` | string\[] | No | — | This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | | `data` | object | No | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhook_gid": { "type": "string", "description": "Globally unique identifier for the webhook." }, "opt_pretty": { "type": "boolean", "description": "Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging." }, "opt_fields": { "type": "array", "items": { "type": "string", "enum": [ "active", "created_at", "delivery_retry_count", "failure_deletion_timestamp", "filters", "filters.action", "filters.fields", "filters.resource_subtype", "last_failure_at", "last_failure_content", "last_success_at", "next_attempt_after", "resource", "resource.name", "target" ] }, "description": "This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include." }, "data": { "type": "object", "description": "The data value", "properties": { "filters": { "type": "array", "description": "An array of WebhookFilter objects to specify a whitelist of filters to apply to events from this webhook. If a webhook event passes any of the filters the event will be delivered; otherwise no event will be sent to the receiving server." } } } }, "required": [ "PCID", "webhook_gid" ] } ``` # async-interview Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/async-interview Async Interview API **Server path:** `/async-interview` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`async_interview_create_job`](#async_interview_create_job) | Create a job | | [`async_interview_delete_job`](#async_interview_delete_job) | Delete a job | | [`async_interview_get_team_info`](#async_interview_get_team_info) | Get current team info | | [`async_interview_list_interviews`](#async_interview_list_interviews) | List interviews | | [`async_interview_list_jobs`](#async_interview_list_jobs) | List jobs | *** ## async\_interview\_create\_job Create a job **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `title` | string | Yes | — | Title of the job position | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "title": { "type": "string", "description": "Title of the job position" } }, "required": [ "PCID", "title" ] } ``` *** ## async\_interview\_delete\_job Delete a job **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The ID of the job to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the job to delete" } }, "required": [ "PCID", "id" ] } ``` *** ## async\_interview\_get\_team\_info Get current team info ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## async\_interview\_list\_interviews List interviews **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `job_id` | integer | No | — | Filter interviews by job ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "job_id": { "type": "integer", "description": "Filter interviews by job ID" } }, "required": [ "PCID" ] } ``` *** ## async\_interview\_list\_jobs List jobs ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` # attio Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/attio Attio CRM **Server path:** `/attio` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`attio_create_comments`](#attio_create_comments) | Create a comment | | [`attio_create_files`](#attio_create_files) | Create a folder | | [`attio_create_lists`](#attio_create_lists) | Create a list | | [`attio_create_lists_list_entries`](#attio_create_lists_list_entries) | Create an entry (add record to list) | | [`attio_create_meetings`](#attio_create_meetings) | Find or create a meeting | | [`attio_create_meetings_meeting_id_call_recordings`](#attio_create_meetings_meeting_id_call_recordings) | Create call recording | | [`attio_create_notes`](#attio_create_notes) | Create a note | | [`attio_create_objects`](#attio_create_objects) | Create an object | | [`attio_create_objects_object_records`](#attio_create_objects_object_records) | Create a record | | [`attio_create_target_identifier_attributes`](#attio_create_target_identifier_attributes) | Create an attribute | | [`attio_create_target_identifier_attributes_attribute_options`](#attio_create_target_identifier_attributes_attribute_options) | Create a select option | | [`attio_create_target_identifier_attributes_attribute_statuses`](#attio_create_target_identifier_attributes_attribute_statuses) | Create a status | | [`attio_create_tasks`](#attio_create_tasks) | Create a task | | [`attio_create_webhooks`](#attio_create_webhooks) | Create a webhook | | [`attio_delete_comments_comment_id`](#attio_delete_comments_comment_id) | Delete a comment | | [`attio_delete_files_file_id`](#attio_delete_files_file_id) | Delete a file | | [`attio_delete_lists_list_entries_entry_id`](#attio_delete_lists_list_entries_entry_id) | Delete a list entry | | [`attio_delete_meetings_meeting_id_call_recordings_call_recording_id`](#attio_delete_meetings_meeting_id_call_recordings_call_recording_id) | Delete call recording | | [`attio_delete_notes_note_id`](#attio_delete_notes_note_id) | Delete a note | | [`attio_delete_objects_object_records_record_id`](#attio_delete_objects_object_records_record_id) | Delete a record | | [`attio_delete_tasks_task_id`](#attio_delete_tasks_task_id) | Delete a task | | [`attio_delete_webhooks_webhook_id`](#attio_delete_webhooks_webhook_id) | Delete a webhook | | [`attio_get_comments_comment_id`](#attio_get_comments_comment_id) | Get a comment | | [`attio_get_files_file_id`](#attio_get_files_file_id) | Get a file | | [`attio_get_files_file_id_download`](#attio_get_files_file_id_download) | Download a file | | [`attio_get_lists_list`](#attio_get_lists_list) | Get a list | | [`attio_get_lists_list_entries_entry_id`](#attio_get_lists_list_entries_entry_id) | Get a list entry | | [`attio_get_meetings_meeting_id`](#attio_get_meetings_meeting_id) | Get a meeting | | [`attio_get_meetings_meeting_id_call_recordings_call_recording_id`](#attio_get_meetings_meeting_id_call_recordings_call_recording_id) | Get call recording | | [`attio_get_meetings_meeting_id_call_recordings_call_recording_id_transcript`](#attio_get_meetings_meeting_id_call_recordings_call_recording_id_transcript) | Get call transcript | | [`attio_get_notes_note_id`](#attio_get_notes_note_id) | Get a note | | [`attio_get_objects_object`](#attio_get_objects_object) | Get an object | | [`attio_get_objects_object_records_record_id`](#attio_get_objects_object_records_record_id) | Get a record | | [`attio_get_self`](#attio_get_self) | Identify | | [`attio_get_target_identifier_attributes_attribute`](#attio_get_target_identifier_attributes_attribute) | Get an attribute | | [`attio_get_tasks_task_id`](#attio_get_tasks_task_id) | Get a task | | [`attio_get_threads_thread_id`](#attio_get_threads_thread_id) | Get a thread | | [`attio_get_webhooks_webhook_id`](#attio_get_webhooks_webhook_id) | Get a webhook | | [`attio_get_workspace_members_workspace_member_id`](#attio_get_workspace_members_workspace_member_id) | Get a workspace member | | [`attio_list_files`](#attio_list_files) | List files | | [`attio_list_lists`](#attio_list_lists) | List all lists | | [`attio_list_lists_list_entries_entry_id_attributes_attribute_values`](#attio_list_lists_list_entries_entry_id_attributes_attribute_values) | List attribute values for a list entry | | [`attio_list_lists_list_views`](#attio_list_lists_list_views) | List views for list | | [`attio_list_meetings`](#attio_list_meetings) | List meetings | | [`attio_list_meetings_meeting_id_call_recordings`](#attio_list_meetings_meeting_id_call_recordings) | List call recordings | | [`attio_list_notes`](#attio_list_notes) | List notes | | [`attio_list_objects`](#attio_list_objects) | List objects | | [`attio_list_objects_object_records_record_id_attributes_attribute_values`](#attio_list_objects_object_records_record_id_attributes_attribute_values) | List record attribute values | | [`attio_list_objects_object_records_record_id_entries`](#attio_list_objects_object_records_record_id_entries) | List record entries | | [`attio_list_objects_object_views`](#attio_list_objects_object_views) | List views for object | | [`attio_list_target_identifier_attributes`](#attio_list_target_identifier_attributes) | List attributes | | [`attio_list_target_identifier_attributes_attribute_options`](#attio_list_target_identifier_attributes_attribute_options) | List select options | | [`attio_list_target_identifier_attributes_attribute_statuses`](#attio_list_target_identifier_attributes_attribute_statuses) | List statuses | | [`attio_list_tasks`](#attio_list_tasks) | List tasks | | [`attio_list_threads`](#attio_list_threads) | List threads | | [`attio_list_webhooks`](#attio_list_webhooks) | List webhooks | | [`attio_list_workspace_members`](#attio_list_workspace_members) | List workspace members | | [`attio_query_lists_list_entries_query`](#attio_query_lists_list_entries_query) | List entries | | [`attio_query_objects_object_records_query`](#attio_query_objects_object_records_query) | List records | | [`attio_search_objects_records_search`](#attio_search_objects_records_search) | Search records | | [`attio_update_lists_list`](#attio_update_lists_list) | Update a list | | [`attio_update_lists_list_entries_entry_id`](#attio_update_lists_list_entries_entry_id) | Update a list entry (append multiselect values) | | [`attio_update_objects_object`](#attio_update_objects_object) | Update an object | | [`attio_update_objects_object_records_record_id`](#attio_update_objects_object_records_record_id) | Update a record (append multiselect values) | | [`attio_update_target_identifier_attributes_attribute`](#attio_update_target_identifier_attributes_attribute) | Update an attribute | | [`attio_update_target_identifier_attributes_attribute_options_option`](#attio_update_target_identifier_attributes_attribute_options_option) | Update a select option | | [`attio_update_target_identifier_attributes_attribute_statuses_status`](#attio_update_target_identifier_attributes_attribute_statuses_status) | Update a status | | [`attio_update_tasks_task_id`](#attio_update_tasks_task_id) | Update a task | | [`attio_update_webhooks_webhook_id`](#attio_update_webhooks_webhook_id) | Update a webhook | | [`attio_upsert_lists_list_entries`](#attio_upsert_lists_list_entries) | Upsert a list entry by parent | | [`attio_upsert_lists_list_entries_entry_id`](#attio_upsert_lists_list_entries_entry_id) | Update a list entry (overwrite multiselect values) | | [`attio_upsert_objects_object_records`](#attio_upsert_objects_object_records) | Upsert a record | | [`attio_upsert_objects_object_records_record_id`](#attio_upsert_objects_object_records_record_id) | Update a record (overwrite multiselect values) | *** ## attio\_create\_comments Create a comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "description": "The data value" } }, "required": [ "PCID", "data" ] } ``` *** ## attio\_create\_files Create a folder **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## attio\_create\_lists Create a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "type": "object", "description": "The data value", "properties": { "name": { "type": "string", "description": "The human-readable name of the list." }, "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the list through API calls. Should be formatted in snake case." }, "parent_object": { "type": "string", "description": "A UUID or slug to identify the allowed object type for records added to this list." }, "workspace_access": { "type": "string", "description": "The level of access granted to all members of the workspace for this list. Pass `null` to keep the list private and only grant access to specific workspace members.", "enum": [ "full-access", "read-and-write", "read-only" ] }, "workspace_member_access": { "type": "array", "items": { "type": "object" }, "description": "The level of access granted to specific workspace members for this list. Pass an empty array to grant access to no workspace members." } }, "required": [ "name", "api_slug", "parent_object", "workspace_access", "workspace_member_access" ] } }, "required": [ "PCID", "data" ] } ``` *** ## attio\_create\_lists\_list\_entries Create an entry (add record to list) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | The UUID or slug identifying the list that the created list entry should belong to. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "The UUID or slug identifying the list that the created list entry should belong to." }, "data": { "type": "object", "description": "The data value", "properties": { "parent_record_id": { "type": "string", "description": "A UUID identifying the record you want to add to the list. The record will become the 'parent' of the created list entry." }, "parent_object": { "type": "string", "description": "A UUID or slug identifying the object that the added parent record belongs to." }, "entry_values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types)." } }, "required": [ "parent_record_id", "parent_object", "entry_values" ] } }, "required": [ "PCID", "list", "data" ] } ``` *** ## attio\_create\_meetings Find or create a meeting **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "The title of the meeting." }, "description": { "type": "string", "description": "The description of the meeting." }, "start": { "description": "When the meeting starts. Use a datetime and optional timezone for non-all day meetings, or a date for all day meetings." }, "end": { "description": "When the meeting ends. Use a datetime and optional timezone for non-all day meetings, or a date for all day meetings." }, "is_all_day": { "type": "boolean", "description": "Whether or not the meeting is an all day event. All day events may span multiple days. When true, start and end must use date format. When false, start and end must use datetime with timezone format." }, "participants": { "type": "array", "items": { "type": "object" }, "description": "The participants value" }, "linked_records": { "type": "array", "items": { "type": "object" }, "description": "A list of records to link to the meeting. Each record is specified by its object (slug or UUID) and record ID (UUID). Attio will automatically link the meeting participants' companies to the meeting; this behavior is asynchronous." }, "external_ref": { "description": "A consistent external reference used to match and de-duplicate meetings. Can be either a plain string (for external system IDs) or an object with `ical_uid` and `provider`. If you are writing data into Attio which is based upon calendar events that you have synced from a Google or Microsoft calendar, you must use the iCal format to avoid creating duplicate meetings inside Attio." } }, "required": [ "title", "description", "start", "end", "is_all_day", "participants", "external_ref" ] } }, "required": [ "PCID", "data" ] } ``` *** ## attio\_create\_meetings\_meeting\_id\_call\_recordings Create call recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `meeting_id` | string | Yes | — | The ID of the meeting this recording belongs to. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "meeting_id": { "type": "string", "description": "The ID of the meeting this recording belongs to." }, "data": { "type": "object", "description": "The data value", "properties": { "video_url": { "type": "string", "description": "A publicly accessible URL to a video file of the call recording. Attio will download the video from this URL asynchronously. **Requirements:** - **Protocol:** The URL must use the `https` protocol. - **File type:** The file must be a `.mp4` file. - **File size:** The file must not exceed 500MB in size. - **Accessibility:** For the request to be accepted, the URL must be publicly accessible. Attio will make a `HEAD` request to the URL to verify its accessibility and retrieve file metadata. The response to this request must include a `Content-Length` header." } }, "required": [ "video_url" ] } }, "required": [ "PCID", "meeting_id", "data" ] } ``` *** ## attio\_create\_notes Create a note **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "type": "object", "description": "The data value", "properties": { "parent_object": { "type": "string", "description": "The ID or slug of the parent object the note belongs to." }, "parent_record_id": { "type": "string", "description": "The ID of the parent record the note belongs to." }, "title": { "type": "string", "description": "The note title. The title is plaintext only and has no formatting." }, "format": { "type": "string", "description": "Specify the format for the note's content. Choose from: - `plaintext`: Standard text format where `\\n` signifies a new line. - `markdown`: Enables rich text formatting using a subset of Markdown syntax: - **Headings**: Levels 1-3 (`#`, `##`, `###`). - **Lists**: Unordered (`-`, `*`, `+`) and ordered (`1.`, `2.`). - **Text styles**: Bold (`**bold**` or `__bold__`), italic (`*italic*` or `_italic_`), strikethrough (`~~strikethrough~~`), and highlight (`==highlighted==`). - **Links**: Standard Markdown links (`[link text](https://example.com)`). *Note: While the Attio interface supports image embeds, they cannot currently be added or retrieved via the API's markdown format.*", "enum": [ "plaintext", "markdown" ] }, "content": { "type": "string", "description": "The main content of the note, formatted according to the value provided in the `format` field. Use `\\n` for line breaks in `plaintext`. For `markdown`, utilize the supported syntax elements to structure and style your note." }, "created_at": { "type": "string", "description": "`created_at` will default to the current time. However, if you wish to backdate a note for migration or other purposes, you can override with a custom `created_at` value. Note that dates before 1970 or in the future are not allowed." }, "meeting_id": { "type": "string", "description": "An optional ID to associate this note with a meeting. If provided, the meeting must exist. Use `null` to explicitly set no meeting association." } }, "required": [ "parent_object", "parent_record_id", "title", "format", "content" ] } }, "required": [ "PCID", "data" ] } ``` *** ## attio\_create\_objects Create an object **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "type": "object", "description": "The data value", "properties": { "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the object through URLs and API calls. Should be formatted in snake case." }, "singular_noun": { "type": "string", "description": "The singular form of the object's name." }, "plural_noun": { "type": "string", "description": "The plural form of the object's name." } }, "required": [ "api_slug", "singular_noun", "plural_noun" ] } }, "required": [ "PCID", "data" ] } ``` *** ## attio\_create\_objects\_object\_records Create a record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | The UUID or slug identifying the object the created record should belong to. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "The UUID or slug identifying the object the created record should belong to." }, "data": { "type": "object", "description": "The data value", "properties": { "values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types)." } }, "required": [ "values" ] } }, "required": [ "PCID", "object", "data" ] } ``` *** ## attio\_create\_target\_identifier\_attributes Create an attribute **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Whether the attribute is to be created on an object or a list. | | `identifier` | string | Yes | — | A UUID or slug to identify the object or list the attribute belongs to. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Whether the attribute is to be created on an object or a list.", "enum": [ "objects", "lists" ] }, "identifier": { "type": "string", "description": "A UUID or slug to identify the object or list the attribute belongs to." }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "The name of the attribute. The title will be visible across Attio's UI." }, "description": { "type": "string", "description": "A text description for the attribute." }, "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the attribute through URLs and API calls. Formatted in snake case." }, "type": { "type": "string", "description": "The type of the attribute. This value affects the possible `config` values.", "enum": [ "text", "number", "checkbox", "currency", "date", "timestamp", "rating", "status", "select", "record-reference", "actor-reference", "location", "domain", "email-address", "phone-number" ] }, "is_required": { "type": "boolean", "description": "When `is_required` is `true`, new records/entries must have a value for this attribute. If `false`, values may be `null`. This value does not affect existing data and you do not need to backfill `null` values if changing `is_required` from `false` to `true`." }, "is_unique": { "type": "boolean", "description": "Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data." }, "is_multiselect": { "type": "boolean", "description": "Whether or not this attribute can have multiple values. Multiselect is only available on some value types." }, "default_value": { "description": "The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute. Default values are not currently supported on people or company objects." }, "relationship": { "type": "object", "description": "Optional relationship configuration. When provided, creates a bidirectional relationship between two objects. Can only be used with attributes of type \"record-reference\". If `config.record_reference.allowed_objects` is also provided, it must contain only the relationship object." }, "config": { "type": "object", "description": "The config value" } }, "required": [ "title", "description", "api_slug", "type", "is_required", "is_unique", "is_multiselect", "config" ] } }, "required": [ "PCID", "target", "identifier", "data" ] } ``` *** ## attio\_create\_target\_identifier\_attributes\_attribute\_options Create a select option **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Whether the attribute is on an object or a list. | | `identifier` | string | Yes | — | A UUID or slug to identify the object or list the select attribute belongs to. | | `attribute` | string | Yes | — | A UUID or slug to identify the attribute to create a select option on. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Whether the attribute is on an object or a list.", "enum": [ "objects", "lists" ] }, "identifier": { "type": "string", "description": "A UUID or slug to identify the object or list the select attribute belongs to." }, "attribute": { "type": "string", "description": "A UUID or slug to identify the attribute to create a select option on." }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "The Title of the select option" } }, "required": [ "title" ] } }, "required": [ "PCID", "target", "identifier", "attribute", "data" ] } ``` *** ## attio\_create\_target\_identifier\_attributes\_attribute\_statuses Create a status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Whether the attribute is on an object or a list. | | `identifier` | string | Yes | — | A UUID or slug to identify the object or list the status attribute belongs to. | | `attribute` | string | Yes | — | A UUID or slug to identify the attribute the status will belong to. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Whether the attribute is on an object or a list.", "enum": [ "lists", "objects" ] }, "identifier": { "type": "string", "description": "A UUID or slug to identify the object or list the status attribute belongs to." }, "attribute": { "type": "string", "description": "A UUID or slug to identify the attribute the status will belong to." }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "The Title of the status" }, "celebration_enabled": { "type": "boolean", "description": "Whether arriving at this status triggers a celebration effect" }, "target_time_in_status": { "type": "string", "description": "Target time for a record to spend in given status expressed as a ISO-8601 duration string" } }, "required": [ "title" ] } }, "required": [ "PCID", "target", "identifier", "attribute", "data" ] } ``` *** ## attio\_create\_tasks Create a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "type": "object", "description": "The data value", "properties": { "content": { "type": "string", "description": "The text content of the task, in the format specified by the `format` property. A max length of 2000 characters is enforced." }, "format": { "type": "string", "description": "The format of the task content to be created. Rich text formatting, links and @references are not supported.", "enum": [ "plaintext" ] }, "deadline_at": { "type": "string", "description": "The deadline of the task, in ISO 8601 format." }, "is_completed": { "type": "boolean", "description": "Whether the task has been completed." }, "linked_records": { "type": "array", "description": "Records linked to the task. Records can be linked by domain (for companies), email address (for people), record ID (for all objects) or by a unique matching attribute (for all objects). Creating record links within task content text is not possible via the API at present." }, "assignees": { "type": "array", "description": "Workspace members assigned to this task." } }, "required": [ "content", "format", "deadline_at", "is_completed", "linked_records", "assignees" ] } }, "required": [ "PCID", "data" ] } ``` *** ## attio\_create\_webhooks Create a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "type": "object", "description": "The data value", "properties": { "target_url": { "type": "string", "description": "URL where the webhook events will be delivered to." }, "subscriptions": { "type": "array", "items": { "type": "object" }, "description": "One or more events the webhook is subscribed to." } }, "required": [ "target_url", "subscriptions" ] } }, "required": [ "PCID", "data" ] } ``` *** ## attio\_delete\_comments\_comment\_id Delete a comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `comment_id` | string | Yes | — | The ID of the comment to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment_id": { "type": "string", "description": "The ID of the comment to delete." } }, "required": [ "PCID", "comment_id" ] } ``` *** ## attio\_delete\_files\_file\_id Delete a file **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `file_id` | string | Yes | — | A UUID which identifies the file to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file_id": { "type": "string", "description": "A UUID which identifies the file to delete." } }, "required": [ "PCID", "file_id" ] } ``` *** ## attio\_delete\_lists\_list\_entries\_entry\_id Delete a list entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | A UUID or slug identifying the list the entry is in. | | `entry_id` | string | Yes | — | A UUID identifying the entry to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "A UUID or slug identifying the list the entry is in." }, "entry_id": { "type": "string", "description": "A UUID identifying the entry to delete." } }, "required": [ "PCID", "list", "entry_id" ] } ``` *** ## attio\_delete\_meetings\_meeting\_id\_call\_recordings\_call\_recording\_id Delete call recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `meeting_id` | string | Yes | — | The ID of the meeting this call recording belongs to. | | `call_recording_id` | string | Yes | — | The ID of the call recording to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "meeting_id": { "type": "string", "description": "The ID of the meeting this call recording belongs to." }, "call_recording_id": { "type": "string", "description": "The ID of the call recording to delete." } }, "required": [ "PCID", "meeting_id", "call_recording_id" ] } ``` *** ## attio\_delete\_notes\_note\_id Delete a note **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `note_id` | string | Yes | — | A UUID which identifies the note to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "note_id": { "type": "string", "description": "A UUID which identifies the note to delete." } }, "required": [ "PCID", "note_id" ] } ``` *** ## attio\_delete\_objects\_object\_records\_record\_id Delete a record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | The UUID or slug of the object the record belongs to. | | `record_id` | string | Yes | — | The UUID of the record to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "The UUID or slug of the object the record belongs to." }, "record_id": { "type": "string", "description": "The UUID of the record to delete." } }, "required": [ "PCID", "object", "record_id" ] } ``` *** ## attio\_delete\_tasks\_task\_id Delete a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_id` | string | Yes | — | The ID of the task to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_id": { "type": "string", "description": "The ID of the task to delete." } }, "required": [ "PCID", "task_id" ] } ``` *** ## attio\_delete\_webhooks\_webhook\_id Delete a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `webhook_id` | string | Yes | — | A UUID identifying the webhook to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhook_id": { "type": "string", "description": "A UUID identifying the webhook to delete." } }, "required": [ "PCID", "webhook_id" ] } ``` *** ## attio\_get\_comments\_comment\_id Get a comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `comment_id` | string | Yes | — | A UUID which identifies the comment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment_id": { "type": "string", "description": "A UUID which identifies the comment." } }, "required": [ "PCID", "comment_id" ] } ``` *** ## attio\_get\_files\_file\_id Get a file **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `file_id` | string | Yes | — | A UUID which identifies the file entry. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file_id": { "type": "string", "description": "A UUID which identifies the file entry." } }, "required": [ "PCID", "file_id" ] } ``` *** ## attio\_get\_files\_file\_id\_download Download a file **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `file_id` | string | Yes | — | File Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file_id": { "type": "string", "description": "File Id" } }, "required": [ "PCID", "file_id" ] } ``` *** ## attio\_get\_lists\_list Get a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | A UUID or slug to identify the list. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "A UUID or slug to identify the list." } }, "required": [ "PCID", "list" ] } ``` *** ## attio\_get\_lists\_list\_entries\_entry\_id Get a list entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | A UUID or slug identifying the list the entry is in. | | `entry_id` | string | Yes | — | A UUID identifying the entry. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "A UUID or slug identifying the list the entry is in." }, "entry_id": { "type": "string", "description": "A UUID identifying the entry." } }, "required": [ "PCID", "list", "entry_id" ] } ``` *** ## attio\_get\_meetings\_meeting\_id Get a meeting **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `meeting_id` | string | Yes | — | A UUID which identifies the meeting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "meeting_id": { "type": "string", "description": "A UUID which identifies the meeting." } }, "required": [ "PCID", "meeting_id" ] } ``` *** ## attio\_get\_meetings\_meeting\_id\_call\_recordings\_call\_recording\_id Get call recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `meeting_id` | string | Yes | — | The ID of the meeting this recording belongs to. | | `call_recording_id` | string | Yes | — | The ID of the call recording to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "meeting_id": { "type": "string", "description": "The ID of the meeting this recording belongs to." }, "call_recording_id": { "type": "string", "description": "The ID of the call recording to retrieve." } }, "required": [ "PCID", "meeting_id", "call_recording_id" ] } ``` *** ## attio\_get\_meetings\_meeting\_id\_call\_recordings\_call\_recording\_id\_transcript Get call transcript **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `meeting_id` | string | Yes | — | The ID of the meeting. | | `call_recording_id` | string | Yes | — | The ID of the call recording to get the transcript for. | | `cursor` | string | No | — | A cursor for pagination through transcript segments. Use the `next_cursor` from the previous response to get the next page of speech segments within this transcript. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "meeting_id": { "type": "string", "description": "The ID of the meeting." }, "call_recording_id": { "type": "string", "description": "The ID of the call recording to get the transcript for." }, "cursor": { "type": "string", "description": "A cursor for pagination through transcript segments. Use the `next_cursor` from the previous response to get the next page of speech segments within this transcript." } }, "required": [ "PCID", "meeting_id", "call_recording_id" ] } ``` *** ## attio\_get\_notes\_note\_id Get a note **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `note_id` | string | Yes | — | A UUID which identifies the note. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "note_id": { "type": "string", "description": "A UUID which identifies the note." } }, "required": [ "PCID", "note_id" ] } ``` *** ## attio\_get\_objects\_object Get an object **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | A UUID or slug to identify the object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "A UUID or slug to identify the object." } }, "required": [ "PCID", "object" ] } ``` *** ## attio\_get\_objects\_object\_records\_record\_id Get a record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | A UUID or slug identifying the object that the record belongs to. | | `record_id` | string | Yes | — | A UUID identifying the record. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "A UUID or slug identifying the object that the record belongs to." }, "record_id": { "type": "string", "description": "A UUID identifying the record." } }, "required": [ "PCID", "object", "record_id" ] } ``` *** ## attio\_get\_self Identify ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## attio\_get\_target\_identifier\_attributes\_attribute Get an attribute **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Whether the attribute is on an object or a list. | | `identifier` | string | Yes | — | A UUID or slug to identify the object or list the attribute belongs to. | | `attribute` | string | Yes | — | A UUID or slug to identify the attribute. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Whether the attribute is on an object or a list.", "enum": [ "objects", "lists" ] }, "identifier": { "type": "string", "description": "A UUID or slug to identify the object or list the attribute belongs to." }, "attribute": { "type": "string", "description": "A UUID or slug to identify the attribute." } }, "required": [ "PCID", "target", "identifier", "attribute" ] } ``` *** ## attio\_get\_tasks\_task\_id Get a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_id` | string | Yes | — | The ID of the task. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_id": { "type": "string", "description": "The ID of the task." } }, "required": [ "PCID", "task_id" ] } ``` *** ## attio\_get\_threads\_thread\_id Get a thread **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `thread_id` | string | Yes | — | A UUID which identifies the thread. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "thread_id": { "type": "string", "description": "A UUID which identifies the thread." } }, "required": [ "PCID", "thread_id" ] } ``` *** ## attio\_get\_webhooks\_webhook\_id Get a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `webhook_id` | string | Yes | — | A UUID which identifies the webhook. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhook_id": { "type": "string", "description": "A UUID which identifies the webhook." } }, "required": [ "PCID", "webhook_id" ] } ``` *** ## attio\_get\_workspace\_members\_workspace\_member\_id Get a workspace member **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace_member_id` | string | Yes | — | A UUID to identify the workspace member. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace_member_id": { "type": "string", "description": "A UUID to identify the workspace member." } }, "required": [ "PCID", "workspace_member_id" ] } ``` *** ## attio\_list\_files List files **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | The object slug or ID. | | `record_id` | string | Yes | — | Used to filter files to only those on a specific record. | | `storage_provider` | string | No | — | Filter results by storage provider. | | `parent_folder_id` | string | No | — | Filter by parent folder ID. Each file entry has provided optioanl parent\_folder\_id that can be used to filter results by folder. When omitted, entries at all nesting levels are returned. | | `limit` | integer | No | — | The maximum number of files to return. Must be between 1 and 200. Defaults to 50. | | `cursor` | string | No | — | A pagination cursor used to fetch the next page of files. Responses with more files will include a cursor for you to use here. If not provided, the first page will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "The object slug or ID." }, "record_id": { "type": "string", "description": "Used to filter files to only those on a specific record." }, "storage_provider": { "type": "string", "description": "Filter results by storage provider.", "enum": [ "attio", "dropbox", "box", "google-drive", "microsoft-onedrive" ] }, "parent_folder_id": { "type": "string", "description": "Filter by parent folder ID. Each file entry has provided optioanl parent_folder_id that can be used to filter results by folder. When omitted, entries at all nesting levels are returned." }, "limit": { "type": "integer", "description": "The maximum number of files to return. Must be between 1 and 200. Defaults to 50." }, "cursor": { "type": "string", "description": "A pagination cursor used to fetch the next page of files. Responses with more files will include a cursor for you to use here. If not provided, the first page will be returned." } }, "required": [ "PCID", "object", "record_id" ] } ``` *** ## attio\_list\_lists List all lists ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## attio\_list\_lists\_list\_entries\_entry\_id\_attributes\_attribute\_values List attribute values for a list entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | A UUID or slug identifying the list the entry is in. | | `entry_id` | string | Yes | — | A UUID identifying the entry. | | `attribute` | string | Yes | — | A UUID or slug to identify the attribute you want to query values on. | | `show_historic` | boolean | No | — | If `true`, the endpoint will return all historic values for the attribute. If `false`, the endpoint will only return the currently active value(s). Defaults to `false`. Can only be set to `true` for attributes which support historic data; the endpoint will throw if set to `true` for non-historic attributes. | | `limit` | integer | No | — | The maximum number of results to return. See the full guide to pagination here. | | `offset` | integer | No | — | The number of results to skip over before returning. See the full guide to pagination here. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "A UUID or slug identifying the list the entry is in." }, "entry_id": { "type": "string", "description": "A UUID identifying the entry." }, "attribute": { "type": "string", "description": "A UUID or slug to identify the attribute you want to query values on." }, "show_historic": { "type": "boolean", "description": "If `true`, the endpoint will return all historic values for the attribute. If `false`, the endpoint will only return the currently active value(s). Defaults to `false`. Can only be set to `true` for attributes which support historic data; the endpoint will throw if set to `true` for non-historic attributes." }, "limit": { "type": "integer", "description": "The maximum number of results to return. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "offset": { "type": "integer", "description": "The number of results to skip over before returning. See the [full guide to pagination here](/rest-api/guides/pagination)." } }, "required": [ "PCID", "list", "entry_id", "attribute" ] } ``` *** ## attio\_list\_lists\_list\_views List views for list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | A UUID or slug to identify the list. | | `show_archived` | boolean | No | — | `true` to include archived views. See our archiving guide for more information on archiving. | | `limit` | integer | No | — | The maximum number of views to return. Must be between 1 and 1000. Defaults to 500. | | `cursor` | string | No | — | A pagination cursor from a previous response's `pagination.next_cursor`. Omit for the first page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "A UUID or slug to identify the list." }, "show_archived": { "type": "boolean", "description": "`true` to include archived views. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving." }, "limit": { "type": "integer", "description": "The maximum number of views to return. Must be between 1 and 1000. Defaults to 500." }, "cursor": { "type": "string", "description": "A pagination cursor from a previous response's `pagination.next_cursor`. Omit for the first page." } }, "required": [ "PCID", "list" ] } ``` *** ## attio\_list\_meetings List meetings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | The maximum number of meetings to return. Must be between 1 and 200. Defaults to 50. | | `cursor` | string | No | — | A pagination cursor used to fetch the next page of meetings. Responses with more meetings will include a cursor for you to use here. If not provided, the first page will be returned. | | `linked_object` | string | No | — | The object to filter meetings by. Must be a valid object slug or ID. If provided, linked\_record\_id must also be provided. | | `linked_record_id` | string | No | — | Used to filter meetings to only those values that include a specific linked record. Must be a valid record ID. If provided, linked\_object must also be provided. | | `participants` | string | No | — | A comma-separated list of emails to filter meetings by. If provided, meetings will be filtered to only include meetings that include at least one of the provided emails as participants. | | `sort` | string | No | — | The order in which to sort the meetings. Defaults to start\_asc. | | `ends_from` | string | No | — | Use `ends_from` to filter meetings to only those that end after the specified timestamp. `ends_from` is inclusive, meaning that meetings that end at the exact timestamp will be included in results. When evaluating all-day meetings, we filter results from the perspective of a specific timezone (see `timezone` for more information). | | `starts_before` | string | No | — | Use `starts_before` to filter meetings to only those that start before the specified timestamp. `starts_before` is exclusive, meaning that meetings that start at the exact timestamp will not be included in results. When evaluating all-day meetings, we filter results from the perspective of a specific timezone (see `timezone` for more information). | | `timezone` | string | No | — | The timezone to use when filtering meetings using `ends_from` and `starts_before`. Defaults to UTC. This property has no effect for non-all-day meetings. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The maximum number of meetings to return. Must be between 1 and 200. Defaults to 50." }, "cursor": { "type": "string", "description": "A pagination cursor used to fetch the next page of meetings. Responses with more meetings will include a cursor for you to use here. If not provided, the first page will be returned." }, "linked_object": { "type": "string", "description": "The object to filter meetings by. Must be a valid object slug or ID. If provided, linked_record_id must also be provided." }, "linked_record_id": { "type": "string", "description": "Used to filter meetings to only those values that include a specific linked record. Must be a valid record ID. If provided, linked_object must also be provided." }, "participants": { "type": "string", "description": "A comma-separated list of emails to filter meetings by. If provided, meetings will be filtered to only include meetings that include at least one of the provided emails as participants." }, "sort": { "type": "string", "description": "The order in which to sort the meetings. Defaults to start_asc.", "enum": [ "start_asc", "start_desc" ] }, "ends_from": { "type": "string", "description": "Use `ends_from` to filter meetings to only those that end after the specified timestamp. `ends_from` is inclusive, meaning that meetings that end at the exact timestamp will be included in results. When evaluating all-day meetings, we filter results from the perspective of a specific timezone (see `timezone` for more information)." }, "starts_before": { "type": "string", "description": "Use `starts_before` to filter meetings to only those that start before the specified timestamp. `starts_before` is exclusive, meaning that meetings that start at the exact timestamp will not be included in results. When evaluating all-day meetings, we filter results from the perspective of a specific timezone (see `timezone` for more information)." }, "timezone": { "type": "string", "description": "The timezone to use when filtering meetings using `ends_from` and `starts_before`. Defaults to UTC. This property has no effect for non-all-day meetings." } }, "required": [ "PCID" ] } ``` *** ## attio\_list\_meetings\_meeting\_id\_call\_recordings List call recordings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `meeting_id` | string | Yes | — | The ID of the meeting to list call recordings for. | | `limit` | integer | No | — | The maximum number of results to return. Defaults to 50 with a maximum of 200. | | `cursor` | string | No | — | A cursor for pagination. Use the `next_cursor` from the previous response to get the next page of results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "meeting_id": { "type": "string", "description": "The ID of the meeting to list call recordings for." }, "limit": { "type": "integer", "description": "The maximum number of results to return. Defaults to 50 with a maximum of 200." }, "cursor": { "type": "string", "description": "A cursor for pagination. Use the `next_cursor` from the previous response to get the next page of results." } }, "required": [ "PCID", "meeting_id" ] } ``` *** ## attio\_list\_notes List notes **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | The maximum number of results to return. The default is `10` and the maximum is `50`. See the full guide to pagination here. | | `offset` | integer | No | — | The number of results to skip over before returning. The default is `0`. See the full guide to pagination here. | | `parent_object` | string | No | — | The slug or ID of the parent object the notes belong to. | | `parent_record_id` | string | No | — | The ID of the parent record the notes belong to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The maximum number of results to return. The default is `10` and the maximum is `50`. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "offset": { "type": "integer", "description": "The number of results to skip over before returning. The default is `0`. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "parent_object": { "type": "string", "description": "The slug or ID of the parent object the notes belong to." }, "parent_record_id": { "type": "string", "description": "The ID of the parent record the notes belong to." } }, "required": [ "PCID" ] } ``` *** ## attio\_list\_objects List objects ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## attio\_list\_objects\_object\_records\_record\_id\_attributes\_attribute\_values List record attribute values **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | A UUID or slug to identify the object the record belongs to. | | `record_id` | string | Yes | — | A UUID to identify the record you want to query values on. | | `attribute` | string | Yes | — | A UUID or slug to identify the attribute you want to query values on. | | `show_historic` | boolean | No | — | If `true`, the endpoint will return all historic values for the attribute. If `false`, the endpoint will only return the currently active value(s). Defaults to `false`. Cannot be set to `true` for COMINT attributes or enriched attributes on people/company objects. | | `limit` | integer | No | — | The maximum number of results to return. See the full guide to pagination here. | | `offset` | integer | No | — | The number of results to skip over before returning. See the full guide to pagination here. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "A UUID or slug to identify the object the record belongs to." }, "record_id": { "type": "string", "description": "A UUID to identify the record you want to query values on." }, "attribute": { "type": "string", "description": "A UUID or slug to identify the attribute you want to query values on." }, "show_historic": { "type": "boolean", "description": "If `true`, the endpoint will return all historic values for the attribute. If `false`, the endpoint will only return the currently active value(s). Defaults to `false`. Cannot be set to `true` for COMINT attributes or enriched attributes on people/company objects." }, "limit": { "type": "integer", "description": "The maximum number of results to return. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "offset": { "type": "integer", "description": "The number of results to skip over before returning. See the [full guide to pagination here](/rest-api/guides/pagination)." } }, "required": [ "PCID", "object", "record_id", "attribute" ] } ``` *** ## attio\_list\_objects\_object\_records\_record\_id\_entries List record entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | A UUID or slug identifying the object that the record belongs to. | | `record_id` | string | Yes | — | A UUID identifying the record. | | `limit` | integer | No | — | The maximum number of results to return. The default is `100` and the maximum is `1000`. See the full guide to pagination here. | | `offset` | integer | No | — | The number of results to skip over before returning. The default is `0`. See the full guide to pagination here. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "A UUID or slug identifying the object that the record belongs to." }, "record_id": { "type": "string", "description": "A UUID identifying the record." }, "limit": { "type": "integer", "description": "The maximum number of results to return. The default is `100` and the maximum is `1000`. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "offset": { "type": "integer", "description": "The number of results to skip over before returning. The default is `0`. See the [full guide to pagination here](/rest-api/guides/pagination)." } }, "required": [ "PCID", "object", "record_id" ] } ``` *** ## attio\_list\_objects\_object\_views List views for object **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | A UUID or slug to identify the object. | | `show_archived` | boolean | No | — | `true` to include archived views. See our archiving guide for more information on archiving. | | `limit` | integer | No | — | The maximum number of views to return. Must be between 1 and 1000. Defaults to 500. | | `cursor` | string | No | — | A pagination cursor from a previous response's `pagination.next_cursor`. Omit for the first page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "A UUID or slug to identify the object." }, "show_archived": { "type": "boolean", "description": "`true` to include archived views. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving." }, "limit": { "type": "integer", "description": "The maximum number of views to return. Must be between 1 and 1000. Defaults to 500." }, "cursor": { "type": "string", "description": "A pagination cursor from a previous response's `pagination.next_cursor`. Omit for the first page." } }, "required": [ "PCID", "object" ] } ``` *** ## attio\_list\_target\_identifier\_attributes List attributes **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Whether the attributes are on an object or a list. | | `identifier` | string | Yes | — | A UUID or slug to identify the object or list the attributes belong to. | | `limit` | integer | No | — | The maximum number of results to return. See the full guide to pagination here. | | `offset` | integer | No | — | The number of results to skip over before returning. See the full guide to pagination here. | | `show_archived` | boolean | No | — | Whether archived attributes should be included in the results. See the full guide to archiving here. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Whether the attributes are on an object or a list.", "enum": [ "objects", "lists" ] }, "identifier": { "type": "string", "description": "A UUID or slug to identify the object or list the attributes belong to." }, "limit": { "type": "integer", "description": "The maximum number of results to return. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "offset": { "type": "integer", "description": "The number of results to skip over before returning. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "show_archived": { "type": "boolean", "description": "Whether archived attributes should be included in the results. See the [full guide to archiving here](/docs/archiving-vs-deleting)." } }, "required": [ "PCID", "target", "identifier" ] } ``` *** ## attio\_list\_target\_identifier\_attributes\_attribute\_options List select options **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Whether the attribute is on an object or a list. | | `identifier` | string | Yes | — | A UUID or slug to identify the object or list the select attribute belongs to. | | `attribute` | string | Yes | — | A UUID or slug to identify the attribute you want to list select options on. | | `show_archived` | boolean | No | — | `true` if you want the results to include archived select options. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Whether the attribute is on an object or a list.", "enum": [ "objects", "lists" ] }, "identifier": { "type": "string", "description": "A UUID or slug to identify the object or list the select attribute belongs to." }, "attribute": { "type": "string", "description": "A UUID or slug to identify the attribute you want to list select options on." }, "show_archived": { "type": "boolean", "description": "`true` if you want the results to include archived select options." } }, "required": [ "PCID", "target", "identifier", "attribute" ] } ``` *** ## attio\_list\_target\_identifier\_attributes\_attribute\_statuses List statuses **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Whether the attribute is on an object or a list. | | `identifier` | string | Yes | — | A UUID or slug to identify the object or list the status attribute belongs to. | | `attribute` | string | Yes | — | A UUID or slug to identify the attribute you want to list statuses on. | | `show_archived` | boolean | No | — | `true` if you want the results to include archived statuses. See our archiving guide for more information on archiving. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Whether the attribute is on an object or a list.", "enum": [ "lists", "objects" ] }, "identifier": { "type": "string", "description": "A UUID or slug to identify the object or list the status attribute belongs to." }, "attribute": { "type": "string", "description": "A UUID or slug to identify the attribute you want to list statuses on." }, "show_archived": { "type": "boolean", "description": "`true` if you want the results to include archived statuses. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving." } }, "required": [ "PCID", "target", "identifier", "attribute" ] } ``` *** ## attio\_list\_tasks List tasks **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | The maximum number of results to return. Defaults to 500. See the full guide to pagination here. | | `offset` | integer | No | — | The number of results to skip over before returning. Defaults to 0. See the full guide to pagination here. | | `sort` | string | No | — | Optionally sort the results. "created\_at:asc" returns oldest results first, "created\_at:desc" returns the newest results first. "completed\_at:asc" and "completed\_at:desc" sort by completion time. With "completed\_at:asc", incomplete tasks (no completion date) appear first, followed by completed tasks oldest-first. With "completed\_at:desc", completed tasks appear first (newest-first), followed by incomplete tasks. To exclude incomplete tasks, filter by is\_completed. If unspecified, defaults to "created\_at:asc" (oldest results first). | | `linked_object` | string | No | — | Pass a value to this parameter to filter results to only those tasks that contain the specified record in the `linked_records` property of the task. This parameter should identify the object that the linked record belongs to. For example, if filtering to tasks that link to a specific person record, this parameter should be `people`. If provided, `linked_record_id` must also be provided. | | `linked_record_id` | string | No | — | Pass a value to this parameter to filter results to only those tasks that contain the specified record in the `linked_records` property of the task. This parameter should contain the record ID of the linked record. If provided, `linked_object` must also be provided. | | `assignee` | string | No | — | Filter tasks by workspace member assignees. Workspace members can be referenced by either their email address or ID. Pass an empty value or the string `null` to find tasks with no assignee. | | `is_completed` | boolean | No | — | Filter tasks by whether they have been completed. By default, both completed and non-completed tasks are returned. Specify `true` to only return completed tasks, or `false` to only return non-completed tasks. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The maximum number of results to return. Defaults to 500. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "offset": { "type": "integer", "description": "The number of results to skip over before returning. Defaults to 0. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "sort": { "type": "string", "description": "Optionally sort the results. \"created_at:asc\" returns oldest results first, \"created_at:desc\" returns the newest results first. \"completed_at:asc\" and \"completed_at:desc\" sort by completion time. With \"completed_at:asc\", incomplete tasks (no completion date) appear first, followed by completed tasks oldest-first. With \"completed_at:desc\", completed tasks appear first (newest-first), followed by incomplete tasks. To exclude incomplete tasks, filter by is_completed. If unspecified, defaults to \"created_at:asc\" (oldest results first).", "enum": [ "created_at:asc", "created_at:desc", "completed_at:asc", "completed_at:desc" ] }, "linked_object": { "type": "string", "description": "Pass a value to this parameter to filter results to only those tasks that contain the specified record in the `linked_records` property of the task. This parameter should identify the object that the linked record belongs to. For example, if filtering to tasks that link to a specific person record, this parameter should be `people`. If provided, `linked_record_id` must also be provided." }, "linked_record_id": { "type": "string", "description": "Pass a value to this parameter to filter results to only those tasks that contain the specified record in the `linked_records` property of the task. This parameter should contain the record ID of the linked record. If provided, `linked_object` must also be provided." }, "assignee": { "type": "string", "description": "Filter tasks by workspace member assignees. Workspace members can be referenced by either their email address or ID. Pass an empty value or the string `null` to find tasks with no assignee." }, "is_completed": { "type": "boolean", "description": "Filter tasks by whether they have been completed. By default, both completed and non-completed tasks are returned. Specify `true` to only return completed tasks, or `false` to only return non-completed tasks." } }, "required": [ "PCID" ] } ``` *** ## attio\_list\_threads List threads **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `record_id` | string | No | — | Use this parameter to filter to threads on a specific record. Must be passed with `object`. | | `object` | string | No | — | Use this parameter to filter to threads on a specific record. Must be passed with `record_id`. Accepts either a slug or an ID. | | `entry_id` | string | No | — | Use this parameter to filter to threads on a specific entry. Must be passed with `list`. | | `list` | string | No | — | Use this parameter to filter to threads on a specific entry. Must be passed with `entry_id`. Accepts either a slug or an ID. | | `limit` | integer | No | — | The maximum number of results to return. The default is `10` and the maximum is `50`. See the full guide to pagination here. | | `offset` | integer | No | — | The number of results to skip over before returning. The default is `0`. See the full guide to pagination here. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "record_id": { "type": "string", "description": "Use this parameter to filter to threads on a specific record. Must be passed with `object`." }, "object": { "type": "string", "description": "Use this parameter to filter to threads on a specific record. Must be passed with `record_id`. Accepts either a slug or an ID." }, "entry_id": { "type": "string", "description": "Use this parameter to filter to threads on a specific entry. Must be passed with `list`." }, "list": { "type": "string", "description": "Use this parameter to filter to threads on a specific entry. Must be passed with `entry_id`. Accepts either a slug or an ID." }, "limit": { "type": "integer", "description": "The maximum number of results to return. The default is `10` and the maximum is `50`. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "offset": { "type": "integer", "description": "The number of results to skip over before returning. The default is `0`. See the [full guide to pagination here](/rest-api/guides/pagination)." } }, "required": [ "PCID" ] } ``` *** ## attio\_list\_webhooks List webhooks **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | The maximum number of results to return, between 10 and 100, defaults to 10. See the full guide to pagination here. | | `offset` | integer | No | — | The number of results to skip over before returning, defaults to 0. See the full guide to pagination here. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The maximum number of results to return, between 10 and 100, defaults to 10. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "offset": { "type": "integer", "description": "The number of results to skip over before returning, defaults to 0. See the [full guide to pagination here](/rest-api/guides/pagination)." } }, "required": [ "PCID" ] } ``` *** ## attio\_list\_workspace\_members List workspace members ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## attio\_query\_lists\_list\_entries\_query List entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | A UUID or slug to identify the list to retrieve entries from. | | `filter` | object | No | — | An object used to filter results to a subset of results. Cannot be used together with `filter_view_id`. See the full guide to filtering and sorting here. | | `filter_view_id` | string | No | — | UUID of a saved view on this object or list. When set, results are filtered using that view's filter configuration. Cannot be used together with `filter`. Note: sorts, limits, and offsets are applied independently and are not taken from the view. All attributes are returned regardless of which attributes are visible in the view. | | `limit` | number | No | — | The maximum number of results to return. Defaults to 500. See the full guide to pagination here. | | `offset` | number | No | — | The number of results to skip over before returning. Defaults to 0. See the full guide to pagination here. | | `sorts` | any\[] | No | — | An object used to sort results. See the full guide to filtering and sorting here. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "A UUID or slug to identify the list to retrieve entries from." }, "filter": { "type": "object", "description": "An object used to filter results to a subset of results. Cannot be used together with `filter_view_id`. See the [full guide to filtering and sorting here](/rest-api/guides/filtering-and-sorting)." }, "filter_view_id": { "type": "string", "description": "UUID of a saved view on this object or list. When set, results are filtered using that view's filter configuration. Cannot be used together with `filter`. Note: sorts, limits, and offsets are applied independently and are not taken from the view. All attributes are returned regardless of which attributes are visible in the view." }, "limit": { "type": "number", "description": "The maximum number of results to return. Defaults to 500. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "offset": { "type": "number", "description": "The number of results to skip over before returning. Defaults to 0. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "sorts": { "type": "array", "description": "An object used to sort results. See the [full guide to filtering and sorting here](/rest-api/guides/filtering-and-sorting)." } }, "required": [ "PCID", "list" ] } ``` *** ## attio\_query\_objects\_object\_records\_query List records **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | A UUID or slug to identify the object to list records for. | | `filter` | object | No | — | An object used to filter results to a subset of results. Cannot be used together with `filter_view_id`. See the full guide to filtering and sorting here. | | `filter_view_id` | string | No | — | UUID of a saved view on this object or list. When set, results are filtered using that view's filter configuration. Cannot be used together with `filter`. Note: sorts, limits, and offsets are applied independently and are not taken from the view. All attributes are returned regardless of which attributes are visible in the view. | | `limit` | number | No | — | The maximum number of results to return. Defaults to 500. See the full guide to pagination here. | | `offset` | number | No | — | The number of results to skip over before returning. Defaults to 0. See the full guide to pagination here. | | `sorts` | any\[] | No | — | An object used to sort results. See the full guide to filtering and sorting here. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "A UUID or slug to identify the object to list records for." }, "filter": { "type": "object", "description": "An object used to filter results to a subset of results. Cannot be used together with `filter_view_id`. See the [full guide to filtering and sorting here](/rest-api/guides/filtering-and-sorting)." }, "filter_view_id": { "type": "string", "description": "UUID of a saved view on this object or list. When set, results are filtered using that view's filter configuration. Cannot be used together with `filter`. Note: sorts, limits, and offsets are applied independently and are not taken from the view. All attributes are returned regardless of which attributes are visible in the view." }, "limit": { "type": "number", "description": "The maximum number of results to return. Defaults to 500. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "offset": { "type": "number", "description": "The number of results to skip over before returning. Defaults to 0. See the [full guide to pagination here](/rest-api/guides/pagination)." }, "sorts": { "type": "array", "description": "An object used to sort results. See the [full guide to filtering and sorting here](/rest-api/guides/filtering-and-sorting)." } }, "required": [ "PCID", "object" ] } ``` *** ## attio\_search\_objects\_records\_search Search records **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | number | No | — | The maximum number of results to return. Defaults to 25. | | `objects` | string\[] | Yes | — | Specifies which objects to filter results by. At least one object must be specified. Accepts object slugs or IDs. | | `query` | string | Yes | — | Query string to search for. An empty string returns a default set of results. | | `request_as` | object | Yes | — | Specifies the context in which to perform the search. Use 'workspace' to return all search results or specify a workspace member to limit results to what one specific person in your workspace can see. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "number", "description": "The maximum number of results to return. Defaults to 25." }, "objects": { "type": "array", "items": { "type": "string" }, "description": "Specifies which objects to filter results by. At least one object must be specified. Accepts object slugs or IDs." }, "query": { "type": "string", "description": "Query string to search for. An empty string returns a default set of results." }, "request_as": { "description": "Specifies the context in which to perform the search. Use 'workspace' to return all search results or specify a workspace member to limit results to what one specific person in your workspace can see." } }, "required": [ "PCID", "objects", "query", "request_as" ] } ``` *** ## attio\_update\_lists\_list Update a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | A UUID or slug to identify the list to update. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "A UUID or slug to identify the list to update." }, "data": { "type": "object", "description": "The data value", "properties": { "name": { "type": "string", "description": "The human-readable name of the list." }, "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the list through API calls. Should be formatted in snake case." }, "workspace_access": { "type": "string", "description": "The level of access granted to all members of the workspace for this list. Pass `null` to keep the list private and only grant access to specific workspace members.", "enum": [ "full-access", "read-and-write", "read-only" ] }, "workspace_member_access": { "type": "array", "items": { "type": "object" }, "description": "The level of access granted to specific workspace members for this list. Pass an empty array to grant access to no workspace members." } } } }, "required": [ "PCID", "list", "data" ] } ``` *** ## attio\_update\_lists\_list\_entries\_entry\_id Update a list entry (append multiselect values) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | A UUID or slug of the list the list entry belongs to. | | `entry_id` | string | Yes | — | A UUID of the list entry to update. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "A UUID or slug of the list the list entry belongs to." }, "entry_id": { "type": "string", "description": "A UUID of the list entry to update." }, "data": { "type": "object", "description": "The data value", "properties": { "entry_values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types)." } }, "required": [ "entry_values" ] } }, "required": [ "PCID", "list", "entry_id", "data" ] } ``` *** ## attio\_update\_objects\_object Update an object **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | A UUID or slug to identify the object. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "A UUID or slug to identify the object." }, "data": { "type": "object", "description": "The data value", "properties": { "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the object through URLs and API calls. Should be formatted in snake case." }, "singular_noun": { "type": "string", "description": "The singular form of the object's name." }, "plural_noun": { "type": "string", "description": "The plural form of the object's name." } } } }, "required": [ "PCID", "object", "data" ] } ``` *** ## attio\_update\_objects\_object\_records\_record\_id Update a record (append multiselect values) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | A UUID or slug of the object the record belongs to. | | `record_id` | string | Yes | — | A UUID of the record to update. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "A UUID or slug of the object the record belongs to." }, "record_id": { "type": "string", "description": "A UUID of the record to update." }, "data": { "type": "object", "description": "The data value", "properties": { "values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types)." } }, "required": [ "values" ] } }, "required": [ "PCID", "object", "record_id", "data" ] } ``` *** ## attio\_update\_target\_identifier\_attributes\_attribute Update an attribute **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Whether the attribute is on an object or a list. | | `identifier` | string | Yes | — | A UUID or slug to identify the object or list the attribute belongs to. | | `attribute` | string | Yes | — | A UUID or slug to identify the attribute. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Whether the attribute is on an object or a list.", "enum": [ "objects", "lists" ] }, "identifier": { "type": "string", "description": "A UUID or slug to identify the object or list the attribute belongs to." }, "attribute": { "type": "string", "description": "A UUID or slug to identify the attribute." }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "The name of the attribute. The title will be visible across Attio's UI." }, "description": { "type": "string", "description": "A text description for the attribute." }, "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the attribute through URLs and API calls. Formatted in snake case." }, "is_required": { "type": "boolean", "description": "When `is_required` is `true`, new records/entries must have a value for this attribute. If `false`, values may be `null`. This value does not affect existing data and you do not need to backfill `null` values if changing `is_required` from `false` to `true`." }, "is_unique": { "type": "boolean", "description": "Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data." }, "default_value": { "description": "The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute. Default values are not currently supported on people or company objects." }, "config": { "type": "object", "description": "Additional, type-dependent configuration for the attribute." }, "is_archived": { "type": "boolean", "description": "Whether the attribute has been archived or not. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving." } } } }, "required": [ "PCID", "target", "identifier", "attribute", "data" ] } ``` *** ## attio\_update\_target\_identifier\_attributes\_attribute\_options\_option Update a select option **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Whether the attribute is on an object or a list. | | `identifier` | string | Yes | — | A UUID or slug to identify the object or list the select attribute belongs to. | | `attribute` | string | Yes | — | A UUID or slug to identify the select attribute. | | `option` | string | Yes | — | A UUID or select option title to identify the select option you would like to update. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Whether the attribute is on an object or a list.", "enum": [ "objects", "lists" ] }, "identifier": { "type": "string", "description": "A UUID or slug to identify the object or list the select attribute belongs to." }, "attribute": { "type": "string", "description": "A UUID or slug to identify the select attribute." }, "option": { "type": "string", "description": "A UUID or select option title to identify the select option you would like to update." }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "The Title of the select option" }, "is_archived": { "type": "boolean", "description": "Whether or not to archive the select option. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving." } } } }, "required": [ "PCID", "target", "identifier", "attribute", "option", "data" ] } ``` *** ## attio\_update\_target\_identifier\_attributes\_attribute\_statuses\_status Update a status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `target` | string | Yes | — | Whether the attribute is on an object or a list. | | `identifier` | string | Yes | — | A UUID or slug to identify the object or list the status attribute belongs to. | | `attribute` | string | Yes | — | A UUID or slug to identify the attribute to update the status on. | | `status` | string | Yes | — | A UUID or status title to identify the status to update. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "target": { "type": "string", "description": "Whether the attribute is on an object or a list.", "enum": [ "lists", "objects" ] }, "identifier": { "type": "string", "description": "A UUID or slug to identify the object or list the status attribute belongs to." }, "attribute": { "type": "string", "description": "A UUID or slug to identify the attribute to update the status on." }, "status": { "type": "string", "description": "A UUID or status title to identify the status to update." }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "The Title of the status" }, "celebration_enabled": { "type": "boolean", "description": "Whether arriving at this status triggers a celebration effect" }, "target_time_in_status": { "type": "string", "description": "Target time for a record to spend in given status expressed as a ISO-8601 duration string" }, "is_archived": { "type": "boolean", "description": "Whether or not to archive the status. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving." } } } }, "required": [ "PCID", "target", "identifier", "attribute", "status", "data" ] } ``` *** ## attio\_update\_tasks\_task\_id Update a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `task_id` | string | Yes | — | The ID of the task to update. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "task_id": { "type": "string", "description": "The ID of the task to update." }, "data": { "type": "object", "description": "The data value", "properties": { "deadline_at": { "type": "string", "description": "The deadline of the task, in ISO 8601 format." }, "is_completed": { "type": "boolean", "description": "Whether the task has been completed." }, "linked_records": { "type": "array", "description": "Records linked to the task. Records can be linked by domain (for companies), email address (for people), record ID (for all objects) or by a unique matching attribute (for all objects). Creating record links within task content text is not possible via the API at present." }, "assignees": { "type": "array", "description": "Workspace members assigned to this task." } } } }, "required": [ "PCID", "task_id", "data" ] } ``` *** ## attio\_update\_webhooks\_webhook\_id Update a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `webhook_id` | string | Yes | — | A UUID which identifies the webhook. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhook_id": { "type": "string", "description": "A UUID which identifies the webhook." }, "data": { "type": "object", "description": "The data value", "properties": { "target_url": { "type": "string", "description": "URL where the webhook events will be delivered to." }, "subscriptions": { "type": "array", "items": { "type": "object" }, "description": "One or more events the webhook is subscribed to." } } } }, "required": [ "PCID", "webhook_id", "data" ] } ``` *** ## attio\_upsert\_lists\_list\_entries Upsert a list entry by parent **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | A UUID or slug of the list the list entry belongs to. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "A UUID or slug of the list the list entry belongs to." }, "data": { "type": "object", "description": "The data value", "properties": { "parent_record_id": { "type": "string", "description": "A UUID identifying the record you want to add to the list. The record will become the 'parent' of the created list entry." }, "parent_object": { "type": "string", "description": "A UUID or slug identifying the object that the added parent record belongs to." }, "entry_values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types)." } }, "required": [ "parent_record_id", "parent_object", "entry_values" ] } }, "required": [ "PCID", "list", "data" ] } ``` *** ## attio\_upsert\_lists\_list\_entries\_entry\_id Update a list entry (overwrite multiselect values) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `list` | string | Yes | — | A UUID or slug of the list the list entry belongs to. | | `entry_id` | string | Yes | — | A UUID of the list entry to update. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "list": { "type": "string", "description": "A UUID or slug of the list the list entry belongs to." }, "entry_id": { "type": "string", "description": "A UUID of the list entry to update." }, "data": { "type": "object", "description": "The data value", "properties": { "entry_values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types)." } }, "required": [ "entry_values" ] } }, "required": [ "PCID", "list", "entry_id", "data" ] } ``` *** ## attio\_upsert\_objects\_object\_records Upsert a record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | A UUID or slug to identify the object the record should belong to. | | `matching_attribute` | string | Yes | — | The ID or slug of the attribute to use to check if a record already exists. The attribute must be unique. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "A UUID or slug to identify the object the record should belong to." }, "matching_attribute": { "type": "string", "description": "The ID or slug of the attribute to use to check if a record already exists. The attribute must be unique." }, "data": { "type": "object", "description": "The data value", "properties": { "values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types)." } }, "required": [ "values" ] } }, "required": [ "PCID", "object", "matching_attribute", "data" ] } ``` *** ## attio\_upsert\_objects\_object\_records\_record\_id Update a record (overwrite multiselect values) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object` | string | Yes | — | A UUID or slug of the object the record belongs to. | | `record_id` | string | Yes | — | A UUID of the record to update. | | `data` | object | Yes | — | The data value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object": { "type": "string", "description": "A UUID or slug of the object the record belongs to." }, "record_id": { "type": "string", "description": "A UUID of the record to update." }, "data": { "type": "object", "description": "The data value", "properties": { "values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types)." } }, "required": [ "values" ] } }, "required": [ "PCID", "object", "record_id", "data" ] } ``` # azure-ai Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/azure-ai Azure AI API **Server path:** `/azure-ai` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`azure_ai_cancel_response`](#azure_ai_cancel_response) | Cancel an in-progress response | | [`azure_ai_create_response`](#azure_ai_create_response) | Create a model response using the Azure OpenAI Responses API | | [`azure_ai_delete_response`](#azure_ai_delete_response) | Delete a model response | | [`azure_ai_get_response`](#azure_ai_get_response) | Get a model response by ID | | [`azure_ai_image_generation`](#azure_ai_image_generation) | Generate images using an Azure OpenAI DALL-E deployment | *** ## azure\_ai\_cancel\_response Cancel an in-progress response **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `responseId` | string | Yes | — | Response ID to cancel | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "responseId": { "type": "string", "description": "Response ID to cancel" } }, "required": [ "PCID", "responseId" ] } ``` *** ## azure\_ai\_create\_response Create a model response using the Azure OpenAI Responses API **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `model` | string | No | `"gpt-4.1"` | Model to use (e.g., gpt-5.4, gpt-5.2, gpt-5.1, gpt-5, gpt-4.1, gpt-4.1-mini) | | `messages` | object\[] | Yes | — | Array of conversation messages | | `temperature` | number | No | `1` | Sampling temperature (0-2) | | `maxTokens` | number | No | — | Maximum tokens to generate | | `topP` | number | No | — | Nucleus sampling parameter | | `tools` | object\[] | No | — | Tools available to the model | | `toolChoice` | string | No | — | Tool choice configuration | | `responseFormat` | object | No | — | Response format specification | | `metadata` | object | No | — | Custom metadata for the response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "model": { "type": "string", "default": "gpt-4.1", "description": "Model to use (e.g., gpt-5.4, gpt-5.2, gpt-5.1, gpt-5, gpt-4.1, gpt-4.1-mini)" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "system", "user", "assistant", "tool" ], "description": "Message role" }, "content": { "type": "string", "description": "Message content" } } }, "description": "Array of conversation messages" }, "temperature": { "type": "number", "default": 1, "description": "Sampling temperature (0-2)" }, "maxTokens": { "type": "number", "description": "Maximum tokens to generate" }, "topP": { "type": "number", "description": "Nucleus sampling parameter" }, "tools": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Tools available to the model" }, "toolChoice": { "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": true } ], "description": "Tool choice configuration" }, "responseFormat": { "type": "object", "additionalProperties": true, "description": "Response format specification" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Custom metadata for the response" } }, "required": [ "PCID", "messages" ] } ``` *** ## azure\_ai\_delete\_response Delete a model response **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `responseId` | string | Yes | — | Response ID to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "responseId": { "type": "string", "description": "Response ID to delete" } }, "required": [ "PCID", "responseId" ] } ``` *** ## azure\_ai\_get\_response Get a model response by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `responseId` | string | Yes | — | Response ID to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "responseId": { "type": "string", "description": "Response ID to retrieve" } }, "required": [ "PCID", "responseId" ] } ``` *** ## azure\_ai\_image\_generation Generate images using an Azure OpenAI DALL-E deployment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deployment` | string | Yes | — | Azure OpenAI deployment name (e.g., dall-e-3) | | `apiVersion` | string | No | `"2024-10-21"` | Azure OpenAI API version (default: 2024-10-21) | | `prompt` | string | Yes | — | Text description of the image to generate | | `n` | number | No | `1` | Number of images to generate | | `size` | string | No | `"1024x1024"` | Image size | | `quality` | string | No | — | Image quality (DALL-E 3 only) | | `style` | string | No | — | Image style (DALL-E 3 only) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "deployment": { "type": "string", "description": "Azure OpenAI deployment name (e.g., dall-e-3)" }, "apiVersion": { "type": "string", "default": "2024-10-21", "description": "Azure OpenAI API version (default: 2024-10-21)" }, "prompt": { "type": "string", "description": "Text description of the image to generate" }, "n": { "type": "number", "default": 1, "description": "Number of images to generate" }, "size": { "type": "string", "enum": [ "1024x1024", "1024x1792", "1792x1024" ], "default": "1024x1024", "description": "Image size" }, "quality": { "type": "string", "enum": [ "standard", "hd" ], "description": "Image quality (DALL-E 3 only)" }, "style": { "type": "string", "enum": [ "natural", "vivid" ], "description": "Image style (DALL-E 3 only)" } }, "required": [ "PCID", "deployment", "prompt" ] } ``` # azure-cognitive-ai Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/azure-cognitive-ai Azure Language AI **Server path:** `/azure-cognitive-ai` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`azure_cognitive_ai_analyze_text`](#azure_cognitive_ai_analyze_text) | Request text analysis over a collection of documents. | | [`azure_cognitive_ai_analyze_text_cancel_job`](#azure_cognitive_ai_analyze_text_cancel_job) | Cancel a long-running Text Analysis job. | | [`azure_cognitive_ai_analyze_text_job_status`](#azure_cognitive_ai_analyze_text_job_status) | Get analysis status and results | | [`azure_cognitive_ai_analyze_text_submit_job`](#azure_cognitive_ai_analyze_text_submit_job) | Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation. | *** ## azure\_cognitive\_ai\_analyze\_text Request text analysis over a collection of documents. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `showStats` | boolean | No | — | (Optional) if set to true, response will contain request and document level statistics. | | `analysisInput` | object | Yes | — | Input documents to analyze. | | `kind` | string | Yes | — | The kind of text analysis to perform. | | `parameters` | object | No | — | Optional task parameters (e.g. modelVersion, loggingOptOut). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "showStats": { "type": "boolean", "description": "(Optional) if set to true, response will contain request and document level statistics." }, "analysisInput": { "type": "object", "description": "Input documents to analyze.", "properties": { "documents": { "type": "array", "items": { "type": "object" }, "description": "List of documents. Each document needs an 'id' (string) and 'text' (string). For non-LanguageDetection tasks, include 'language' (e.g. 'en')." } }, "required": [ "documents" ] }, "kind": { "type": "string", "description": "The kind of text analysis to perform.", "enum": [ "SentimentAnalysis", "EntityRecognition", "PiiEntityRecognition", "KeyPhraseExtraction", "LanguageDetection", "EntityLinking" ] }, "parameters": { "type": "object", "description": "Optional task parameters (e.g. modelVersion, loggingOptOut).", "properties": { "modelVersion": { "type": "string", "description": "Model version to use (default: 'latest')." }, "loggingOptOut": { "type": "boolean", "description": "If true, opt out of logging input text for troubleshooting." } } } }, "required": [ "PCID", "analysisInput", "kind" ] } ``` *** ## azure\_cognitive\_ai\_analyze\_text\_cancel\_job Cancel a long-running Text Analysis job. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `jobId` | string | Yes | — | The job ID to cancel. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "The job ID to cancel." } }, "required": [ "PCID", "jobId" ] } ``` *** ## azure\_cognitive\_ai\_analyze\_text\_job\_status Get analysis status and results **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `jobId` | string | Yes | — | job ID | | `showStats` | boolean | No | — | (Optional) if set to true, response will contain request and document level statistics. | | `top` | integer | No | — | The maximum number of resources to return from the collection. | | `skip` | integer | No | — | An offset into the collection of the first resource to be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "job ID" }, "showStats": { "type": "boolean", "description": "(Optional) if set to true, response will contain request and document level statistics." }, "top": { "type": "integer", "description": "The maximum number of resources to return from the collection." }, "skip": { "type": "integer", "description": "An offset into the collection of the first resource to be returned." } }, "required": [ "PCID", "jobId" ] } ``` *** ## azure\_cognitive\_ai\_analyze\_text\_submit\_job Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `analysisInput` | object | Yes | — | Collection of input documents to be analyzed by the service. | | `displayName` | string | No | — | Name for the task. | | `tasks` | object\[] | Yes | — | List of tasks to be performed as part of the LRO. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "analysisInput": { "type": "object", "description": "Collection of input documents to be analyzed by the service.", "properties": { "documents": { "type": "array", "items": { "type": "object" }, "description": "The input documents to be analyzed." } } }, "displayName": { "type": "string", "description": "Name for the task." }, "tasks": { "type": "array", "items": { "type": "object", "properties": { "taskName": { "type": "string", "description": "task name" }, "kind": { "type": "string", "enum": [ "SentimentAnalysis", "EntityRecognition", "PiiEntityRecognition", "KeyPhraseExtraction", "EntityLinking", "Healthcare", "CustomEntityRecognition", "CustomSingleLabelClassification", "CustomMultiLabelClassification", "ExtractiveSummarization", "AbstractiveSummarization" ], "description": "The kind of the long running analyze text tasks supported." } }, "required": [ "kind" ] }, "description": "List of tasks to be performed as part of the LRO." } }, "required": [ "PCID", "analysisInput", "tasks" ] } ``` # azure-data-lake-storage Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/azure-data-lake-storage Azure Data Lake Storage **Server path:** `/azure-data-lake-storage` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`azure_data_lake_storage_filesystem_create`](#azure_data_lake_storage_filesystem_create) | Create Filesystem | | [`azure_data_lake_storage_filesystem_delete`](#azure_data_lake_storage_filesystem_delete) | Delete Filesystem | | [`azure_data_lake_storage_filesystem_list`](#azure_data_lake_storage_filesystem_list) | List Filesystems | | [`azure_data_lake_storage_filesystem_set_properties`](#azure_data_lake_storage_filesystem_set_properties) | Set Filesystem Properties | | [`azure_data_lake_storage_path_create`](#azure_data_lake_storage_path_create) | Create File \| Create Directory | | [`azure_data_lake_storage_path_delete`](#azure_data_lake_storage_path_delete) | Delete File \| Delete Directory | | [`azure_data_lake_storage_path_list`](#azure_data_lake_storage_path_list) | List Paths | | [`azure_data_lake_storage_path_read`](#azure_data_lake_storage_path_read) | Read File | | [`azure_data_lake_storage_path_update`](#azure_data_lake_storage_path_update) | Append Data \| Flush Data \| Set Properties \| Set Access Control | *** ## azure\_data\_lake\_storage\_filesystem\_create Create Filesystem **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filesystem` | string | Yes | — | The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters. | | `resource` | string | Yes | — | The value must be "filesystem" for all filesystem operations. | | `timeout` | integer | No | — | An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filesystem": { "type": "string", "description": "The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters." }, "resource": { "type": "string", "description": "The value must be \"filesystem\" for all filesystem operations.", "enum": [ "filesystem" ] }, "timeout": { "type": "integer", "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails." } }, "required": [ "PCID", "filesystem", "resource" ] } ``` *** ## azure\_data\_lake\_storage\_filesystem\_delete Delete Filesystem **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filesystem` | string | Yes | — | The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters. | | `resource` | string | Yes | — | The value must be "filesystem" for all filesystem operations. | | `timeout` | integer | No | — | An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filesystem": { "type": "string", "description": "The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters." }, "resource": { "type": "string", "description": "The value must be \"filesystem\" for all filesystem operations.", "enum": [ "filesystem" ] }, "timeout": { "type": "integer", "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails." } }, "required": [ "PCID", "filesystem", "resource" ] } ``` *** ## azure\_data\_lake\_storage\_filesystem\_list List Filesystems **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `resource` | string | Yes | — | The value must be "account" for all account operations. | | `prefix` | string | No | — | Filters results to filesystems within the specified prefix. | | `continuation` | string | No | — | The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems. | | `maxResults` | integer | No | — | An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items. | | `timeout` | integer | No | — | An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "resource": { "type": "string", "description": "The value must be \"account\" for all account operations.", "enum": [ "account" ] }, "prefix": { "type": "string", "description": "Filters results to filesystems within the specified prefix." }, "continuation": { "type": "string", "description": "The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems." }, "maxResults": { "type": "integer", "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items." }, "timeout": { "type": "integer", "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails." } }, "required": [ "PCID", "resource" ] } ``` *** ## azure\_data\_lake\_storage\_filesystem\_set\_properties Set Filesystem Properties **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filesystem` | string | Yes | — | The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters. | | `resource` | string | Yes | — | The value must be "filesystem" for all filesystem operations. | | `timeout` | integer | No | — | An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. | | `x-ms-properties` | string | No | — | User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filesystem": { "type": "string", "description": "The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters." }, "resource": { "type": "string", "description": "The value must be \"filesystem\" for all filesystem operations.", "enum": [ "filesystem" ] }, "timeout": { "type": "integer", "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails." }, "x-ms-properties": { "type": "string", "description": "User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted." } }, "required": [ "PCID", "filesystem", "resource" ] } ``` *** ## azure\_data\_lake\_storage\_path\_create Create File | Create Directory **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `resource` | string | No | — | Required only for Create File and Create Directory. The value must be "file" or "directory". | | `filesystem` | string | Yes | — | The filesystem identifier. | | `path` | string | Yes | — | The file or directory path. | | `timeout` | integer | No | — | An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "resource": { "type": "string", "description": "Required only for Create File and Create Directory. The value must be \"file\" or \"directory\".", "enum": [ "directory", "file" ] }, "filesystem": { "type": "string", "description": "The filesystem identifier." }, "path": { "type": "string", "description": "The file or directory path." }, "timeout": { "type": "integer", "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails." } }, "required": [ "PCID", "filesystem", "path" ] } ``` *** ## azure\_data\_lake\_storage\_path\_delete Delete File | Delete Directory **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recursive` | boolean | No | — | Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. If "false" and the directory is non-empty, an error occurs. | | `continuation` | string | No | — | Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. | | `filesystem` | string | Yes | — | The filesystem identifier. | | `path` | string | Yes | — | The file or directory path. | | `timeout` | integer | No | — | An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recursive": { "type": "boolean", "description": "Required and valid only when the resource is a directory. If \"true\", all paths beneath the directory will be deleted. If \"false\" and the directory is non-empty, an error occurs." }, "continuation": { "type": "string", "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory." }, "filesystem": { "type": "string", "description": "The filesystem identifier." }, "path": { "type": "string", "description": "The file or directory path." }, "timeout": { "type": "integer", "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails." } }, "required": [ "PCID", "filesystem", "path" ] } ``` *** ## azure\_data\_lake\_storage\_path\_list List Paths **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `directory` | string | No | — | Filters results to paths within the specified directory. An error occurs if the directory does not exist. | | `recursive` | boolean | Yes | — | If "true", all paths are listed; otherwise, only paths at the root of the filesystem are listed. If "directory" is specified, the list will only include paths that share the same root. | | `continuation` | string | No | — | The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths. | | `maxResults` | integer | No | — | An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items. | | `upn` | boolean | No | — | Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names. | | `filesystem` | string | Yes | — | The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters. | | `resource` | string | Yes | — | The value must be "filesystem" for all filesystem operations. | | `timeout` | integer | No | — | An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "directory": { "type": "string", "description": "Filters results to paths within the specified directory. An error occurs if the directory does not exist." }, "recursive": { "type": "boolean", "description": "If \"true\", all paths are listed; otherwise, only paths at the root of the filesystem are listed. If \"directory\" is specified, the list will only include paths that share the same root." }, "continuation": { "type": "string", "description": "The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths." }, "maxResults": { "type": "integer", "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items." }, "upn": { "type": "boolean", "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names." }, "filesystem": { "type": "string", "description": "The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters." }, "resource": { "type": "string", "description": "The value must be \"filesystem\" for all filesystem operations.", "enum": [ "filesystem" ] }, "timeout": { "type": "integer", "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails." } }, "required": [ "PCID", "recursive", "filesystem", "resource" ] } ``` *** ## azure\_data\_lake\_storage\_path\_read Read File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filesystem` | string | Yes | — | The filesystem identifier. | | `path` | string | Yes | — | The file or directory path. | | `timeout` | integer | No | — | An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filesystem": { "type": "string", "description": "The filesystem identifier." }, "path": { "type": "string", "description": "The file or directory path." }, "timeout": { "type": "integer", "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails." } }, "required": [ "PCID", "filesystem", "path" ] } ``` *** ## azure\_data\_lake\_storage\_path\_update Append Data | Flush Data | Set Properties | Set Access Control **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `action` | string | Yes | — | The action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, or "setAccessControl" to set the owner, group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive. | | `position` | integer | No | — | This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request. | | `retainUncommittedData` | boolean | No | — | Valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation. | | `close` | boolean | No | — | Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed." | | `filesystem` | string | Yes | — | The filesystem identifier. | | `path` | string | Yes | — | The file or directory path. | | `timeout` | integer | No | — | An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. | | `x-ms-properties` | string | No | — | Valid only for setProperties action. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. | | `x-ms-permissions` | string | No | — | Valid only for setAccessControl and setProperties actions. Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl. | | `x-ms-acl` | string | No | — | Valid only for setAccessControl action. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each entry has scope (default), type (user\|group\|other\|mask), optional UPN or OID, and permissions (rwx or octal). Example: "user::rwx,group::r--,other::---". Invalid in conjunction with x-ms-permissions. | | `x-ms-owner` | string | No | — | Valid only for setAccessControl action. Sets the owner of the file or directory. | | `x-ms-group` | string | No | — | Valid only for setAccessControl action. Sets the owning group of the file or directory. | | `body` | string | No | — | Valid only for append operations. The data to be uploaded and appended to the file. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "action": { "type": "string", "description": "The action must be \"append\" to upload data to be appended to a file, \"flush\" to flush previously uploaded data to a file, \"setProperties\" to set the properties of a file or directory, or \"setAccessControl\" to set the owner, group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.", "enum": [ "append", "flush", "setProperties", "setAccessControl" ] }, "position": { "type": "integer", "description": "This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request." }, "retainUncommittedData": { "type": "boolean", "description": "Valid only for flush operations. If \"true\", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation." }, "close": { "type": "boolean", "description": "Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is \"flush\" and change notifications are enabled. If the value of close is \"true\" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If \"false\" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed.\"" }, "filesystem": { "type": "string", "description": "The filesystem identifier." }, "path": { "type": "string", "description": "The file or directory path." }, "timeout": { "type": "integer", "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails." }, "x-ms-properties": { "type": "string", "description": "Valid only for setProperties action. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set." }, "x-ms-permissions": { "type": "string", "description": "Valid only for setAccessControl and setProperties actions. Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl." }, "x-ms-acl": { "type": "string", "description": "Valid only for setAccessControl action. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each entry has scope (default), type (user|group|other|mask), optional UPN or OID, and permissions (rwx or octal). Example: \"user::rwx,group::r--,other::---\". Invalid in conjunction with x-ms-permissions." }, "x-ms-owner": { "type": "string", "description": "Valid only for setAccessControl action. Sets the owner of the file or directory." }, "x-ms-group": { "type": "string", "description": "Valid only for setAccessControl action. Sets the owning group of the file or directory." }, "body": { "type": "string", "description": "Valid only for append operations. The data to be uploaded and appended to the file." } }, "required": [ "PCID", "action", "filesystem", "path" ] } ``` # azure-storage Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/azure-storage Blobs, containers, and queues **Server path:** `/azure-storage` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`azure_storage_copy_blob`](#azure_storage_copy_blob) | Copy a blob within Azure Storage or from another source | | [`azure_storage_create_container`](#azure_storage_create_container) | Create a new container in Azure Storage | | [`azure_storage_delete_blob`](#azure_storage_delete_blob) | Delete a blob from Azure Storage container | | [`azure_storage_get_blob`](#azure_storage_get_blob) | Get blob content and metadata from Azure Storage | | [`azure_storage_list_blobs`](#azure_storage_list_blobs) | List blobs in an Azure Storage container | | [`azure_storage_list_containers`](#azure_storage_list_containers) | List all containers in the Azure Storage account | | [`azure_storage_set_blob_metadata`](#azure_storage_set_blob_metadata) | Set metadata for an existing blob | | [`azure_storage_upload_blob`](#azure_storage_upload_blob) | Upload a blob to Azure Storage container | *** ## azure\_storage\_copy\_blob Copy a blob within Azure Storage or from another source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sourceContainerName` | string | Yes | — | Source container name | | `sourceBlobName` | string | Yes | — | Source blob name | | `destinationContainerName` | string | Yes | — | Destination container name | | `destinationBlobName` | string | Yes | — | Destination blob name | | `metadata` | object | No | — | Metadata for the destination blob | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "sourceContainerName": { "type": "string", "description": "Source container name" }, "sourceBlobName": { "type": "string", "description": "Source blob name" }, "destinationContainerName": { "type": "string", "description": "Destination container name" }, "destinationBlobName": { "type": "string", "description": "Destination blob name" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Metadata for the destination blob" } }, "required": [ "PCID", "sourceContainerName", "sourceBlobName", "destinationContainerName", "destinationBlobName" ] } ``` *** ## azure\_storage\_create\_container Create a new container in Azure Storage **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `containerName` | string | Yes | — | Name for the new container (lowercase, 3-63 characters) | | `publicAccessLevel` | string | No | `"private"` | Public access level for the container | | `metadata` | object | No | — | Metadata key-value pairs for the container | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "containerName": { "type": "string", "description": "Name for the new container (lowercase, 3-63 characters)" }, "publicAccessLevel": { "type": "string", "enum": [ "private", "blob", "container" ], "default": "private", "description": "Public access level for the container" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Metadata key-value pairs for the container" } }, "required": [ "PCID", "containerName" ] } ``` *** ## azure\_storage\_delete\_blob Delete a blob from Azure Storage container **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `containerName` | string | Yes | — | Container name | | `blobName` | string | Yes | — | Blob name to delete | | `deleteSnapshots` | string | No | — | How to handle blob snapshots | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "containerName": { "type": "string", "description": "Container name" }, "blobName": { "type": "string", "description": "Blob name to delete" }, "deleteSnapshots": { "type": "string", "enum": [ "include", "only" ], "description": "How to handle blob snapshots" } }, "required": [ "PCID", "containerName", "blobName" ] } ``` *** ## azure\_storage\_get\_blob Get blob content and metadata from Azure Storage **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `containerName` | string | Yes | — | Container name | | `blobName` | string | Yes | — | Blob name to retrieve | | `includeContent` | boolean | No | `true` | Whether to include blob content in response | | `includeMetadata` | boolean | No | `true` | Whether to include blob metadata | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "containerName": { "type": "string", "description": "Container name" }, "blobName": { "type": "string", "description": "Blob name to retrieve" }, "includeContent": { "type": "boolean", "default": true, "description": "Whether to include blob content in response" }, "includeMetadata": { "type": "boolean", "default": true, "description": "Whether to include blob metadata" } }, "required": [ "PCID", "containerName", "blobName" ] } ``` *** ## azure\_storage\_list\_blobs List blobs in an Azure Storage container **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `containerName` | string | Yes | — | Container name to list blobs from | | `prefix` | string | No | — | Filter blobs by name prefix | | `maxResults` | number | No | `5000` | Maximum number of blobs to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "containerName": { "type": "string", "description": "Container name to list blobs from" }, "prefix": { "type": "string", "description": "Filter blobs by name prefix" }, "maxResults": { "type": "number", "default": 5000, "description": "Maximum number of blobs to return" } }, "required": [ "PCID", "containerName" ] } ``` *** ## azure\_storage\_list\_containers List all containers in the Azure Storage account **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `prefix` | string | No | — | Filter containers by name prefix | | `maxResults` | number | No | `5000` | Maximum number of containers to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "prefix": { "type": "string", "description": "Filter containers by name prefix" }, "maxResults": { "type": "number", "default": 5000, "description": "Maximum number of containers to return" } }, "required": [ "PCID" ] } ``` *** ## azure\_storage\_set\_blob\_metadata Set metadata for an existing blob **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `containerName` | string | Yes | — | Container name | | `blobName` | string | Yes | — | Blob name | | `metadata` | object | Yes | — | Metadata key-value pairs to set | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "containerName": { "type": "string", "description": "Container name" }, "blobName": { "type": "string", "description": "Blob name" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Metadata key-value pairs to set" } }, "required": [ "PCID", "containerName", "blobName", "metadata" ] } ``` *** ## azure\_storage\_upload\_blob Upload a blob to Azure Storage container **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `containerName` | string | Yes | — | Container name to upload to | | `blobName` | string | Yes | — | Name for the blob | | `content` | string | Yes | — | Content to upload (base64 encoded for binary) | | `contentType` | string | No | — | MIME type of the content | | `metadata` | object | No | — | Metadata key-value pairs for the blob | | `overwrite` | boolean | No | `false` | Whether to overwrite existing blob | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID" }, "containerName": { "type": "string", "description": "Container name to upload to" }, "blobName": { "type": "string", "description": "Name for the blob" }, "content": { "type": "string", "description": "Content to upload (base64 encoded for binary)" }, "contentType": { "type": "string", "description": "MIME type of the content" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Metadata key-value pairs for the blob" }, "overwrite": { "type": "boolean", "default": false, "description": "Whether to overwrite existing blob" } }, "required": [ "PCID", "containerName", "blobName", "content" ] } ``` # babel-street Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/babel-street Babel Street Text Analytics **Server path:** `/babel-street` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`babel_street_get_address_similarity_supported_languages`](#babel_street_get_address_similarity_supported_languages) | Supported languages | | [`babel_street_get_categories_supported_languages`](#babel_street_get_categories_supported_languages) | Supported languages | | [`babel_street_get_entities_indoc_coref_server_supported_languages`](#babel_street_get_entities_indoc_coref_server_supported_languages) | Indoc coref supported languages | | [`babel_street_get_entities_info`](#babel_street_get_entities_info) | Returns a list of entity types | | [`babel_street_get_entities_supported_languages`](#babel_street_get_entities_supported_languages) | Supported languages | | [`babel_street_get_events_info`](#babel_street_get_events_info) | Returns event schemas. | | [`babel_street_get_events_supported_languages`](#babel_street_get_events_supported_languages) | Supported languages | | [`babel_street_get_info`](#babel_street_get_info) | Babel Street Analytics information | | [`babel_street_get_language_supported_languages`](#babel_street_get_language_supported_languages) | Supported languages | | [`babel_street_get_morphology_morphofeature_supported_languages`](#babel_street_get_morphology_morphofeature_supported_languages) | Supported languages | | [`babel_street_get_morphology_supported_languages`](#babel_street_get_morphology_supported_languages) | Supported languages | | [`babel_street_get_name_deduplication_supported_languages`](#babel_street_get_name_deduplication_supported_languages) | Supported languages | | [`babel_street_get_name_similarity_supported_languages`](#babel_street_get_name_similarity_supported_languages) | Supported languages | | [`babel_street_get_name_translation_supported_languages`](#babel_street_get_name_translation_supported_languages) | Supported languages | | [`babel_street_get_record_similarity_supported_languages`](#babel_street_get_record_similarity_supported_languages) | Supported languages | | [`babel_street_get_relationships_supported_languages`](#babel_street_get_relationships_supported_languages) | Supported languages | | [`babel_street_get_semantics_similar_supported_languages`](#babel_street_get_semantics_similar_supported_languages) | Supported languages | | [`babel_street_get_semantics_vector_supported_languages`](#babel_street_get_semantics_vector_supported_languages) | Supported languages | | [`babel_street_get_sentences_supported_languages`](#babel_street_get_sentences_supported_languages) | Supported languages | | [`babel_street_get_sentiment_supported_languages`](#babel_street_get_sentiment_supported_languages) | Supported languages | | [`babel_street_get_syntax_dependencies_supported_languages`](#babel_street_get_syntax_dependencies_supported_languages) | Supported languages | | [`babel_street_get_tokens_supported_languages`](#babel_street_get_tokens_supported_languages) | Supported languages | | [`babel_street_get_topics_supported_languages`](#babel_street_get_topics_supported_languages) | Supported languages | | [`babel_street_get_transliteration_supported_languages`](#babel_street_get_transliteration_supported_languages) | Supported languages | | [`babel_street_post_address_similarity`](#babel_street_post_address_similarity) | Match addresses from input | | [`babel_street_post_categories`](#babel_street_post_categories) | Identify contextual categories in the input. | | [`babel_street_post_entities`](#babel_street_post_entities) | Extracts entities from a document and links them to a knowledge base. | | [`babel_street_post_entities_configuration_gazetteer_add`](#babel_street_post_entities_configuration_gazetteer_add) | Add gazetteer entries for entity extraction | | [`babel_street_post_events`](#babel_street_post_events) | Extracts events from a document. | | [`babel_street_post_language`](#babel_street_post_language) | Identifies the language(s) in a document | | [`babel_street_post_morphology_morphofeature`](#babel_street_post_morphology_morphofeature) | Runs morphological analysis on input | | [`babel_street_post_name_deduplication`](#babel_street_post_name_deduplication) | Deduplicates names from input | | [`babel_street_post_name_similarity`](#babel_street_post_name_similarity) | Match names from input | | [`babel_street_post_name_translation`](#babel_street_post_name_translation) | Translate names from input | | [`babel_street_post_record_similarity`](#babel_street_post_record_similarity) | Match pairs of records | | [`babel_street_post_relationships`](#babel_street_post_relationships) | Extract relationships from input | | [`babel_street_post_semantics_similar`](#babel_street_post_semantics_similar) | Finds terms similar to the input | | [`babel_street_post_semantics_vector`](#babel_street_post_semantics_vector) | Create embeddings from input | | [`babel_street_post_sentences`](#babel_street_post_sentences) | Determine sentences | | [`babel_street_post_sentiment`](#babel_street_post_sentiment) | Analyze sentiment of input | | [`babel_street_post_syntax_dependencies`](#babel_street_post_syntax_dependencies) | Create dependency data from input | | [`babel_street_post_tokens`](#babel_street_post_tokens) | Tokenize input | | [`babel_street_post_topics`](#babel_street_post_topics) | Extract topics from input | | [`babel_street_post_transliteration`](#babel_street_post_transliteration) | Runs transliteration on input | *** ## babel\_street\_get\_address\_similarity\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_categories\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_entities\_indoc\_coref\_server\_supported\_languages Indoc coref supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_entities\_info Returns a list of entity types **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `profileId` | string | No | — | The id of the custom profile you are querying. This parameter is optional and for on-premise installations only. | | `perSubsourceSupportedEntityTypes` | boolean | No | — | When set to true returns the entity types by subsource in addition to by processor. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "profileId": { "type": "string", "description": "The id of the custom profile you are querying. This parameter is optional and for on-premise installations only." }, "perSubsourceSupportedEntityTypes": { "type": "boolean", "description": "When set to true returns the entity types by subsource in addition to by processor." } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_entities\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_events\_info Returns event schemas. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspaceId` | string | No | — | The workspace id for a specific model installed on the server. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspaceId": { "type": "string", "description": "The workspace id for a specific model installed on the server." } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_events\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_info Babel Street Analytics information ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_language\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_morphology\_morphofeature\_supported\_languages Supported languages **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `morphoFeature` | string | Yes | — | Morpho Feature | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "morphoFeature": { "type": "string", "description": "Morpho Feature", "enum": [ "complete", "lemmas", "parts-of-speech", "compound-components", "han-readings" ] } }, "required": [ "PCID", "morphoFeature" ] } ``` *** ## babel\_street\_get\_morphology\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_name\_deduplication\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_name\_similarity\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_name\_translation\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_record\_similarity\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_relationships\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_semantics\_similar\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_semantics\_vector\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_sentences\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_sentiment\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_syntax\_dependencies\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_tokens\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_topics\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_get\_transliteration\_supported\_languages Supported languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_address\_similarity Match addresses from input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `address1` | object | No | — | The address1 value | | `address2` | object | No | — | The address2 value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "address1": { "description": "The address1 value" }, "address2": { "description": "The address2 value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_categories Identify contextual categories in the input. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_entities Extracts entities from a document and links them to a knowledge base. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `output` | string | No | — | When set to Rosette, output is ADM format. Required to see entity mentions from indoc coref. | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "output": { "type": "string", "description": "When set to Rosette, output is ADM format. Required to see entity mentions from indoc coref." }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_entities\_configuration\_gazetteer\_add Add gazetteer entries for entity extraction **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `configuration` | object | No | — | The configuration value | | `language` | string | No | — | 3 letter code of language. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "configuration": { "description": "The configuration value" }, "language": { "type": "string", "description": "3 letter code of language." } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_events Extracts events from a document. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_language Identifies the language(s) in a document **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_morphology\_morphofeature Runs morphological analysis on input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `morphoFeature` | string | Yes | — | Type of data to return | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "morphoFeature": { "type": "string", "description": "Type of data to return", "enum": [ "complete", "lemmas", "parts-of-speech", "compound-components", "han-readings" ] }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID", "morphoFeature" ] } ``` *** ## babel\_street\_post\_name\_deduplication Deduplicates names from input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `names` | object\[] | No | — | List of names to deduplicate | | `threshold` | number | No | — | The threshold value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "names": { "type": "array", "items": { "type": "object", "properties": { "entityType": { "type": "string", "enum": [ "PERSON", "LOCATION", "ORGANIZATION" ], "description": "the entity type of the object" }, "language": { "type": "string", "description": "ISO 639-3 code for the name's language" }, "script": { "type": "string", "description": "ISSO 15924 code for the name's script" }, "text": { "type": "string", "description": "a name to be matched" } } }, "description": "List of names to deduplicate" }, "threshold": { "type": "number", "description": "The threshold value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_name\_similarity Match names from input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name1` | object | No | — | The name1 value | | `name2` | object | No | — | The name2 value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name1": { "type": "object", "description": "The name1 value", "properties": { "entityType": { "type": "string", "description": "the entity type of the object", "enum": [ "PERSON", "LOCATION", "ORGANIZATION" ] }, "language": { "type": "string", "description": "ISO 639-3 code for the name's language" }, "script": { "type": "string", "description": "ISSO 15924 code for the name's script" }, "text": { "type": "string", "description": "a name to be matched" }, "gender": { "type": "string", "description": "explicit gender of the name", "enum": [ "MALE", "FEMALE", "NONBINARY" ] } } }, "name2": { "type": "object", "description": "The name2 value", "properties": { "entityType": { "type": "string", "description": "the entity type of the object", "enum": [ "PERSON", "LOCATION", "ORGANIZATION" ] }, "language": { "type": "string", "description": "ISO 639-3 code for the name's language" }, "script": { "type": "string", "description": "ISSO 15924 code for the name's script" }, "text": { "type": "string", "description": "a name to be matched" }, "gender": { "type": "string", "description": "explicit gender of the name", "enum": [ "MALE", "FEMALE", "NONBINARY" ] } } } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_name\_translation Translate names from input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `entityType` | string | No | — | the entity type of the object | | `maximumResults` | number | No | — | Maximum Results | | `name` | string | No | — | The name to translate | | `sourceLanguageOfOrigin` | string | No | — | ISO 639-3 code for the name's language | | `sourceLanguageOfUse` | string | No | — | ISO 639-3 code for the name's language | | `sourceScript` | string | No | — | ISSO 15924 code for the name's script | | `targetLanguage` | string | No | — | ISO 639-3 code for the name's language | | `targetScheme` | string | No | — | transliteration schme for the translation | | `targetScript` | string | No | — | ISSO 15924 code for the name's script | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entityType": { "type": "string", "description": "the entity type of the object", "enum": [ "PERSON", "LOCATION", "ORGANIZATION" ] }, "maximumResults": { "type": "number", "description": "Maximum Results" }, "name": { "type": "string", "description": "The name to translate" }, "sourceLanguageOfOrigin": { "type": "string", "description": "ISO 639-3 code for the name's language" }, "sourceLanguageOfUse": { "type": "string", "description": "ISO 639-3 code for the name's language" }, "sourceScript": { "type": "string", "description": "ISSO 15924 code for the name's script" }, "targetLanguage": { "type": "string", "description": "ISO 639-3 code for the name's language" }, "targetScheme": { "type": "string", "description": "transliteration schme for the translation" }, "targetScript": { "type": "string", "description": "ISSO 15924 code for the name's script" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_record\_similarity Match pairs of records **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | object | No | — | The fields value | | `properties` | object | No | — | The properties value | | `records` | object | No | — | The records value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "object", "description": "The fields value", "properties": { "fieldname": { "type": "object", "description": "The fieldname value" } } }, "properties": { "type": "object", "description": "The properties value", "properties": { "threshold": { "type": "number", "description": "results must be greater than threshold to be returned" }, "includeExplainInfo": { "type": "boolean", "description": "true returns the full details of how the records matched" } } }, "records": { "type": "object", "description": "The records value", "properties": { "left": { "type": "array", "items": { "type": "array" }, "description": "The left value" }, "right": { "type": "array", "items": { "type": "array" }, "description": "The right value" } } } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_relationships Extract relationships from input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_semantics\_similar Finds terms similar to the input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_semantics\_vector Create embeddings from input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_sentences Determine sentences **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_sentiment Analyze sentiment of input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_syntax\_dependencies Create dependency data from input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_tokens Tokenize input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_topics Extract topics from input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID" ] } ``` *** ## babel\_street\_post\_transliteration Runs transliteration on input **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `content` | string | No | — | Raw text content to analyze | | `contentUri` | string | No | — | URI pointing to the content to analyze | | `language` | string | No | — | 3 letter code of language. | | `options` | object | No | — | The options value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "content": { "type": "string", "description": "Raw text content to analyze" }, "contentUri": { "type": "string", "description": "URI pointing to the content to analyze" }, "language": { "type": "string", "description": "3 letter code of language." }, "options": { "description": "The options value" } }, "required": [ "PCID" ] } ``` # bamboohr Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bamboohr BambooHR - HR management platform for employees, time tracking, compensation, and talent **PinkConnect service:** `bamboohr` | **Type:** Application (parent with child servers) | **PCID required:** Yes bamboohr is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [bamboohr-compensation](/api-reference/mcp-servers/application/bamboohr/bamboohr-compensation) | `/bamboohr-compensation` | 32 | BambooHR Compensation - compensation planning, benchmarking, and benefits | | [bamboohr-data](/api-reference/mcp-servers/application/bamboohr/bamboohr-data) | `/bamboohr-data` | 14 | BambooHR Data - datasets, reports, and webhooks | | [bamboohr-employees](/api-reference/mcp-servers/application/bamboohr/bamboohr-employees) | `/bamboohr-employees` | 45 | BambooHR Employees - manage employees, files, company profile, locations, and tabular data | | [bamboohr-talent](/api-reference/mcp-servers/application/bamboohr/bamboohr-talent) | `/bamboohr-talent` | 41 | BambooHR Talent - goals, training, and applicant tracking | | [bamboohr-time](/api-reference/mcp-servers/application/bamboohr/bamboohr-time) | `/bamboohr-time` | 45 | BambooHR Time - time tracking, time off requests, and hour records | # bamboohr-compensation Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bamboohr/bamboohr-compensation BambooHR Compensation - compensation planning, benchmarking, and benefits **Server path:** `/bamboohr-compensation` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bamboohr_compensation_create_compensation_benchmark`](#bamboohr_compensation_create_compensation_benchmark) | Create Compensation Benchmark | | [`bamboohr_compensation_create_compensation_benchmark_source`](#bamboohr_compensation_create_compensation_benchmark_source) | Create Compensation Benchmark Source | | [`bamboohr_compensation_create_employee_dependent`](#bamboohr_compensation_create_employee_dependent) | Create Employee Dependent | | [`bamboohr_compensation_delete_benchmark`](#bamboohr_compensation_delete_benchmark) | Delete Compensation Benchmark | | [`bamboohr_compensation_delete_benchmark_source`](#bamboohr_compensation_delete_benchmark_source) | Delete Compensation Benchmark Source | | [`bamboohr_compensation_export_compensation_benchmark_details`](#bamboohr_compensation_export_compensation_benchmark_details) | Export Compensation Benchmark Details | | [`bamboohr_compensation_get_benchmark_details`](#bamboohr_compensation_get_benchmark_details) | Get Compensation Benchmark Details | | [`bamboohr_compensation_get_employee_dependent`](#bamboohr_compensation_get_employee_dependent) | Get Employee Dependent | | [`bamboohr_compensation_get_planning_cycles`](#bamboohr_compensation_get_planning_cycles) | Get compensation planning cycle details | | [`bamboohr_compensation_import_compensation_benchmarks`](#bamboohr_compensation_import_compensation_benchmarks) | Import Compensation Benchmarks From CSV | | [`bamboohr_compensation_list_benefit_coverages`](#bamboohr_compensation_list_benefit_coverages) | List Benefit Coverages | | [`bamboohr_compensation_list_benefit_deduction_types`](#bamboohr_compensation_list_benefit_deduction_types) | List Benefit Deduction Types | | [`bamboohr_compensation_list_company_benefits`](#bamboohr_compensation_list_company_benefits) | List Company Benefits | | [`bamboohr_compensation_list_compensation_benchmark_sources`](#bamboohr_compensation_list_compensation_benchmark_sources) | List Compensation Benchmark Sources | | [`bamboohr_compensation_list_compensation_benchmarks`](#bamboohr_compensation_list_compensation_benchmarks) | List Compensation Benchmarks | | [`bamboohr_compensation_list_compensation_equity_settings`](#bamboohr_compensation_list_compensation_equity_settings) | Get company equity settings | | [`bamboohr_compensation_list_compensation_planning_cycles`](#bamboohr_compensation_list_compensation_planning_cycles) | List compensation planning cycles | | [`bamboohr_compensation_list_compensation_planning_cycles_admins`](#bamboohr_compensation_list_compensation_planning_cycles_admins) | List compensation planning cycle admins | | [`bamboohr_compensation_list_compensation_planning_cycles_approvals`](#bamboohr_compensation_list_compensation_planning_cycles_approvals) | Get compensation planning approval flows | | [`bamboohr_compensation_list_compensation_planning_cycles_budgets`](#bamboohr_compensation_list_compensation_planning_cycles_budgets) | Get compensation planning cycle budgets | | [`bamboohr_compensation_list_compensation_planning_cycles_change_comm`](#bamboohr_compensation_list_compensation_planning_cycles_change_comm) | Get change communication letter details | | [`bamboohr_compensation_list_compensation_planning_cycles_employees`](#bamboohr_compensation_list_compensation_planning_cycles_employees) | List employees in compensation planning cycle | | [`bamboohr_compensation_list_compensation_planning_cycles_summary`](#bamboohr_compensation_list_compensation_planning_cycles_summary) | Get compensation planning cycle summary | | [`bamboohr_compensation_list_compensation_planning_cycles_worksheet`](#bamboohr_compensation_list_compensation_planning_cycles_worksheet) | Get compensation planning cycle worksheet | | [`bamboohr_compensation_list_compensation_planning_cycles_worksheet_export`](#bamboohr_compensation_list_compensation_planning_cycles_worksheet_export) | Export compensation planning cycle worksheet to CSV | | [`bamboohr_compensation_list_employee_benefits`](#bamboohr_compensation_list_employee_benefits) | List Employee Benefits | | [`bamboohr_compensation_list_employee_dependents`](#bamboohr_compensation_list_employee_dependents) | List Employee Dependents | | [`bamboohr_compensation_list_member_benefit_events`](#bamboohr_compensation_list_member_benefit_events) | List Member Benefit Events | | [`bamboohr_compensation_list_member_benefits`](#bamboohr_compensation_list_member_benefits) | List Member Benefits | | [`bamboohr_compensation_update_compensation_benchmark`](#bamboohr_compensation_update_compensation_benchmark) | Update Compensation Benchmark | | [`bamboohr_compensation_update_compensation_benchmark_sources`](#bamboohr_compensation_update_compensation_benchmark_sources) | Update Compensation Benchmark Sources | | [`bamboohr_compensation_update_employee_dependent`](#bamboohr_compensation_update_employee_dependent) | Update Employee Dependent | *** ## bamboohr\_compensation\_create\_compensation\_benchmark Create Compensation Benchmark **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `benchmarkMax` | number | Yes | — | Benchmark maximum value. | | `benchmarkMin` | number | Yes | — | Benchmark minimum value. | | `benchmarkSource` | string | No | — | Free-text label describing where the benchmark came from. | | `benchmarkValue` | number | Yes | — | Benchmark median value. | | `companiesSurveyed` | integer | No | — | Companies Surveyed | | `currencyCode` | string | Yes | — | ISO 4217 currency code for the benchmark values. | | `dataYear` | string | No | — | Year of the underlying survey data. | | `employeesSurveyed` | integer | No | — | Employees Surveyed | | `externalCompanySize` | string | No | — | External Company Size | | `externalCountry` | string | No | — | External Country | | `externalIndustry` | string | No | — | External Industry | | `externalJobDescription` | string | No | — | External Job Description | | `externalJobTitle` | string | No | — | External Job Title | | `externalLevel` | string | No | — | External Level | | `externalLocation` | string | No | — | External Location | | `externalSecondaryLocation` | string | No | — | External Secondary Location | | `jobLocationId` | string | No | — | Optional job location ID to scope the benchmark to a specific location. | | `jobTitleId` | string | Yes | — | ID of the company job title the benchmark applies to. | | `mjlJobCode` | string | No | — | Mercer Job Library code associated with this benchmark. Stored on the benchmark as `mercerJobCode`. | | `sourceDate` | string | No | — | Date the benchmark source data applies to. | | `sourceId` | string | No | — | ID of the benchmark source from `GET /api/v1/compensation/benchmarks/sources`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "benchmarkMax": { "type": "number", "description": "Benchmark maximum value." }, "benchmarkMin": { "type": "number", "description": "Benchmark minimum value." }, "benchmarkSource": { "type": "string", "description": "Free-text label describing where the benchmark came from." }, "benchmarkValue": { "type": "number", "description": "Benchmark median value." }, "companiesSurveyed": { "type": "integer", "description": "Companies Surveyed" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code for the benchmark values." }, "dataYear": { "type": "string", "description": "Year of the underlying survey data." }, "employeesSurveyed": { "type": "integer", "description": "Employees Surveyed" }, "externalCompanySize": { "type": "string", "description": "External Company Size" }, "externalCountry": { "type": "string", "description": "External Country" }, "externalIndustry": { "type": "string", "description": "External Industry" }, "externalJobDescription": { "type": "string", "description": "External Job Description" }, "externalJobTitle": { "type": "string", "description": "External Job Title" }, "externalLevel": { "type": "string", "description": "External Level" }, "externalLocation": { "type": "string", "description": "External Location" }, "externalSecondaryLocation": { "type": "string", "description": "External Secondary Location" }, "jobLocationId": { "type": "string", "description": "Optional job location ID to scope the benchmark to a specific location." }, "jobTitleId": { "type": "string", "description": "ID of the company job title the benchmark applies to." }, "mjlJobCode": { "type": "string", "description": "Mercer Job Library code associated with this benchmark. Stored on the benchmark as `mercerJobCode`." }, "sourceDate": { "type": "string", "description": "Date the benchmark source data applies to." }, "sourceId": { "type": "string", "description": "ID of the benchmark source from `GET /api/v1/compensation/benchmarks/sources`." } }, "required": [ "PCID", "benchmarkMax", "benchmarkMin", "benchmarkValue", "currencyCode", "jobTitleId" ] } ``` *** ## bamboohr\_compensation\_create\_compensation\_benchmark\_source Create Compensation Benchmark Source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `colorCode` | string | No | — | Optional hex color used to display the source in the UI. | | `name` | string | Yes | — | Display name for the new benchmark source. Cannot be empty or equal to `mercer`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "colorCode": { "type": "string", "description": "Optional hex color used to display the source in the UI." }, "name": { "type": "string", "description": "Display name for the new benchmark source. Cannot be empty or equal to `mercer`." } }, "required": [ "PCID", "name" ] } ``` *** ## bamboohr\_compensation\_create\_employee\_dependent Create Employee Dependent **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `addressLine1` | string | No | — | The first line of the dependent's address. | | `addressLine2` | string | No | — | The second line of the dependent's address. | | `city` | string | No | — | The dependent's city. | | `country` | string | No | — | The dependent's country, provided as an ISO 3166-1 alpha-2 country code (e.g. "US"). Returned as a full country name on read. | | `dateOfBirth` | string | No | — | The dependent's date of birth in YYYY-MM-DD format. | | `employeeId` | string | Yes | — | The ID of the employee this dependent belongs to. Required. | | `firstName` | string | No | — | The dependent's first name. | | `gender` | string | No | — | The dependent's gender. | | `homePhone` | string | No | — | The dependent's home phone number. | | `isStudent` | string | No | — | Whether the dependent is currently a student. Accepted values: "yes" or "no". | | `isUsCitizen` | string | No | — | Whether the dependent is a US citizen. Accepted values: "yes" or "no". | | `lastName` | string | No | — | The dependent's last name. | | `middleName` | string | No | — | The dependent's middle name. | | `relationship` | string | No | — | The dependent's relationship to the employee (e.g. "spouse", "child", "domestic\_partner"). | | `sin` | string | No | — | The dependent's Social Insurance Number (Canadian equivalent of SSN), provided as plain text. Stored encrypted. Returned as a masked value on read. | | `ssn` | string | No | — | The dependent's Social Security Number, provided as plain text. Stored encrypted. Returned as a masked value (e.g. "xxx-xx-1234") on read. | | `state` | string | No | — | The dependent's state, provided as a state code (e.g. "UT"). Returned as a full state name on read. | | `zipCode` | string | No | — | The dependent's ZIP or postal code. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "addressLine1": { "type": "string", "description": "The first line of the dependent's address." }, "addressLine2": { "type": "string", "description": "The second line of the dependent's address." }, "city": { "type": "string", "description": "The dependent's city." }, "country": { "type": "string", "description": "The dependent's country, provided as an ISO 3166-1 alpha-2 country code (e.g. \"US\"). Returned as a full country name on read." }, "dateOfBirth": { "type": "string", "description": "The dependent's date of birth in YYYY-MM-DD format." }, "employeeId": { "type": "string", "description": "The ID of the employee this dependent belongs to. Required." }, "firstName": { "type": "string", "description": "The dependent's first name." }, "gender": { "type": "string", "description": "The dependent's gender." }, "homePhone": { "type": "string", "description": "The dependent's home phone number." }, "isStudent": { "type": "string", "description": "Whether the dependent is currently a student. Accepted values: \"yes\" or \"no\".", "enum": [ "yes", "no" ] }, "isUsCitizen": { "type": "string", "description": "Whether the dependent is a US citizen. Accepted values: \"yes\" or \"no\".", "enum": [ "yes", "no" ] }, "lastName": { "type": "string", "description": "The dependent's last name." }, "middleName": { "type": "string", "description": "The dependent's middle name." }, "relationship": { "type": "string", "description": "The dependent's relationship to the employee (e.g. \"spouse\", \"child\", \"domestic_partner\")." }, "sin": { "type": "string", "description": "The dependent's Social Insurance Number (Canadian equivalent of SSN), provided as plain text. Stored encrypted. Returned as a masked value on read." }, "ssn": { "type": "string", "description": "The dependent's Social Security Number, provided as plain text. Stored encrypted. Returned as a masked value (e.g. \"xxx-xx-1234\") on read." }, "state": { "type": "string", "description": "The dependent's state, provided as a state code (e.g. \"UT\"). Returned as a full state name on read." }, "zipCode": { "type": "string", "description": "The dependent's ZIP or postal code." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_compensation\_delete\_benchmark Delete Compensation Benchmark **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | Integer ID of the compensation benchmark to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Integer ID of the compensation benchmark to delete." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_delete\_benchmark\_source Delete Compensation Benchmark Source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | ID of the benchmark source to delete. Must be non-empty. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "ID of the benchmark source to delete. Must be non-empty." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_export\_compensation\_benchmark\_details Export Compensation Benchmark Details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `jobId` | string | Yes | — | ID of the company job title to export benchmark details for. | | `locationId` | string | No | — | Optional job location ID to restrict the export to one location. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "ID of the company job title to export benchmark details for." }, "locationId": { "type": "string", "description": "Optional job location ID to restrict the export to one location." } }, "required": [ "PCID", "jobId" ] } ``` *** ## bamboohr\_compensation\_get\_benchmark\_details Get Compensation Benchmark Details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `jobId` | string | Yes | — | ID of the company job title to fetch benchmark details for. | | `locationId` | string | No | — | Optional job location ID. When omitted, results aggregate across all locations for the job. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "ID of the company job title to fetch benchmark details for." }, "locationId": { "type": "string", "description": "Optional job location ID. When omitted, results aggregate across all locations for the job." } }, "required": [ "PCID", "jobId" ] } ``` *** ## bamboohr\_compensation\_get\_employee\_dependent Get Employee Dependent **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | | `id` | integer | Yes | — | The numeric ID of the employee dependent to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] }, "id": { "type": "integer", "description": "The numeric ID of the employee dependent to retrieve." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_get\_planning\_cycles Get compensation planning cycle details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_import\_compensation\_benchmarks Import Compensation Benchmarks From CSV **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `file` | string | Yes | — | CSV file to import. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file": { "type": "string", "description": "CSV file to import." } }, "required": [ "PCID", "file" ] } ``` *** ## bamboohr\_compensation\_list\_benefit\_coverages List Benefit Coverages **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_compensation\_list\_benefit\_deduction\_types List Benefit Deduction Types ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_compensation\_list\_company\_benefits List Company Benefits ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_benchmark\_sources List Compensation Benchmark Sources ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_benchmarks List Compensation Benchmarks ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_equity\_settings Get company equity settings ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_planning\_cycles List compensation planning cycles ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_planning\_cycles\_admins List compensation planning cycle admins **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_planning\_cycles\_approvals Get compensation planning approval flows **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | | `groupBy` | string | No | — | Optional grouping for flows (e.g. department) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" }, "groupBy": { "type": "string", "description": "Optional grouping for flows (e.g. department)" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_planning\_cycles\_budgets Get compensation planning cycle budgets **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_planning\_cycles\_change\_comm Get change communication letter details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_planning\_cycles\_employees List employees in compensation planning cycle **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_planning\_cycles\_summary Get compensation planning cycle summary **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_planning\_cycles\_worksheet Get compensation planning cycle worksheet **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | | `type` | string | No | — | Worksheet context: recommendations, approvals, or overview (overview requires cycle admin). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" }, "type": { "type": "string", "description": "Worksheet context: recommendations, approvals, or overview (overview requires cycle admin).", "enum": [ "recommendations", "approvals", "overview" ] } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_list\_compensation\_planning\_cycles\_worksheet\_export Export compensation planning cycle worksheet to CSV **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | | `type` | string | No | — | Worksheet context: recommendations, approvals, or overview (overview requires cycle admin). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" }, "type": { "type": "string", "description": "Worksheet context: recommendations, approvals, or overview (overview requires cycle admin).", "enum": [ "recommendations", "approvals", "overview" ] } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_list\_employee\_benefits List Employee Benefits **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filters` | object | Yes | — | Scope filters for the request. At least one of employeeId, companyBenefitId, or enrollmentStatusEffectiveDate must be provided; omitting all three returns a 400 validation error. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filters": { "type": "object", "description": "Scope filters for the request. At least one of employeeId, companyBenefitId, or enrollmentStatusEffectiveDate must be provided; omitting all three returns a 400 validation error.", "properties": { "employeeId": { "type": "integer", "description": "Return benefit enrollments for a specific employee identified by their numeric ID." }, "companyBenefitId": { "type": "integer", "description": "Return benefit enrollments for a specific company benefit plan identified by its numeric ID." }, "enrollmentStatusEffectiveDate": { "type": "string", "description": "Return benefit enrollments whose enrollment status became effective on this date. Must be in YYYY-MM-DD format." } } } }, "required": [ "PCID", "filters" ] } ``` *** ## bamboohr\_compensation\_list\_employee\_dependents List Employee Dependents **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | | `employeeid` | integer | No | — | The employee ID to filter dependents by. When provided, only dependents for that employee are returned. When omitted, all company dependents are returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] }, "employeeid": { "type": "integer", "description": "The employee ID to filter dependents by. When provided, only dependents for that employee are returned. When omitted, all company dependents are returned." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_compensation\_list\_member\_benefit\_events List Member Benefit Events ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_compensation\_list\_member\_benefits List Member Benefits **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `calendarYear` | string | Yes | — | The 4-digit calendar year (YYYY) to retrieve benefit enrollment data for. | | `page` | string | No | — | The 1-based page number for pagination. The value is cast to an integer; values that cast to 0 or below are rejected with a 400. Defaults to 1. | | `pageSize` | string | No | — | The number of items per page. The value is cast to an integer; values that cast to 0 or below, or to 100 or above, are rejected with a 400. Defaults to 25. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "calendarYear": { "type": "string", "description": "The 4-digit calendar year (YYYY) to retrieve benefit enrollment data for." }, "page": { "type": "string", "description": "The 1-based page number for pagination. The value is cast to an integer; values that cast to 0 or below are rejected with a 400. Defaults to 1." }, "pageSize": { "type": "string", "description": "The number of items per page. The value is cast to an integer; values that cast to 0 or below, or to 100 or above, are rejected with a 400. Defaults to 25." } }, "required": [ "PCID", "calendarYear" ] } ``` *** ## bamboohr\_compensation\_update\_compensation\_benchmark Update Compensation Benchmark **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `benchmarkMax` | number | No | — | Benchmark maximum value. | | `benchmarkMin` | number | No | — | Benchmark minimum value. | | `benchmarkSource` | string | No | — | Free-text label describing where the benchmark came from. | | `benchmarkValue` | number | No | — | Benchmark median value. | | `companiesSurveyed` | integer | No | — | Companies Surveyed | | `currencyCode` | string | No | — | ISO 4217 currency code for the benchmark values. | | `dataYear` | string | No | — | Year of the underlying survey data. Omitting this field clears `data_year` on the stored benchmark, so callers updating a Mercer benchmark should resend the existing value. | | `employeesSurveyed` | integer | No | — | Employees Surveyed | | `externalCompanySize` | string | No | — | External Company Size | | `externalCountry` | string | No | — | External Country | | `externalIndustry` | string | No | — | External Industry | | `externalJobDescription` | string | No | — | External Job Description | | `externalJobTitle` | string | No | — | External Job Title | | `externalLevel` | string | No | — | External Level | | `externalLocation` | string | No | — | External Location | | `externalSecondaryLocation` | string | No | — | External Secondary Location | | `id` | string | Yes | — | ID of the benchmark to update. | | `mjlJobCode` | string | No | — | Mercer Job Library code associated with this benchmark. Stored on the benchmark as `mercerJobCode`. | | `sourceDate` | string | No | — | Date the benchmark source data applies to. | | `sourceId` | string | No | — | ID of the benchmark source from `GET /api/v1/compensation/benchmarks/sources`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "benchmarkMax": { "type": "number", "description": "Benchmark maximum value." }, "benchmarkMin": { "type": "number", "description": "Benchmark minimum value." }, "benchmarkSource": { "type": "string", "description": "Free-text label describing where the benchmark came from." }, "benchmarkValue": { "type": "number", "description": "Benchmark median value." }, "companiesSurveyed": { "type": "integer", "description": "Companies Surveyed" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code for the benchmark values." }, "dataYear": { "type": "string", "description": "Year of the underlying survey data. Omitting this field clears `data_year` on the stored benchmark, so callers updating a Mercer benchmark should resend the existing value." }, "employeesSurveyed": { "type": "integer", "description": "Employees Surveyed" }, "externalCompanySize": { "type": "string", "description": "External Company Size" }, "externalCountry": { "type": "string", "description": "External Country" }, "externalIndustry": { "type": "string", "description": "External Industry" }, "externalJobDescription": { "type": "string", "description": "External Job Description" }, "externalJobTitle": { "type": "string", "description": "External Job Title" }, "externalLevel": { "type": "string", "description": "External Level" }, "externalLocation": { "type": "string", "description": "External Location" }, "externalSecondaryLocation": { "type": "string", "description": "External Secondary Location" }, "id": { "type": "string", "description": "ID of the benchmark to update." }, "mjlJobCode": { "type": "string", "description": "Mercer Job Library code associated with this benchmark. Stored on the benchmark as `mercerJobCode`." }, "sourceDate": { "type": "string", "description": "Date the benchmark source data applies to." }, "sourceId": { "type": "string", "description": "ID of the benchmark source from `GET /api/v1/compensation/benchmarks/sources`." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_compensation\_update\_compensation\_benchmark\_sources Update Compensation Benchmark Sources **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `benchmarkSources` | object\[] | No | — | Benchmark Sources | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "benchmarkSources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the existing benchmark source to update." }, "name": { "type": "string", "description": "New display name for the source. Cannot equal `mercer`." }, "sort": { "type": "string", "description": "Optional new sort position, as a numeric string." } }, "required": [ "id", "name" ] }, "description": "Benchmark Sources" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_compensation\_update\_employee\_dependent Update Employee Dependent **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The numeric ID of the employee dependent to update. | | `addressLine1` | string | No | — | The first line of the dependent's address. | | `addressLine2` | string | No | — | The second line of the dependent's address. | | `city` | string | No | — | The dependent's city. | | `country` | string | No | — | The dependent's country, provided as an ISO 3166-1 alpha-2 country code (e.g. "US"). Returned as a full country name on read. | | `dateOfBirth` | string | No | — | The dependent's date of birth in YYYY-MM-DD format. | | `employeeId` | string | No | — | The ID of the employee this dependent belongs to. Required. | | `firstName` | string | No | — | The dependent's first name. | | `gender` | string | No | — | The dependent's gender. | | `homePhone` | string | No | — | The dependent's home phone number. | | `isStudent` | string | No | — | Whether the dependent is currently a student. Accepted values: "yes" or "no". | | `isUsCitizen` | string | No | — | Whether the dependent is a US citizen. Accepted values: "yes" or "no". | | `lastName` | string | No | — | The dependent's last name. | | `middleName` | string | No | — | The dependent's middle name. | | `relationship` | string | No | — | The dependent's relationship to the employee (e.g. "spouse", "child", "domestic\_partner"). | | `sin` | string | No | — | The dependent's Social Insurance Number (Canadian equivalent of SSN), provided as plain text. Stored encrypted. Returned as a masked value on read. | | `ssn` | string | No | — | The dependent's Social Security Number, provided as plain text. Stored encrypted. Returned as a masked value (e.g. "xxx-xx-1234") on read. | | `state` | string | No | — | The dependent's state, provided as a state code (e.g. "UT"). Returned as a full state name on read. | | `zipCode` | string | No | — | The dependent's ZIP or postal code. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The numeric ID of the employee dependent to update." }, "addressLine1": { "type": "string", "description": "The first line of the dependent's address." }, "addressLine2": { "type": "string", "description": "The second line of the dependent's address." }, "city": { "type": "string", "description": "The dependent's city." }, "country": { "type": "string", "description": "The dependent's country, provided as an ISO 3166-1 alpha-2 country code (e.g. \"US\"). Returned as a full country name on read." }, "dateOfBirth": { "type": "string", "description": "The dependent's date of birth in YYYY-MM-DD format." }, "employeeId": { "type": "string", "description": "The ID of the employee this dependent belongs to. Required." }, "firstName": { "type": "string", "description": "The dependent's first name." }, "gender": { "type": "string", "description": "The dependent's gender." }, "homePhone": { "type": "string", "description": "The dependent's home phone number." }, "isStudent": { "type": "string", "description": "Whether the dependent is currently a student. Accepted values: \"yes\" or \"no\".", "enum": [ "yes", "no" ] }, "isUsCitizen": { "type": "string", "description": "Whether the dependent is a US citizen. Accepted values: \"yes\" or \"no\".", "enum": [ "yes", "no" ] }, "lastName": { "type": "string", "description": "The dependent's last name." }, "middleName": { "type": "string", "description": "The dependent's middle name." }, "relationship": { "type": "string", "description": "The dependent's relationship to the employee (e.g. \"spouse\", \"child\", \"domestic_partner\")." }, "sin": { "type": "string", "description": "The dependent's Social Insurance Number (Canadian equivalent of SSN), provided as plain text. Stored encrypted. Returned as a masked value on read." }, "ssn": { "type": "string", "description": "The dependent's Social Security Number, provided as plain text. Stored encrypted. Returned as a masked value (e.g. \"xxx-xx-1234\") on read." }, "state": { "type": "string", "description": "The dependent's state, provided as a state code (e.g. \"UT\"). Returned as a full state name on read." }, "zipCode": { "type": "string", "description": "The dependent's ZIP or postal code." } }, "required": [ "PCID", "id" ] } ``` # bamboohr-data Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bamboohr/bamboohr-data BambooHR Data - datasets, reports, and webhooks **Server path:** `/bamboohr-data` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bamboohr_data_create_webhook`](#bamboohr_data_create_webhook) | Create Webhook | | [`bamboohr_data_delete_webhook`](#bamboohr_data_delete_webhook) | Delete Webhook | | [`bamboohr_data_get_field_options_v1_2`](#bamboohr_data_get_field_options_v1_2) | Get Field Options (v1.2) | | [`bamboohr_data_get_fields_from_dataset_v1_2`](#bamboohr_data_get_fields_from_dataset_v1_2) | Get Fields from Dataset (v1.2) | | [`bamboohr_data_get_from_dataset_v2`](#bamboohr_data_get_from_dataset_v2) | Get Data from Dataset (v2) | | [`bamboohr_data_get_post_fields`](#bamboohr_data_get_post_fields) | Get Webhook Post Fields | | [`bamboohr_data_get_report_by_id`](#bamboohr_data_get_report_by_id) | Get Report by ID | | [`bamboohr_data_get_webhook`](#bamboohr_data_get_webhook) | Get Webhook | | [`bamboohr_data_list_datasets_v1_2`](#bamboohr_data_list_datasets_v1_2) | List Datasets (v1.2) | | [`bamboohr_data_list_monitor_fields`](#bamboohr_data_list_monitor_fields) | List Monitor Fields | | [`bamboohr_data_list_reports`](#bamboohr_data_list_reports) | List Reports | | [`bamboohr_data_list_webhook_logs`](#bamboohr_data_list_webhook_logs) | List Webhook Logs | | [`bamboohr_data_list_webhooks`](#bamboohr_data_list_webhooks) | List Webhooks | | [`bamboohr_data_update_webhook`](#bamboohr_data_update_webhook) | Update Webhook | *** ## bamboohr\_data\_create\_webhook Create Webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `events` | string\[] | No | — | Events that trigger this webhook. Defaults to \['employee\_with\_fields.updated', 'employee\_with\_fields.deleted', 'employee\_with\_fields.created'] if not specified. Cannot mix employee\_with\_fields events with employee events. | | `format` | string | Yes | — | The payload format the webhook uses. Required. | | `includeCompanyDomain` | boolean | No | — | If set to true, the company domain will be added to the webhook request header. | | `monitorFields` | string\[] | No | — | A list of fields to monitor. At least one field is required to be monitored if events is empty or contains employee\_with\_fields.updated or employee.updated. | | `name` | string | Yes | — | The name of the webhook. | | `postFields` | object | No | — | An object map of field ID or alias to the external name used in the webhook payload (e.g. `{"firstName": "First Name"}`). Omit or send an empty object to include no extra fields. | | `url` | string | Yes | — | The url the webhook should send data to (must begin with https\://). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "employee_with_fields.updated", "employee_with_fields.created", "employee_with_fields.deleted", "company-integrations.updated", "employee.created", "employee.updated", "employee.deleted", "company.updated", "company.deleted" ] }, "description": "Events that trigger this webhook. Defaults to ['employee_with_fields.updated', 'employee_with_fields.deleted', 'employee_with_fields.created'] if not specified. Cannot mix employee_with_fields events with employee events." }, "format": { "type": "string", "description": "The payload format the webhook uses. Required.", "enum": [ "json", "form-encoded" ] }, "includeCompanyDomain": { "type": "boolean", "description": "If set to true, the company domain will be added to the webhook request header." }, "monitorFields": { "type": "array", "items": { "type": "string" }, "description": "A list of fields to monitor. At least one field is required to be monitored if events is empty or contains employee_with_fields.updated or employee.updated." }, "name": { "type": "string", "description": "The name of the webhook." }, "postFields": { "type": "object", "description": "An object map of field ID or alias to the external name used in the webhook payload (e.g. `{\"firstName\": \"First Name\"}`). Omit or send an empty object to include no extra fields." }, "url": { "type": "string", "description": "The url the webhook should send data to (must begin with https://)." } }, "required": [ "PCID", "format", "name", "url" ] } ``` *** ## bamboohr\_data\_delete\_webhook Delete Webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The webhook ID to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The webhook ID to delete." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_data\_get\_field\_options\_v1\_2 Get Field Options (v1.2) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `datasetName` | string | Yes | — | The name of the dataset you want to see field options for. Use "List Datasets (v1.2)" to discover available dataset names. | | `dependentFields` | object | No | — | Dependent fields and their values that affect the options of the requested fields | | `fields` | string\[] | Yes | — | List of field names to get options for | | `filters` | object | No | — | Optional filters to apply when retrieving field options. Filters limit the returned options based on other field values. The object contains a `match` key (`all` or `any`) and a `filters` array of objects with `field`, `operator`, and `value` keys. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "datasetName": { "type": "string", "description": "The name of the dataset you want to see field options for. Use \"List Datasets (v1.2)\" to discover available dataset names." }, "dependentFields": { "type": "object", "description": "Dependent fields and their values that affect the options of the requested fields" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "List of field names to get options for" }, "filters": { "type": "object", "description": "Optional filters to apply when retrieving field options. Filters limit the returned options based on other field values. The object contains a `match` key (`all` or `any`) and a `filters` array of objects with `field`, `operator`, and `value` keys." } }, "required": [ "PCID", "datasetName", "fields" ] } ``` *** ## bamboohr\_data\_get\_fields\_from\_dataset\_v1\_2 Get Fields from Dataset (v1.2) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `datasetName` | string | Yes | — | The name of the dataset to retrieve fields for. Use "List Datasets (v1.2)" to discover valid names. | | `page` | integer | No | — | The page number to retrieve. Defaults to 1. | | `page_size` | integer | No | — | The number of records to retrieve per page. Defaults to 500. Maximum is 1000. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "datasetName": { "type": "string", "description": "The name of the dataset to retrieve fields for. Use \"List Datasets (v1.2)\" to discover valid names." }, "page": { "type": "integer", "description": "The page number to retrieve. Defaults to 1." }, "page_size": { "type": "integer", "description": "The number of records to retrieve per page. Defaults to 500. Maximum is 1000." } }, "required": [ "PCID", "datasetName" ] } ``` *** ## bamboohr\_data\_get\_from\_dataset\_v2 Get Data from Dataset (v2) **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `datasetName` | string | Yes | — | The machine-readable name of the dataset to query. Use "List Datasets (v1.2)" to discover available names. | | | `fields` | string\[] | Yes | — | List of field names to return. Use "Get Fields from Dataset (v1.2)" to discover available names. | | | `filter` | string | null | No | — | OData-style filter expression. Supported operators: eq, ne, lt, le, gt, ge, and, or, in. | | `orderBy` | string | null | No | — | Comma-separated sort rules. Each rule is a field name followed by a direction (asc or desc). Sorted fields must also appear in the `fields` array. | | `page` | integer | No | — | Page number to retrieve (1-indexed). Defaults to 1. | | | `pageSize` | integer | No | — | Number of records per page. Defaults to 100. Maximum is 1000. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "datasetName": { "type": "string", "description": "The machine-readable name of the dataset to query. Use \"List Datasets (v1.2)\" to discover available names." }, "fields": { "type": "array", "items": { "type": "string" }, "description": "List of field names to return. Use \"Get Fields from Dataset (v1.2)\" to discover available names." }, "filter": { "type": [ "string", "null" ], "description": "OData-style filter expression. Supported operators: eq, ne, lt, le, gt, ge, and, or, in." }, "orderBy": { "type": [ "string", "null" ], "description": "Comma-separated sort rules. Each rule is a field name followed by a direction (asc or desc). Sorted fields must also appear in the `fields` array." }, "page": { "type": "integer", "description": "Page number to retrieve (1-indexed). Defaults to 1." }, "pageSize": { "type": "integer", "description": "Number of records per page. Defaults to 100. Maximum is 1000." } }, "required": [ "PCID", "datasetName", "fields" ] } ``` *** ## bamboohr\_data\_get\_post\_fields Get Webhook Post Fields ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_data\_get\_report\_by\_id Get Report by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `reportId` | integer | Yes | — | The numeric ID of the saved custom report to execute. | | `page` | integer | No | — | The page number to retrieve. Defaults to 1. | | `page_size` | integer | No | — | The number of records per page. Defaults to 500. Maximum is 1000. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "reportId": { "type": "integer", "description": "The numeric ID of the saved custom report to execute." }, "page": { "type": "integer", "description": "The page number to retrieve. Defaults to 1." }, "page_size": { "type": "integer", "description": "The number of records per page. Defaults to 500. Maximum is 1000." } }, "required": [ "PCID", "reportId" ] } ``` *** ## bamboohr\_data\_get\_webhook Get Webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The webhook ID to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The webhook ID to retrieve." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_data\_list\_datasets\_v1\_2 List Datasets (v1.2) ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_data\_list\_monitor\_fields List Monitor Fields ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_data\_list\_reports List Reports **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | The page number to retrieve. Out-of-range values are clamped to the nearest valid page. Defaults to 1. | | `page_size` | integer | No | — | The number of records to retrieve per page. Defaults to 500. Maximum is 1000. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "The page number to retrieve. Out-of-range values are clamped to the nearest valid page. Defaults to 1." }, "page_size": { "type": "integer", "description": "The number of records to retrieve per page. Defaults to 500. Maximum is 1000." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_data\_list\_webhook\_logs List Webhook Logs **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The webhook ID to get logs about. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The webhook ID to get logs about." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_data\_list\_webhooks List Webhooks ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_data\_update\_webhook Update Webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The webhook ID to update. | | `events` | string\[] | No | — | Events that trigger this webhook. Defaults to \['employee\_with\_fields.updated', 'employee\_with\_fields.deleted', 'employee\_with\_fields.created'] if not specified. Cannot mix employee\_with\_fields events with employee events. | | `format` | string | No | — | The payload format the webhook uses. Required. | | `includeCompanyDomain` | boolean | No | — | If set to true, the company domain will be added to the webhook request header. | | `monitorFields` | string\[] | No | — | A list of fields to monitor. At least one field is required to be monitored if events is empty or contains employee\_with\_fields.updated or employee.updated. | | `name` | string | No | — | The name of the webhook. | | `postFields` | object | No | — | An object map of field ID or alias to the external name used in the webhook payload (e.g. `{"firstName": "First Name"}`). Omit or send an empty object to include no extra fields. | | `url` | string | No | — | The url the webhook should send data to (must begin with https\://). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The webhook ID to update." }, "events": { "type": "array", "items": { "type": "string", "enum": [ "employee_with_fields.updated", "employee_with_fields.created", "employee_with_fields.deleted", "company-integrations.updated", "employee.created", "employee.updated", "employee.deleted", "company.updated", "company.deleted" ] }, "description": "Events that trigger this webhook. Defaults to ['employee_with_fields.updated', 'employee_with_fields.deleted', 'employee_with_fields.created'] if not specified. Cannot mix employee_with_fields events with employee events." }, "format": { "type": "string", "description": "The payload format the webhook uses. Required.", "enum": [ "json", "form-encoded" ] }, "includeCompanyDomain": { "type": "boolean", "description": "If set to true, the company domain will be added to the webhook request header." }, "monitorFields": { "type": "array", "items": { "type": "string" }, "description": "A list of fields to monitor. At least one field is required to be monitored if events is empty or contains employee_with_fields.updated or employee.updated." }, "name": { "type": "string", "description": "The name of the webhook." }, "postFields": { "type": "object", "description": "An object map of field ID or alias to the external name used in the webhook payload (e.g. `{\"firstName\": \"First Name\"}`). Omit or send an empty object to include no extra fields." }, "url": { "type": "string", "description": "The url the webhook should send data to (must begin with https://)." } }, "required": [ "PCID", "id" ] } ``` # bamboohr-employees Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bamboohr/bamboohr-employees BambooHR Employees - manage employees, files, company profile, locations, and tabular data **Server path:** `/bamboohr-employees` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bamboohr_employees_create_company_file_category`](#bamboohr_employees_create_company_file_category) | Create Company File Category | | [`bamboohr_employees_create_employee`](#bamboohr_employees_create_employee) | Create Employee | | [`bamboohr_employees_create_employee_file_category`](#bamboohr_employees_create_employee_file_category) | Create Employee File Category | | [`bamboohr_employees_create_location`](#bamboohr_employees_create_location) | Create a job location | | [`bamboohr_employees_create_table_row`](#bamboohr_employees_create_table_row) | Create Table Row | | [`bamboohr_employees_create_table_row_v1_1`](#bamboohr_employees_create_table_row_v1_1) | Create Table Row v1.1 | | [`bamboohr_employees_delete_company_file`](#bamboohr_employees_delete_company_file) | Delete Company File | | [`bamboohr_employees_delete_employee_file`](#bamboohr_employees_delete_employee_file) | Delete Employee File | | [`bamboohr_employees_delete_employee_table_row`](#bamboohr_employees_delete_employee_table_row) | Delete Employee Table Row | | [`bamboohr_employees_delete_location`](#bamboohr_employees_delete_location) | Delete a job location | | [`bamboohr_employees_get_changed_employee_ids`](#bamboohr_employees_get_changed_employee_ids) | Get Changed Employee IDs | | [`bamboohr_employees_get_changed_employee_table_data`](#bamboohr_employees_get_changed_employee_table_data) | Get Changed Employee Table Data | | [`bamboohr_employees_get_company_file`](#bamboohr_employees_get_company_file) | Get Company File | | [`bamboohr_employees_get_company_information`](#bamboohr_employees_get_company_information) | Get Company Information | | [`bamboohr_employees_get_company_profile_integrations`](#bamboohr_employees_get_company_profile_integrations) | Get Company Profile Integrations | | [`bamboohr_employees_get_countries_options`](#bamboohr_employees_get_countries_options) | Get Countries | | [`bamboohr_employees_get_directory`](#bamboohr_employees_get_directory) | Get Employees Directory | | [`bamboohr_employees_get_employee`](#bamboohr_employees_get_employee) | Get Employee | | [`bamboohr_employees_get_employee_file`](#bamboohr_employees_get_employee_file) | Get Employee File | | [`bamboohr_employees_get_employee_photo`](#bamboohr_employees_get_employee_photo) | Get Employee Photo | | [`bamboohr_employees_get_employee_table_data`](#bamboohr_employees_get_employee_table_data) | Get Employee Table Data | | [`bamboohr_employees_get_location`](#bamboohr_employees_get_location) | Get a job location | | [`bamboohr_employees_get_locations`](#bamboohr_employees_get_locations) | List job locations | | [`bamboohr_employees_get_states_by_country_id`](#bamboohr_employees_get_states_by_country_id) | Get States by Country ID | | [`bamboohr_employees_list_company_files`](#bamboohr_employees_list_company_files) | Get Company Files and Categories | | [`bamboohr_employees_list_employee_files`](#bamboohr_employees_list_employee_files) | List Employee Files | | [`bamboohr_employees_list_employees`](#bamboohr_employees_list_employees) | List Employees | | [`bamboohr_employees_list_fields`](#bamboohr_employees_list_fields) | List Fields | | [`bamboohr_employees_list_list_fields`](#bamboohr_employees_list_list_fields) | List List Fields | | [`bamboohr_employees_list_meta_timezones`](#bamboohr_employees_list_meta_timezones) | List timezones | | [`bamboohr_employees_list_tabular_fields`](#bamboohr_employees_list_tabular_fields) | List Tabular Fields | | [`bamboohr_employees_list_users`](#bamboohr_employees_list_users) | List Users | | [`bamboohr_employees_patch_company_profile_company_information`](#bamboohr_employees_patch_company_profile_company_information) | Update company information (phone, address, legal name) | | [`bamboohr_employees_put_company_industry_codes`](#bamboohr_employees_put_company_industry_codes) | Update Company Industry Codes | | [`bamboohr_employees_put_company_profile_display_name`](#bamboohr_employees_put_company_profile_display_name) | Update company display name | | [`bamboohr_employees_update_company_file`](#bamboohr_employees_update_company_file) | Update Company File | | [`bamboohr_employees_update_employee`](#bamboohr_employees_update_employee) | Update Employee | | [`bamboohr_employees_update_employee_file`](#bamboohr_employees_update_employee_file) | Update Employee File | | [`bamboohr_employees_update_list_field_values`](#bamboohr_employees_update_list_field_values) | Update List Field Values | | [`bamboohr_employees_update_location`](#bamboohr_employees_update_location) | Update a job location | | [`bamboohr_employees_update_table_row`](#bamboohr_employees_update_table_row) | Update Table Row | | [`bamboohr_employees_update_table_row_v1_1`](#bamboohr_employees_update_table_row_v1_1) | Update Table Row v1.1 | | [`bamboohr_employees_upload_company_file`](#bamboohr_employees_upload_company_file) | Upload Company File | | [`bamboohr_employees_upload_employee_file`](#bamboohr_employees_upload_employee_file) | Upload Employee File | | [`bamboohr_employees_upload_employee_photo`](#bamboohr_employees_upload_employee_photo) | Upload Employee Photo | *** ## bamboohr\_employees\_create\_company\_file\_category Create Company File Category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | string\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "string" }, "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## bamboohr\_employees\_create\_employee Create Employee **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `department` | string | No | — | Department name. | | `firstName` | string | Yes | — | Legal first name (required). | | `hireDate` | string | No | — | Hire date in YYYY-MM-DD format. | | `jobTitle` | string | No | — | Job title. | | `lastName` | string | Yes | — | Legal last name (required). | | `workEmail` | string | No | — | Work email address. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "department": { "type": "string", "description": "Department name." }, "firstName": { "type": "string", "description": "Legal first name (required)." }, "hireDate": { "type": "string", "description": "Hire date in YYYY-MM-DD format." }, "jobTitle": { "type": "string", "description": "Job title." }, "lastName": { "type": "string", "description": "Legal last name (required)." }, "workEmail": { "type": "string", "description": "Work email address." } }, "required": [ "PCID", "firstName", "lastName" ] } ``` *** ## bamboohr\_employees\_create\_employee\_file\_category Create Employee File Category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | string\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "string" }, "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## bamboohr\_employees\_create\_location Create a job location **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `address` | object | Yes | — | Address details for the location. When remoteLocation is true, none are required and must be null or omitted | | `archived` | boolean | No | — | Whether the location is archived | | `label` | string | Yes | — | Display name for the location | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "address": { "type": "object", "description": "Address details for the location. When remoteLocation is true, none are required and must be null or omitted", "properties": { "address1": { "type": "string", "description": "The address1 value" }, "address2": { "type": "string", "description": "The address2 value" }, "city": { "type": "string", "description": "The city value" }, "stateId": { "type": "string", "description": "State Id" }, "zipcode": { "type": "string", "description": "The zipcode value" }, "countryId": { "type": "string", "description": "Country Id" }, "timezone": { "type": "string", "description": "The utcName value from the /api/v1/meta/timezones endpoint" }, "remoteLocation": { "type": "boolean", "description": "Remote Location" } }, "required": [ "remoteLocation" ] }, "archived": { "type": "boolean", "description": "Whether the location is archived" }, "label": { "type": "string", "description": "Display name for the location" } }, "required": [ "PCID", "address", "label" ] } ``` *** ## bamboohr\_employees\_create\_table\_row Create Table Row **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The employee ID. | | `table` | string | Yes | — | The name of the table to add a row to (e.g., jobInfo, compensation). | | `date` | string | No | — | The effective date for the row in YYYY-MM-DD format. | | `department` | string | No | — | The department value for the row. | | `division` | string | No | — | The division value for the row. | | `jobTitle` | string | No | — | The job title value for the row. | | `location` | string | No | — | The employee location value for the row. | | `reportsTo` | string | No | — | The manager or reports-to value for the row. | | `teams` | string\[] | No | — | Team values associated with the row. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "table": { "type": "string", "description": "The name of the table to add a row to (e.g., jobInfo, compensation)." }, "date": { "type": "string", "description": "The effective date for the row in YYYY-MM-DD format." }, "department": { "type": "string", "description": "The department value for the row." }, "division": { "type": "string", "description": "The division value for the row." }, "jobTitle": { "type": "string", "description": "The job title value for the row." }, "location": { "type": "string", "description": "The employee location value for the row." }, "reportsTo": { "type": "string", "description": "The manager or reports-to value for the row." }, "teams": { "type": "array", "items": { "type": "string" }, "description": "Team values associated with the row." } }, "required": [ "PCID", "id", "table" ] } ``` *** ## bamboohr\_employees\_create\_table\_row\_v1\_1 Create Table Row v1.1 **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The employee ID. | | `table` | string | Yes | — | The name of the table to add a row to (e.g., jobInfo, compensation). | | `date` | string | No | — | The effective date for the row in YYYY-MM-DD format. | | `department` | string | No | — | The department value for the row. | | `division` | string | No | — | The division value for the row. | | `jobTitle` | string | No | — | The job title value for the row. | | `location` | string | No | — | The employee location value for the row. | | `reportsTo` | string | No | — | The manager or reports-to value for the row. | | `teams` | string\[] | No | — | Team values associated with the row. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "table": { "type": "string", "description": "The name of the table to add a row to (e.g., jobInfo, compensation)." }, "date": { "type": "string", "description": "The effective date for the row in YYYY-MM-DD format." }, "department": { "type": "string", "description": "The department value for the row." }, "division": { "type": "string", "description": "The division value for the row." }, "jobTitle": { "type": "string", "description": "The job title value for the row." }, "location": { "type": "string", "description": "The employee location value for the row." }, "reportsTo": { "type": "string", "description": "The manager or reports-to value for the row." }, "teams": { "type": "array", "items": { "type": "string" }, "description": "Team values associated with the row." } }, "required": [ "PCID", "id", "table" ] } ``` *** ## bamboohr\_employees\_delete\_company\_file Delete Company File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fileId` | integer | Yes | — | The ID of the company file to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fileId": { "type": "integer", "description": "The ID of the company file to delete." } }, "required": [ "PCID", "fileId" ] } ``` *** ## bamboohr\_employees\_delete\_employee\_file Delete Employee File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The ID of the employee whose file is being deleted. Use 0 to default to the employee associated with the API key. | | `fileId` | integer | Yes | — | The ID of the employee file to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the employee whose file is being deleted. Use 0 to default to the employee associated with the API key." }, "fileId": { "type": "integer", "description": "The ID of the employee file to delete." } }, "required": [ "PCID", "id", "fileId" ] } ``` *** ## bamboohr\_employees\_delete\_employee\_table\_row Delete Employee Table Row **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The employee ID. | | `table` | string | Yes | — | The name of the table containing the row to delete (e.g., jobInfo, compensation, customTabularField). | | `rowId` | string | Yes | — | The ID of the specific row to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "table": { "type": "string", "description": "The name of the table containing the row to delete (e.g., jobInfo, compensation, customTabularField)." }, "rowId": { "type": "string", "description": "The ID of the specific row to delete." } }, "required": [ "PCID", "id", "table", "rowId" ] } ``` *** ## bamboohr\_employees\_delete\_location Delete a job location **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The ID of the location to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the location to delete" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_employees\_get\_changed\_employee\_ids Get Changed Employee IDs **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `since` | string | Yes | — | ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned. | | `type` | string | No | — | Filter by change type. If omitted, all change types are returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "since": { "type": "string", "description": "ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned." }, "type": { "type": "string", "description": "Filter by change type. If omitted, all change types are returned.", "enum": [ "inserted", "updated", "deleted", "all" ] } }, "required": [ "PCID", "since" ] } ``` *** ## bamboohr\_employees\_get\_changed\_employee\_table\_data Get Changed Employee Table Data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `table` | string | Yes | — | The name of the table to retrieve changed data for (e.g., jobInfo, compensation). | | `since` | string | Yes | — | ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "table": { "type": "string", "description": "The name of the table to retrieve changed data for (e.g., jobInfo, compensation)." }, "since": { "type": "string", "description": "ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned." } }, "required": [ "PCID", "table", "since" ] } ``` *** ## bamboohr\_employees\_get\_company\_file Get Company File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fileId` | integer | Yes | — | The ID of the company file to download. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fileId": { "type": "integer", "description": "The ID of the company file to download." } }, "required": [ "PCID", "fileId" ] } ``` *** ## bamboohr\_employees\_get\_company\_information Get Company Information ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_get\_company\_profile\_integrations Get Company Profile Integrations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_get\_countries\_options Get Countries ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_get\_directory Get Employees Directory **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | | `onlyCurrent` | boolean | No | — | When true (the default), only current employees are returned. Set to false to include future employees that have a hire date or employment status effective date in the future. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] }, "onlyCurrent": { "type": "boolean", "description": "When true (the default), only current employees are returned. Set to false to include future employees that have a hire date or employment status effective date in the future." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_get\_employee Get Employee **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any). | | `fields` | string | No | — | Comma-separated list of field names to include in the response. See the List Fields endpoint for valid field names. | | `onlyCurrent` | boolean | No | — | Setting to false will return future-dated values from history table fields. Defaults to true. | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any)." }, "fields": { "type": "string", "description": "Comma-separated list of field names to include in the response. See the List Fields endpoint for valid field names." }, "onlyCurrent": { "type": "boolean", "description": "Setting to false will return future-dated values from history table fields. Defaults to true." }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_employees\_get\_employee\_file Get Employee File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The ID of the employee whose file is being retrieved. Use 0 to resolve to the employee associated with the API key. | | `fileId` | integer | Yes | — | The ID of the employee file to download. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the employee whose file is being retrieved. Use 0 to resolve to the employee associated with the API key." }, "fileId": { "type": "integer", "description": "The ID of the employee file to download." } }, "required": [ "PCID", "id", "fileId" ] } ``` *** ## bamboohr\_employees\_get\_employee\_photo Get Employee Photo **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee whose photo to retrieve. | | `size` | string | Yes | — | The desired photo size. One of: `original`, `large`, `medium`, `small`, `xs`, `tiny`. | | `width` | integer | No | — | Optional. Scales the returned image to the specified pixel width, capped at the natural width of the requested size. Only applies to `small` and `tiny` sizes. | | `height` | integer | No | — | Optional. Scales the returned image to the specified pixel height, capped at the natural height of the requested size. Only applies to `small` and `tiny` sizes. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee whose photo to retrieve." }, "size": { "type": "string", "description": "The desired photo size. One of: `original`, `large`, `medium`, `small`, `xs`, `tiny`.", "enum": [ "original", "large", "medium", "small", "xs", "tiny" ] }, "width": { "type": "integer", "description": "Optional. Scales the returned image to the specified pixel width, capped at the natural width of the requested size. Only applies to `small` and `tiny` sizes." }, "height": { "type": "integer", "description": "Optional. Scales the returned image to the specified pixel height, capped at the natural height of the requested size. Only applies to `small` and `tiny` sizes." } }, "required": [ "PCID", "employeeId", "size" ] } ``` *** ## bamboohr\_employees\_get\_employee\_table\_data Get Employee Table Data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The employee ID. Use the special value "all" to retrieve table data for all employees the API user has access to. | | `table` | string | Yes | — | The name of the table to retrieve (e.g., jobInfo, compensation, employmentStatus). | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID. Use the special value \"all\" to retrieve table data for all employees the API user has access to." }, "table": { "type": "string", "description": "The name of the table to retrieve (e.g., jobInfo, compensation, employmentStatus)." }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID", "id", "table" ] } ``` *** ## bamboohr\_employees\_get\_location Get a job location **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The ID of the location | | `expand` | string\[] | No | — | Comma-separated list of related resources to expand. Supported values: state, country. Example: expand=state,country | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the location" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "state", "country" ] }, "description": "Comma-separated list of related resources to expand. Supported values: state, country. Example: expand=state,country" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_employees\_get\_locations List job locations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pageSize` | integer | No | — | The number of items to return per page. | | `page` | integer | No | — | The page number to retrieve. | | `sort` | string | No | — | Ordering by OData (Open Data Protocol) v4 specification. Supported fields: label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation, createdAt, archivedAt | | `select` | string | No | — | Projection (field selection) by OData specification. Supported fields: id, label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation, createdAt, archivedAt | | `filter` | string | No | — | Filter by an OData (Open Data Protocol) v4 specification. Supported fields: id, label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation | | `expand` | string\[] | No | — | Comma-separated list of related resources to expand. Supported values: state, country. Example: expand=state,country | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "The number of items to return per page." }, "page": { "type": "integer", "description": "The page number to retrieve." }, "sort": { "type": "string", "description": "Ordering by OData (Open Data Protocol) v4 specification. Supported fields: label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation, createdAt, archivedAt" }, "select": { "type": "string", "description": "Projection (field selection) by OData specification. Supported fields: id, label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation, createdAt, archivedAt" }, "filter": { "type": "string", "description": "Filter by an OData (Open Data Protocol) v4 specification. Supported fields: id, label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "state", "country" ] }, "description": "Comma-separated list of related resources to expand. Supported values: state, country. Example: expand=state,country" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_get\_states\_by\_country\_id Get States by Country ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `countryId` | integer | Yes | — | The numeric ID of the country whose states or provinces to retrieve. Use the Get Countries endpoint to look up valid country IDs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "countryId": { "type": "integer", "description": "The numeric ID of the country whose states or provinces to retrieve. Use the Get Countries endpoint to look up valid country IDs." } }, "required": [ "PCID", "countryId" ] } ``` *** ## bamboohr\_employees\_list\_company\_files Get Company Files and Categories ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_list\_employee\_files List Employee Files **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The ID of the employee whose files are being listed. | | `Accept` | string | No | — | Set to `application/json` to receive a JSON response. Any other value (or omitted) returns XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the employee whose files are being listed." }, "Accept": { "type": "string", "description": "Set to `application/json` to receive a JSON response. Any other value (or omitted) returns XML." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_employees\_list\_employees List Employees **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filter` | object | No | — | Filters used to match employees. Encode filter properties using deepObject style. If the caller does not have access to the filtered field on a matching employee, that employee is excluded from the results to avoid leaking sensitive data. | | `sort` | string | No | — | Comma-separated list of sortable fields. Prefix a field with "-" for descending order. Allowed fields: `employeeId`, `firstName`, `lastName`, `preferredName`, `jobTitleName`, `status`. Nulls sort first in ascending order and last in descending order. If the caller does not have access to the sort field for an employee, that employee is excluded from the final result set to avoid leaking sensitive information. | | `fields` | string\[] | No | — | Comma-separated list of additional fields to include in the response beyond the default set. Unrecognized field names are silently ignored. Field values are subject to permission checks — restricted fields will be null and their names are listed in `_restrictedFields`. | | `page` | object | No | — | Cursor-based pagination parameters (`limit`, `after`, `before`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter": { "type": "object", "description": "Filters used to match employees. Encode filter properties using deepObject style. If the caller does not have access to the filtered field on a matching employee, that employee is excluded from the results to avoid leaking sensitive data.", "properties": { "firstName": { "type": "string", "description": "This will match any employees whose first name contains this string (case insensitive)" }, "lastName": { "type": "string", "description": "This will match any employees whose last name contains this string (case insensitive)" }, "jobTitleName": { "type": "string", "description": "This will match any employees whose current job title descriptor contains this string (case insensitive)" }, "status": { "type": "string", "description": "Employee status", "enum": [ "active", "inactive" ] }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "List of employee IDs for batch fetch. Documented form: repeated keys (`filter[ids][]=123&filter[ids][]=124`). For backward compatibility, the endpoint also accepts a single comma-separated string (`filter[ids]=123,124`)." } } }, "sort": { "type": "string", "description": "Comma-separated list of sortable fields. Prefix a field with \"-\" for descending order. Allowed fields: `employeeId`, `firstName`, `lastName`, `preferredName`, `jobTitleName`, `status`. Nulls sort first in ascending order and last in descending order. If the caller does not have access to the sort field for an employee, that employee is excluded from the final result set to avoid leaking sensitive information." }, "fields": { "type": "array", "items": { "type": "string", "enum": [ "workEmail", "homeEmail", "bestEmail", "middleName", "workPhone", "workPhoneExtension", "mobilePhone", "homePhone", "skypeUsername", "linkedinUrl", "facebookUrl", "instagramUrl", "twitterUrl", "pinterestUrl", "birthDate", "hireDate", "divisionName", "divisionId", "departmentName", "departmentId", "locationName", "locationId", "jobTitleId", "employmentStatusName", "employmentStatusId", "reportsToName", "reportsToId" ] }, "description": "Comma-separated list of additional fields to include in the response beyond the default set. Unrecognized field names are silently ignored. Field values are subject to permission checks — restricted fields will be null and their names are listed in `_restrictedFields`." }, "page": { "type": "object", "description": "Cursor-based pagination parameters (`limit`, `after`, `before`)." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_list\_fields List Fields **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_list\_list\_fields List List Fields **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `format` | string | No | — | Set to "json" to receive JSON output as an alternative to using the Accept header. | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "format": { "type": "string", "description": "Set to \"json\" to receive JSON output as an alternative to using the Accept header.", "enum": [ "json" ] }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_list\_meta\_timezones List timezones **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pageSize` | integer | No | — | The number of items to return per page. | | `page` | integer | No | — | The page number to retrieve. | | `sort` | string | No | — | Ordering by OData (Open Data Protocol) v4 specification | | `select` | string | No | — | Projection (field selection) by OData specification | | `filter` | string | No | — | Filter by an OData (Open Data Protocol) v4 specification | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "The number of items to return per page." }, "page": { "type": "integer", "description": "The page number to retrieve." }, "sort": { "type": "string", "description": "Ordering by OData (Open Data Protocol) v4 specification" }, "select": { "type": "string", "description": "Projection (field selection) by OData specification" }, "filter": { "type": "string", "description": "Filter by an OData (Open Data Protocol) v4 specification" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_list\_tabular\_fields List Tabular Fields **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_list\_users List Users **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | | `status` | string | No | — | Comma-separated list of statuses to filter by. Valid values: `enabled`, `disabled`. Defaults to returning users of all statuses when omitted or when no recognized value is provided. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] }, "status": { "type": "string", "description": "Comma-separated list of statuses to filter by. Valid values: `enabled`, `disabled`. Defaults to returning users of all statuses when omitted or when no recognized value is provided." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_patch\_company\_profile\_company\_information Update company information (phone, address, legal name) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `address` | object | No | — | Company address. When `address` is included in the patch (non-null object), `city`, `state`, and `zip` must all be sent as non-empty strings. `line1` and `line2` are optional (JSON null removes a line per merge-patch). | | `legalName` | string | No | — | Legal name of the company (name\_of\_employer). Required (non-empty) when this field is present in the patch. | | `phone` | string | No | — | Contact phone number. Required (non-empty) when this field is present in the patch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "address": { "type": "object", "description": "Company address. When `address` is included in the patch (non-null object), `city`, `state`, and `zip` must all be sent as non-empty strings. `line1` and `line2` are optional (JSON null removes a line per merge-patch).", "properties": { "line1": { "type": "string", "description": "Street address line 1 (employerAddress). Optional; JSON null removes the value per merge-patch semantics." }, "line2": { "type": "string", "description": "Street address line 2 (employerAddress). Optional; JSON null removes the value per merge-patch semantics." }, "city": { "type": "string", "description": "City. Required (non-empty) when address is patched." }, "state": { "type": "string", "description": "State. Required (non-empty) when address is patched." }, "zip": { "type": "string", "description": "Zip or postal code. Required (non-empty) when address is patched." } } }, "legalName": { "type": "string", "description": "Legal name of the company (name_of_employer). Required (non-empty) when this field is present in the patch." }, "phone": { "type": "string", "description": "Contact phone number. Required (non-empty) when this field is present in the patch." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_put\_company\_industry\_codes Update Company Industry Codes **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `industryIds` | integer\[] | No | — | List of industry IDs associated with the company. Currently limited to a single entry. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "industryIds": { "type": "array", "items": { "type": "integer" }, "description": "List of industry IDs associated with the company. Currently limited to a single entry." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_put\_company\_profile\_display\_name Update company display name **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyName` | string | No | — | The new display name for the company. Must be a non-empty string with a maximum length of 255 characters (character count, not bytes, so multibyte UTF-8 characters are properly supported). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyName": { "type": "string", "description": "The new display name for the company. Must be a non-empty string with a maximum length of 255 characters (character count, not bytes, so multibyte UTF-8 characters are properly supported)." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_update\_company\_file Update Company File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fileId` | integer | Yes | — | The ID of the company file to update. | | `categoryId` | string | No | — | The ID of the category (file section) to move the file to. | | `name` | string | No | — | The new display name for the file. | | `shareWithEmployee` | string | No | — | Whether the file is shared with employees. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fileId": { "type": "integer", "description": "The ID of the company file to update." }, "categoryId": { "type": "string", "description": "The ID of the category (file section) to move the file to." }, "name": { "type": "string", "description": "The new display name for the file." }, "shareWithEmployee": { "type": "string", "description": "Whether the file is shared with employees.", "enum": [ "yes", "no" ] } }, "required": [ "PCID", "fileId" ] } ``` *** ## bamboohr\_employees\_update\_employee Update Employee **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The employee ID. | | `address1` | string | No | — | Street address line 1. | | `city` | string | No | — | City. | | `country` | string | No | — | Country name. | | `department` | string | No | — | Department name. | | `division` | string | No | — | Division name. | | `firstName` | string | No | — | Legal first name. | | `hireDate` | string | No | — | Hire date in YYYY-MM-DD format. | | `homePhone` | string | No | — | Home phone number. | | `jobTitle` | string | No | — | Job title. | | `lastName` | string | No | — | Legal last name. | | `location` | string | No | — | Location name. | | `mobilePhone` | string | No | — | Mobile phone number. | | `state` | string | No | — | State or province. Values are normalized to standard abbreviations (e.g., "Pennsylvania" becomes "PA"). | | `workEmail` | string | No | — | Work email address. | | `workPhone` | string | No | — | Work phone number. | | `zipcode` | string | No | — | ZIP or postal code. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "address1": { "type": "string", "description": "Street address line 1." }, "city": { "type": "string", "description": "City." }, "country": { "type": "string", "description": "Country name." }, "department": { "type": "string", "description": "Department name." }, "division": { "type": "string", "description": "Division name." }, "firstName": { "type": "string", "description": "Legal first name." }, "hireDate": { "type": "string", "description": "Hire date in YYYY-MM-DD format." }, "homePhone": { "type": "string", "description": "Home phone number." }, "jobTitle": { "type": "string", "description": "Job title." }, "lastName": { "type": "string", "description": "Legal last name." }, "location": { "type": "string", "description": "Location name." }, "mobilePhone": { "type": "string", "description": "Mobile phone number." }, "state": { "type": "string", "description": "State or province. Values are normalized to standard abbreviations (e.g., \"Pennsylvania\" becomes \"PA\")." }, "workEmail": { "type": "string", "description": "Work email address." }, "workPhone": { "type": "string", "description": "Work phone number." }, "zipcode": { "type": "string", "description": "ZIP or postal code." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_employees\_update\_employee\_file Update Employee File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The ID of the employee whose file is being updated. | | `fileId` | integer | Yes | — | The ID of the employee file to update. | | `categoryId` | integer | No | — | The ID of the file category (section) to move the file into. | | `name` | string | No | — | The new display name for the file. | | `shareWithEmployee` | string | No | — | Whether the file is shared with the employee. Also accepted as 'shareWithEmployees'. | | `shareWithEmployees` | string | No | — | Alias for shareWithEmployee. Whether the file is shared with the employee. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the employee whose file is being updated." }, "fileId": { "type": "integer", "description": "The ID of the employee file to update." }, "categoryId": { "type": "integer", "description": "The ID of the file category (section) to move the file into." }, "name": { "type": "string", "description": "The new display name for the file." }, "shareWithEmployee": { "type": "string", "description": "Whether the file is shared with the employee. Also accepted as 'shareWithEmployees'.", "enum": [ "yes", "no" ] }, "shareWithEmployees": { "type": "string", "description": "Alias for shareWithEmployee. Whether the file is shared with the employee.", "enum": [ "yes", "no" ] } }, "required": [ "PCID", "id", "fileId" ] } ``` *** ## bamboohr\_employees\_update\_list\_field\_values Update List Field Values **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `listFieldId` | string | Yes | — | The ID of the list field to update. | | `options` | object\[] | No | — | The list field options to create, update, or archive. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "listFieldId": { "type": "string", "description": "The ID of the list field to update." }, "options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "The existing option ID. Omit this field to create a new option." }, "value": { "type": "string", "description": "The display value for the option." }, "archived": { "type": "string", "enum": [ "yes", "no" ], "description": "Whether the option should be archived. Use `yes` to archive an option or `no` to keep it active." }, "adpCode": { "type": "string", "description": "Optional payroll-mapping code associated with the option." } } }, "description": "The list field options to create, update, or archive." } }, "required": [ "PCID", "listFieldId" ] } ``` *** ## bamboohr\_employees\_update\_location Update a job location **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The ID of the location to update | | `address` | object | No | — | Address details for the location. When remoteLocation is true, none are required and must be null or omitted | | `archived` | boolean | No | — | Whether the location is archived | | `label` | string | No | — | Updated display name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the location to update" }, "address": { "type": "object", "description": "Address details for the location. When remoteLocation is true, none are required and must be null or omitted", "properties": { "address1": { "type": "string", "description": "The address1 value" }, "address2": { "type": "string", "description": "The address2 value" }, "city": { "type": "string", "description": "The city value" }, "stateId": { "type": "string", "description": "State Id" }, "zipcode": { "type": "string", "description": "The zipcode value" }, "countryId": { "type": "string", "description": "Country Id" }, "timezone": { "type": "string", "description": "The utcName value from the /api/v1/meta/timezones endpoint" }, "remoteLocation": { "type": "boolean", "description": "Remote Location" } }, "required": [ "remoteLocation" ] }, "archived": { "type": "boolean", "description": "Whether the location is archived" }, "label": { "type": "string", "description": "Updated display name" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_employees\_update\_table\_row Update Table Row **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The employee ID. | | `table` | string | Yes | — | The name of the table containing the row to update (e.g., jobInfo, compensation). | | `rowId` | string | Yes | — | The ID of the row to update. | | `date` | string | No | — | The effective date for the row in YYYY-MM-DD format. | | `department` | string | No | — | The department value for the row. | | `division` | string | No | — | The division value for the row. | | `jobTitle` | string | No | — | The job title value for the row. | | `location` | string | No | — | The employee location value for the row. | | `reportsTo` | string | No | — | The manager or reports-to value for the row. | | `teams` | string\[] | No | — | Team values associated with the row. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "table": { "type": "string", "description": "The name of the table containing the row to update (e.g., jobInfo, compensation)." }, "rowId": { "type": "string", "description": "The ID of the row to update." }, "date": { "type": "string", "description": "The effective date for the row in YYYY-MM-DD format." }, "department": { "type": "string", "description": "The department value for the row." }, "division": { "type": "string", "description": "The division value for the row." }, "jobTitle": { "type": "string", "description": "The job title value for the row." }, "location": { "type": "string", "description": "The employee location value for the row." }, "reportsTo": { "type": "string", "description": "The manager or reports-to value for the row." }, "teams": { "type": "array", "items": { "type": "string" }, "description": "Team values associated with the row." } }, "required": [ "PCID", "id", "table", "rowId" ] } ``` *** ## bamboohr\_employees\_update\_table\_row\_v1\_1 Update Table Row v1.1 **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The employee ID. | | `table` | string | Yes | — | The name of the table containing the row to update (e.g., jobInfo, compensation). | | `rowId` | string | Yes | — | The ID of the row to update. | | `date` | string | No | — | The effective date for the row in YYYY-MM-DD format. | | `department` | string | No | — | The department value for the row. | | `division` | string | No | — | The division value for the row. | | `jobTitle` | string | No | — | The job title value for the row. | | `location` | string | No | — | The employee location value for the row. | | `reportsTo` | string | No | — | The manager or reports-to value for the row. | | `teams` | string\[] | No | — | Team values associated with the row. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "table": { "type": "string", "description": "The name of the table containing the row to update (e.g., jobInfo, compensation)." }, "rowId": { "type": "string", "description": "The ID of the row to update." }, "date": { "type": "string", "description": "The effective date for the row in YYYY-MM-DD format." }, "department": { "type": "string", "description": "The department value for the row." }, "division": { "type": "string", "description": "The division value for the row." }, "jobTitle": { "type": "string", "description": "The job title value for the row." }, "location": { "type": "string", "description": "The employee location value for the row." }, "reportsTo": { "type": "string", "description": "The manager or reports-to value for the row." }, "teams": { "type": "array", "items": { "type": "string" }, "description": "Team values associated with the row." } }, "required": [ "PCID", "id", "table", "rowId" ] } ``` *** ## bamboohr\_employees\_upload\_company\_file Upload Company File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `category` | integer | Yes | — | The ID of the file category (section) to upload the file into. | | `file` | string | Yes | — | The file to upload. | | `fileName` | string | Yes | — | The display name for the uploaded file. | | `share` | string | No | — | Whether to share the file with all employees. Accepted values: `yes` or `no`. Defaults to `no`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category": { "type": "integer", "description": "The ID of the file category (section) to upload the file into." }, "file": { "type": "string", "description": "The file to upload." }, "fileName": { "type": "string", "description": "The display name for the uploaded file." }, "share": { "type": "string", "description": "Whether to share the file with all employees. Accepted values: `yes` or `no`. Defaults to `no`.", "enum": [ "yes", "no" ] } }, "required": [ "PCID", "category", "file", "fileName" ] } ``` *** ## bamboohr\_employees\_upload\_employee\_file Upload Employee File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | \{id} is an employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any). | | `category` | integer | Yes | — | The ID of the employee file section to upload the file into. | | `file` | string | Yes | — | The file to upload. | | `fileName` | string | Yes | — | The display name for the uploaded file. | | `share` | string | No | — | Whether to share the file with the employee. Accepted values: `yes` or `no`. Defaults to `no`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "{id} is an employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any)." }, "category": { "type": "integer", "description": "The ID of the employee file section to upload the file into." }, "file": { "type": "string", "description": "The file to upload." }, "fileName": { "type": "string", "description": "The display name for the uploaded file." }, "share": { "type": "string", "description": "Whether to share the file with the employee. Accepted values: `yes` or `no`. Defaults to `no`.", "enum": [ "yes", "no" ] } }, "required": [ "PCID", "id", "category", "file", "fileName" ] } ``` *** ## bamboohr\_employees\_upload\_employee\_photo Upload Employee Photo **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee whose photo is being uploaded. | | `file` | string | Yes | — | The image file to upload as the employee's photo. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee whose photo is being uploaded." }, "file": { "type": "string", "description": "The image file to upload as the employee's photo." } }, "required": [ "PCID", "employeeId", "file" ] } ``` # bamboohr-talent Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bamboohr/bamboohr-talent BambooHR Talent - goals, training, and applicant tracking **Server path:** `/bamboohr-talent` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bamboohr_talent_close_goal`](#bamboohr_talent_close_goal) | Close Goal | | [`bamboohr_talent_create_application_comment`](#bamboohr_talent_create_application_comment) | Create Job Application Comment | | [`bamboohr_talent_create_candidate`](#bamboohr_talent_create_candidate) | Create Candidate | | [`bamboohr_talent_create_employee_training_record`](#bamboohr_talent_create_employee_training_record) | Create Employee Training Record | | [`bamboohr_talent_create_goal`](#bamboohr_talent_create_goal) | Create Goal | | [`bamboohr_talent_create_goal_comment`](#bamboohr_talent_create_goal_comment) | Create Goal Comment | | [`bamboohr_talent_create_job_opening`](#bamboohr_talent_create_job_opening) | Create Job Opening | | [`bamboohr_talent_create_training_category`](#bamboohr_talent_create_training_category) | Create Training Category | | [`bamboohr_talent_create_training_type`](#bamboohr_talent_create_training_type) | Create Training Type | | [`bamboohr_talent_delete_employee_training_record`](#bamboohr_talent_delete_employee_training_record) | Delete Employee Training Record | | [`bamboohr_talent_delete_goal`](#bamboohr_talent_delete_goal) | Delete Goal | | [`bamboohr_talent_delete_goal_comment`](#bamboohr_talent_delete_goal_comment) | Delete Goal Comment | | [`bamboohr_talent_delete_training_category`](#bamboohr_talent_delete_training_category) | Delete Training Category | | [`bamboohr_talent_delete_training_type`](#bamboohr_talent_delete_training_type) | Delete Training Type | | [`bamboohr_talent_get_alignable_goal_options`](#bamboohr_talent_get_alignable_goal_options) | Get Alignable Goal Options | | [`bamboohr_talent_get_application_details`](#bamboohr_talent_get_application_details) | Get Job Application Details | | [`bamboohr_talent_get_applications`](#bamboohr_talent_get_applications) | Get Job Applications | | [`bamboohr_talent_get_company_locations`](#bamboohr_talent_get_company_locations) | Get Company Locations | | [`bamboohr_talent_get_goal_aggregate`](#bamboohr_talent_get_goal_aggregate) | Get Goal Aggregate | | [`bamboohr_talent_get_goal_creation_permission`](#bamboohr_talent_get_goal_creation_permission) | Get Goal Creation Permission | | [`bamboohr_talent_get_goals_aggregate_v1_2`](#bamboohr_talent_get_goals_aggregate_v1_2) | Get Goals Aggregate (v1.2) | | [`bamboohr_talent_get_goals_filters_v1_2`](#bamboohr_talent_get_goals_filters_v1_2) | Get Goal Filters (v1.2) | | [`bamboohr_talent_get_hiring_leads`](#bamboohr_talent_get_hiring_leads) | Get Hiring Leads | | [`bamboohr_talent_get_job_summaries`](#bamboohr_talent_get_job_summaries) | Get Job Summaries | | [`bamboohr_talent_get_statuses`](#bamboohr_talent_get_statuses) | Get Applicant Statuses | | [`bamboohr_talent_list_employee_trainings`](#bamboohr_talent_list_employee_trainings) | List Employee Training Records | | [`bamboohr_talent_list_goal_comments`](#bamboohr_talent_list_goal_comments) | List Goal Comments | | [`bamboohr_talent_list_goal_share_options`](#bamboohr_talent_list_goal_share_options) | List Goal Sharing Options | | [`bamboohr_talent_list_goals`](#bamboohr_talent_list_goals) | List Goals | | [`bamboohr_talent_list_training_categories`](#bamboohr_talent_list_training_categories) | List Training Categories | | [`bamboohr_talent_list_training_types`](#bamboohr_talent_list_training_types) | List Training Types | | [`bamboohr_talent_reopen_goal`](#bamboohr_talent_reopen_goal) | Reopen Goal | | [`bamboohr_talent_update_applicant_status`](#bamboohr_talent_update_applicant_status) | Update Applicant Status | | [`bamboohr_talent_update_employee_training_record`](#bamboohr_talent_update_employee_training_record) | Update Employee Training Record | | [`bamboohr_talent_update_goal_comment`](#bamboohr_talent_update_goal_comment) | Update Goal Comment | | [`bamboohr_talent_update_goal_milestone_progress`](#bamboohr_talent_update_goal_milestone_progress) | Update Milestone Progress | | [`bamboohr_talent_update_goal_progress`](#bamboohr_talent_update_goal_progress) | Update Goal Progress | | [`bamboohr_talent_update_goal_sharing`](#bamboohr_talent_update_goal_sharing) | Update Goal Sharing | | [`bamboohr_talent_update_goal_v1_1`](#bamboohr_talent_update_goal_v1_1) | Update Goal (v1.1) | | [`bamboohr_talent_update_training_category`](#bamboohr_talent_update_training_category) | Update Training Category | | [`bamboohr_talent_update_training_type`](#bamboohr_talent_update_training_type) | Update Training Type | *** ## bamboohr\_talent\_close\_goal Close Goal **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | | | `goalId` | string | Yes | — | goalId is the goal ID for the specified employee. | | | `comment` | string | null | No | — | Optional comment to record when closing the goal. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "string", "description": "goalId is the goal ID for the specified employee." }, "comment": { "type": [ "string", "null" ], "description": "Optional comment to record when closing the goal." } }, "required": [ "PCID", "employeeId", "goalId" ] } ``` *** ## bamboohr\_talent\_create\_application\_comment Create Job Application Comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `applicationId` | integer | Yes | — | The ID of the application to add a comment to. | | `comment` | string | Yes | — | The comment being posted. | | `type` | string | No | — | The comment type. Defaults to `comment` if omitted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationId": { "type": "integer", "description": "The ID of the application to add a comment to." }, "comment": { "type": "string", "description": "The comment being posted." }, "type": { "type": "string", "description": "The comment type. Defaults to `comment` if omitted." } }, "required": [ "PCID", "applicationId", "comment" ] } ``` *** ## bamboohr\_talent\_create\_candidate Create Candidate **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `address` | string | No | — | The street address of the candidate. | | `city` | string | No | — | The city of the candidate. | | `collegeName` | string | No | — | The college or university of the candidate. | | `country` | string | No | — | The country of the candidate. Accepts country name or ISO code. | | `coverLetter` | string | No | — | Cover letter file for the candidate. Accepted MIME types: `application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `text/plain`, `application/rtf`, `image/jpeg`, `image/gif`, `image/png`, `image/tiff`, `image/bmp`. | | `dateAvailable` | string | No | — | The available start date of the candidate. Format: `Y-m-d` (e.g. `2024-06-01`). | | `desiredSalary` | string | No | — | The desired salary of the candidate. | | `email` | string | No | — | The email address of the candidate. Must be a valid email address. | | `firstName` | string | Yes | — | The first name of the candidate. | | `highestEducation` | string | No | — | The highest completed education level of the candidate. | | `jobId` | integer | Yes | — | The id of the job opening for the candidate application. | | `lastName` | string | Yes | — | The last name of the candidate. | | `linkedinUrl` | string | No | — | The LinkedIn profile URL of the candidate. Must match `https?://(.*\.)?linkedin.com/...`. | | `phoneNumber` | string | No | — | The phone number of the candidate. | | `references` | string | No | — | A list of references supplied by the candidate. | | `referredBy` | string | No | — | The person or entity that referred the candidate. | | `resume` | string | No | — | Resume file for the candidate. Accepted MIME types: `application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `text/plain`, `application/rtf`, `image/jpeg`, `image/gif`, `image/png`, `image/tiff`, `image/bmp`. | | `source` | string | No | — | The source of the candidate application, e.g. LinkedIn, Indeed, etc. | | `state` | string | No | — | The state or province of the candidate. Accepts state name, abbreviation, or ISO code. | | `websiteUrl` | string | No | — | The personal website, blog, or online portfolio of the candidate. Must be a valid URL. | | `zip` | string | No | — | The zip code or postal code of the candidate. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "address": { "type": "string", "description": "The street address of the candidate." }, "city": { "type": "string", "description": "The city of the candidate." }, "collegeName": { "type": "string", "description": "The college or university of the candidate." }, "country": { "type": "string", "description": "The country of the candidate. Accepts country name or ISO code." }, "coverLetter": { "type": "string", "description": "Cover letter file for the candidate. Accepted MIME types: `application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `text/plain`, `application/rtf`, `image/jpeg`, `image/gif`, `image/png`, `image/tiff`, `image/bmp`." }, "dateAvailable": { "type": "string", "description": "The available start date of the candidate. Format: `Y-m-d` (e.g. `2024-06-01`)." }, "desiredSalary": { "type": "string", "description": "The desired salary of the candidate." }, "email": { "type": "string", "description": "The email address of the candidate. Must be a valid email address." }, "firstName": { "type": "string", "description": "The first name of the candidate." }, "highestEducation": { "type": "string", "description": "The highest completed education level of the candidate.", "enum": [ "GED or Equivalent", "High School", "Some College", "College - Associates", "College - Bachelor of Arts", "College - Bachelor of Fine Arts", "College - Bachelor of Science", "College - Master of Arts", "College - Master of Fine Arts", "College - Master of Science", "College - Master of Business Administration", "College - Doctorate", "Medical Doctor", "Other" ] }, "jobId": { "type": "integer", "description": "The id of the job opening for the candidate application." }, "lastName": { "type": "string", "description": "The last name of the candidate." }, "linkedinUrl": { "type": "string", "description": "The LinkedIn profile URL of the candidate. Must match `https?://(.*\\.)?linkedin.com/...`." }, "phoneNumber": { "type": "string", "description": "The phone number of the candidate." }, "references": { "type": "string", "description": "A list of references supplied by the candidate." }, "referredBy": { "type": "string", "description": "The person or entity that referred the candidate." }, "resume": { "type": "string", "description": "Resume file for the candidate. Accepted MIME types: `application/pdf`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `text/plain`, `application/rtf`, `image/jpeg`, `image/gif`, `image/png`, `image/tiff`, `image/bmp`." }, "source": { "type": "string", "description": "The source of the candidate application, e.g. LinkedIn, Indeed, etc." }, "state": { "type": "string", "description": "The state or province of the candidate. Accepts state name, abbreviation, or ISO code." }, "websiteUrl": { "type": "string", "description": "The personal website, blog, or online portfolio of the candidate. Must be a valid URL." }, "zip": { "type": "string", "description": "The zip code or postal code of the candidate." } }, "required": [ "PCID", "firstName", "jobId", "lastName" ] } ``` *** ## bamboohr\_talent\_create\_employee\_training\_record Create Employee Training Record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee to add a training record to. | | `completed` | string | Yes | — | Completed is a required field and must be in yyyy-mm-dd format. | | `cost` | object | No | — | Optional cost for the training record. | | `credits` | number | No | — | Credits earned for the training. | | `hours` | number | No | — | Number of hours for the training. | | `instructor` | string | No | — | Name of the training instructor. | | `notes` | string | No | — | Optional notes about the training record. | | `type` | integer | Yes | — | This must be an existing training type ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee to add a training record to." }, "completed": { "type": "string", "description": "Completed is a required field and must be in yyyy-mm-dd format." }, "cost": { "type": "object", "description": "Optional cost for the training record.", "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code (e.g. 'USD')." }, "amount": { "type": "string", "description": "Monetary amount as a decimal string (e.g. '100.00')." } } }, "credits": { "type": "number", "description": "Credits earned for the training." }, "hours": { "type": "number", "description": "Number of hours for the training." }, "instructor": { "type": "string", "description": "Name of the training instructor." }, "notes": { "type": "string", "description": "Optional notes about the training record." }, "type": { "type": "integer", "description": "This must be an existing training type ID." } }, "required": [ "PCID", "employeeId", "completed", "type" ] } ``` *** ## bamboohr\_talent\_create\_goal Create Goal **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | | | `alignsWithOptionId` | integer | null | No | — | ID of the option this goal aligns with | | `completionDate` | string | null | No | — | The date when the goal was completed in YYYY-MM-DD format. Only valid when percentComplete is 100; providing this field with any other percentComplete value will result in an error. | | `description` | string | No | — | A detailed description of the goal | | | `dueDate` | string | Yes | — | The due date for the goal in YYYY-MM-DD format | | | `milestones` | object\[] | No | — | List of milestones for this goal | | | `percentComplete` | integer | No | — | The percentage of completion for the goal (0-100). Defaults to 0 if omitted. | | | `sharedWithEmployeeIds` | integer\[] | Yes | — | List of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner. | | | `title` | string | Yes | — | The title of the goal | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." }, "alignsWithOptionId": { "type": [ "integer", "null" ], "description": "ID of the option this goal aligns with" }, "completionDate": { "type": [ "string", "null" ], "description": "The date when the goal was completed in YYYY-MM-DD format. Only valid when percentComplete is 100; providing this field with any other percentComplete value will result in an error." }, "description": { "type": "string", "description": "A detailed description of the goal" }, "dueDate": { "type": "string", "description": "The due date for the goal in YYYY-MM-DD format" }, "milestones": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the milestone" } } }, "description": "List of milestones for this goal" }, "percentComplete": { "type": "integer", "description": "The percentage of completion for the goal (0-100). Defaults to 0 if omitted." }, "sharedWithEmployeeIds": { "type": "array", "items": { "type": "integer" }, "description": "List of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner." }, "title": { "type": "string", "description": "The title of the goal" } }, "required": [ "PCID", "employeeId", "dueDate", "sharedWithEmployeeIds", "title" ] } ``` *** ## bamboohr\_talent\_create\_goal\_comment Create Goal Comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | | `goalId` | string | Yes | — | goalId is the goal ID for the specified employee. | | `text` | string | Yes | — | The text content of the comment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "string", "description": "goalId is the goal ID for the specified employee." }, "text": { "type": "string", "description": "The text content of the comment." } }, "required": [ "PCID", "employeeId", "goalId", "text" ] } ``` *** ## bamboohr\_talent\_create\_job\_opening Create Job Opening **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `applicationQuestionAddress` | string | No | — | Whether the job opening application has a standard question for address (true) or not (false) or if entering an address is mandatory (required). | | `applicationQuestionCollege` | string | No | — | Whether the job opening application has a standard question for college (true) or not (false) or if entering a college is mandatory (required). | | `applicationQuestionCoverLetter` | string | No | — | Whether the job opening application has a standard question for cover letter (true) or not (false) or if uploading a cover letter is mandatory (required). | | `applicationQuestionDateAvailable` | string | No | — | Whether the job opening application has a standard question for availability date (true) or not (false) or if entering an availability date is mandatory (required). | | `applicationQuestionDesiredSalary` | string | No | — | Whether the job opening application has a standard question for desired salary (true) or not (false) or if entering a desired salary is mandatory (required). | | `applicationQuestionHighestEducation` | string | No | — | Whether the job opening application has a standard question for highest education (true) or not (false) or if entering highest education is mandatory (required). | | `applicationQuestionLinkedinUrl` | string | No | — | Whether the job opening application has a standard question for LinkedIn profile url (true) or not (false) or if entering a LinkedIn profile url is mandatory (required). | | `applicationQuestionReferences` | string | No | — | Whether the job opening application has a standard question for references (true) or not (false) or if entering references is mandatory (required). | | `applicationQuestionReferredBy` | string | No | — | Whether the job opening application has a standard question for referred by (true) or not (false) or if entering referred by is mandatory (required). | | `applicationQuestionResume` | string | No | — | Whether the job opening application has a standard question for resume (true) or not (false) or if uploading a resume is mandatory (required). | | `applicationQuestionWebsiteUrl` | string | No | — | Whether the job opening application has a standard question for website url (true) or not (false) or if entering a website url is mandatory (required). | | `compensation` | string | No | — | The pay rate or compensation for the job opening. | | `department` | string | No | — | The department of the job opening. | | `employmentType` | string | Yes | — | The type of employment offered in the job opening, e.g. Full-Time, Part-Time, Contractor, etc. | | `hiringLead` | integer | Yes | — | The employee id (from the v1/applicant\_tracking/hiring\_leads endpoint) of the hiring lead for the job opening. | | `internalJobCode` | string | No | — | The internal job code for the job opening. | | `jobDescription` | string | Yes | — | The long-form text description of the job opening. | | `jobLocation` | integer | No | — | The location id (from the v1/applicant\_tracking/locations endpoint) of the job opening. Omit this parameter for a remote job location. | | `jobStatus` | string | Yes | — | The status of the job opening. | | `locationType` | integer | No | — | The location type for the job opening. `0` = on-site (requires `jobLocation`), `1` = remote (no `jobLocation`), `2` = hybrid (requires `jobLocation`). Defaults to `1` if omitted and no `jobLocation` is provided, or `0` if `jobLocation` is provided. | | `minimumExperience` | string | No | — | The minimum experience level that qualifies a candidate for the job opening. | | `postingTitle` | string | Yes | — | The posting title of the job opening. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationQuestionAddress": { "type": "string", "description": "Whether the job opening application has a standard question for address (true) or not (false) or if entering an address is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "applicationQuestionCollege": { "type": "string", "description": "Whether the job opening application has a standard question for college (true) or not (false) or if entering a college is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "applicationQuestionCoverLetter": { "type": "string", "description": "Whether the job opening application has a standard question for cover letter (true) or not (false) or if uploading a cover letter is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "applicationQuestionDateAvailable": { "type": "string", "description": "Whether the job opening application has a standard question for availability date (true) or not (false) or if entering an availability date is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "applicationQuestionDesiredSalary": { "type": "string", "description": "Whether the job opening application has a standard question for desired salary (true) or not (false) or if entering a desired salary is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "applicationQuestionHighestEducation": { "type": "string", "description": "Whether the job opening application has a standard question for highest education (true) or not (false) or if entering highest education is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "applicationQuestionLinkedinUrl": { "type": "string", "description": "Whether the job opening application has a standard question for LinkedIn profile url (true) or not (false) or if entering a LinkedIn profile url is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "applicationQuestionReferences": { "type": "string", "description": "Whether the job opening application has a standard question for references (true) or not (false) or if entering references is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "applicationQuestionReferredBy": { "type": "string", "description": "Whether the job opening application has a standard question for referred by (true) or not (false) or if entering referred by is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "applicationQuestionResume": { "type": "string", "description": "Whether the job opening application has a standard question for resume (true) or not (false) or if uploading a resume is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "applicationQuestionWebsiteUrl": { "type": "string", "description": "Whether the job opening application has a standard question for website url (true) or not (false) or if entering a website url is mandatory (required).", "enum": [ "true", "false", "Required" ] }, "compensation": { "type": "string", "description": "The pay rate or compensation for the job opening." }, "department": { "type": "string", "description": "The department of the job opening." }, "employmentType": { "type": "string", "description": "The type of employment offered in the job opening, e.g. Full-Time, Part-Time, Contractor, etc." }, "hiringLead": { "type": "integer", "description": "The employee id (from the v1/applicant_tracking/hiring_leads endpoint) of the hiring lead for the job opening." }, "internalJobCode": { "type": "string", "description": "The internal job code for the job opening." }, "jobDescription": { "type": "string", "description": "The long-form text description of the job opening." }, "jobLocation": { "type": "integer", "description": "The location id (from the v1/applicant_tracking/locations endpoint) of the job opening. Omit this parameter for a remote job location." }, "jobStatus": { "type": "string", "description": "The status of the job opening.", "enum": [ "Draft", "Open", "On Hold", "Filled", "Canceled" ] }, "locationType": { "type": "integer", "description": "The location type for the job opening. `0` = on-site (requires `jobLocation`), `1` = remote (no `jobLocation`), `2` = hybrid (requires `jobLocation`). Defaults to `1` if omitted and no `jobLocation` is provided, or `0` if `jobLocation` is provided.", "enum": [ 0, 1, 2 ] }, "minimumExperience": { "type": "string", "description": "The minimum experience level that qualifies a candidate for the job opening.", "enum": [ "Entry-level", "Mid-level", "Experienced", "Manager/Supervisor", "Senior Manager/Supervisor", "Executive", "Senior Executive" ] }, "postingTitle": { "type": "string", "description": "The posting title of the job opening." } }, "required": [ "PCID", "employmentType", "hiringLead", "jobDescription", "jobStatus", "postingTitle" ] } ``` *** ## bamboohr\_talent\_create\_training\_category Create Training Category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Name of the new training category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Name of the new training category." } }, "required": [ "PCID", "name" ] } ``` *** ## bamboohr\_talent\_create\_training\_type Create Training Type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `allowEmployeesToMarkComplete` | boolean | No | — | Allows all employees who can view the training to be able to mark it complete. | | `category` | object | No | — | The category is optional and you can pass either a category id or a category name. | | `description` | string | No | — | Description for the training. | | `dueFromHireDate` | integer | No | — | Number of days before the training is due for new hires. Not valid unless training is required. | | `frequency` | integer | No | — | The frequency is the (optional) amount of months between renewing trainings. Not valid if training are not renewable. | | `linkUrl` | string | No | — | Optional URL that can be included with a training. | | `name` | string | Yes | — | Name of the new training type. | | `renewable` | boolean | No | — | Renewable is optional but if you are setting it to true you must pass a frequency which is the months between renewals. | | `required` | boolean | No | — | Is this a required training? | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allowEmployeesToMarkComplete": { "type": "boolean", "description": "Allows all employees who can view the training to be able to mark it complete." }, "category": { "type": "object", "description": "The category is optional and you can pass either a category id or a category name.", "properties": { "id": { "type": "integer", "description": "Category ID" }, "name": { "type": "string", "description": "Category Name" } } }, "description": { "type": "string", "description": "Description for the training." }, "dueFromHireDate": { "type": "integer", "description": "Number of days before the training is due for new hires. Not valid unless training is required." }, "frequency": { "type": "integer", "description": "The frequency is the (optional) amount of months between renewing trainings. Not valid if training are not renewable." }, "linkUrl": { "type": "string", "description": "Optional URL that can be included with a training." }, "name": { "type": "string", "description": "Name of the new training type." }, "renewable": { "type": "boolean", "description": "Renewable is optional but if you are setting it to true you must pass a frequency which is the months between renewals." }, "required": { "type": "boolean", "description": "Is this a required training?" } }, "required": [ "PCID", "name" ] } ``` *** ## bamboohr\_talent\_delete\_employee\_training\_record Delete Employee Training Record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeTrainingRecordId` | integer | Yes | — | The ID of the training record to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeTrainingRecordId": { "type": "integer", "description": "The ID of the training record to delete." } }, "required": [ "PCID", "employeeTrainingRecordId" ] } ``` *** ## bamboohr\_talent\_delete\_goal Delete Goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | | `goalId` | string | Yes | — | goalId is the goal ID for the specified employee. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "string", "description": "goalId is the goal ID for the specified employee." } }, "required": [ "PCID", "employeeId", "goalId" ] } ``` *** ## bamboohr\_talent\_delete\_goal\_comment Delete Goal Comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | | `goalId` | string | Yes | — | goalId is the goal ID for the specified employee. | | `commentId` | string | Yes | — | commentId is the ID of a specific comment for the specified goal. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "string", "description": "goalId is the goal ID for the specified employee." }, "commentId": { "type": "string", "description": "commentId is the ID of a specific comment for the specified goal." } }, "required": [ "PCID", "employeeId", "goalId", "commentId" ] } ``` *** ## bamboohr\_talent\_delete\_training\_category Delete Training Category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `trainingCategoryId` | integer | Yes | — | The ID of the training category to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "trainingCategoryId": { "type": "integer", "description": "The ID of the training category to delete." } }, "required": [ "PCID", "trainingCategoryId" ] } ``` *** ## bamboohr\_talent\_delete\_training\_type Delete Training Type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `trainingTypeId` | integer | Yes | — | The ID of the training type to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "trainingTypeId": { "type": "integer", "description": "The ID of the training type to delete." } }, "required": [ "PCID", "trainingTypeId" ] } ``` *** ## bamboohr\_talent\_get\_alignable\_goal\_options Get Alignable Goal Options **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID to get alignable goal options for. | | `goalId` | integer | No | — | Optional. When provided, the response includes the option currently aligned with this goal. If omitted, returns alignment options for the API user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID to get alignable goal options for." }, "goalId": { "type": "integer", "description": "Optional. When provided, the response includes the option currently aligned with this goal. If omitted, returns alignment options for the API user." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_talent\_get\_application\_details Get Job Application Details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `applicationId` | integer | Yes | — | The ID of the application to retrieve details for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationId": { "type": "integer", "description": "The ID of the application to retrieve details for." } }, "required": [ "PCID", "applicationId" ] } ``` *** ## bamboohr\_talent\_get\_applications Get Job Applications **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | The page number | | `jobId` | integer | No | — | A Job Id to limit results to | | `applicationStatusId` | string | No | — | One or more application status IDs to filter by, comma-separated (e.g. `1,2,3`). | | `applicationStatus` | string | No | — | One or more application status group codes to filter by, comma-separated (e.g. `NEW,ACTIVE`). Allowed values: `ALL`, `ALL_ACTIVE`, `NEW`, `ACTIVE`, `INACTIVE`, `HIRED`. | | `jobStatusGroups` | string | No | — | One or more position status groups to filter by, comma-separated (e.g. `Draft,Open`). Allowed values: `ALL`, `DRAFT_AND_OPEN`, `Open`, `Filled`, `Draft`, `Deleted`, `On Hold`, `Canceled`. | | `searchString` | string | No | — | A general search criteria by which to find applications. | | `sortBy` | string | No | — | A specific field to sort the results by. | | `sortOrder` | string | No | — | Order by which to sort results. | | `newSince` | string | No | — | Only return applications submitted after this UTC timestamp. Format: `Y-m-d H:i:s` (e.g. `2024-01-01 13:00:00`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "The page number" }, "jobId": { "type": "integer", "description": "A Job Id to limit results to" }, "applicationStatusId": { "type": "string", "description": "One or more application status IDs to filter by, comma-separated (e.g. `1,2,3`)." }, "applicationStatus": { "type": "string", "description": "One or more application status group codes to filter by, comma-separated (e.g. `NEW,ACTIVE`). Allowed values: `ALL`, `ALL_ACTIVE`, `NEW`, `ACTIVE`, `INACTIVE`, `HIRED`." }, "jobStatusGroups": { "type": "string", "description": "One or more position status groups to filter by, comma-separated (e.g. `Draft,Open`). Allowed values: `ALL`, `DRAFT_AND_OPEN`, `Open`, `Filled`, `Draft`, `Deleted`, `On Hold`, `Canceled`." }, "searchString": { "type": "string", "description": "A general search criteria by which to find applications." }, "sortBy": { "type": "string", "description": "A specific field to sort the results by.", "enum": [ "first_name", "job_title", "rating", "phone", "status", "last_updated", "created_date" ] }, "sortOrder": { "type": "string", "description": "Order by which to sort results.", "enum": [ "ASC", "DESC" ] }, "newSince": { "type": "string", "description": "Only return applications submitted after this UTC timestamp. Format: `Y-m-d H:i:s` (e.g. `2024-01-01 13:00:00`)." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_talent\_get\_company\_locations Get Company Locations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_talent\_get\_goal\_aggregate Get Goal Aggregate **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | | `goalId` | string | Yes | — | goalId is the Goal ID used to generate the aggregate information. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "string", "description": "goalId is the Goal ID used to generate the aggregate information." } }, "required": [ "PCID", "employeeId", "goalId" ] } ``` *** ## bamboohr\_talent\_get\_goal\_creation\_permission Get Goal Creation Permission **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_talent\_get\_goals\_aggregate\_v1\_2 Get Goals Aggregate (v1.2) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | employeeId is the employee ID used to generate the aggregate information. | | `filter` | string | No | — | Filter goals by status. Accepts filter IDs returned by the filters endpoint (e.g. status-inProgress). If omitted or invalid, defaults to the first available filter. The API accepts arbitrary strings and returns 200. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "employeeId is the employee ID used to generate the aggregate information." }, "filter": { "type": "string", "description": "Filter goals by status. Accepts filter IDs returned by the filters endpoint (e.g. status-inProgress). If omitted or invalid, defaults to the first available filter. The API accepts arbitrary strings and returns 200." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_talent\_get\_goals\_filters\_v1\_2 Get Goal Filters (v1.2) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | employeeId is the employee ID to whom the goals are assigned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "employeeId is the employee ID to whom the goals are assigned." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_talent\_get\_hiring\_leads Get Hiring Leads ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_talent\_get\_job\_summaries Get Job Summaries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `statusGroups` | string | No | — | One or more status groups to filter positions by, comma-separated (e.g. `Draft,Open`). Allowed values: `ALL`, `DRAFT_AND_OPEN`, `Open`, `Filled`, `Draft`, `Deleted`, `On Hold`, `Canceled`. Defaults to all non-deleted positions. | | `status_ids` | string | No | — | One or more specific job opening status IDs to filter by, comma-separated (e.g. `1,2`). Combined with `statusGroups` when both are provided. | | `sortBy` | string | No | — | A specific field to sort the results by. | | `sortOrder` | string | No | — | Order by which to sort results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "statusGroups": { "type": "string", "description": "One or more status groups to filter positions by, comma-separated (e.g. `Draft,Open`). Allowed values: `ALL`, `DRAFT_AND_OPEN`, `Open`, `Filled`, `Draft`, `Deleted`, `On Hold`, `Canceled`. Defaults to all non-deleted positions." }, "status_ids": { "type": "string", "description": "One or more specific job opening status IDs to filter by, comma-separated (e.g. `1,2`). Combined with `statusGroups` when both are provided." }, "sortBy": { "type": "string", "description": "A specific field to sort the results by.", "enum": [ "count", "title", "lead", "created", "status" ] }, "sortOrder": { "type": "string", "description": "Order by which to sort results.", "enum": [ "ASC", "DESC" ] } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_talent\_get\_statuses Get Applicant Statuses ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_talent\_list\_employee\_trainings List Employee Training Records **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee to get a list of trainings for. | | `type` | integer | No | — | Optional training type ID to filter records. Omitting this parameter returns all training records for the employee. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee to get a list of trainings for." }, "type": { "type": "integer", "description": "Optional training type ID to filter records. Omitting this parameter returns all training records for the employee." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_talent\_list\_goal\_comments List Goal Comments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | | `goalId` | string | Yes | — | goalId is the goal ID for the specified employee. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "string", "description": "goalId is the goal ID for the specified employee." } }, "required": [ "PCID", "employeeId", "goalId" ] } ``` *** ## bamboohr\_talent\_list\_goal\_share\_options List Goal Sharing Options **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID to get sharing options for. | | `search` | string | Yes | — | The search term used to filter employees returned. Will search name, employee ID and email. | | `limit` | integer | No | — | Maximum number of employees to return. Defaults to 10, maximum 100. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID to get sharing options for." }, "search": { "type": "string", "description": "The search term used to filter employees returned. Will search name, employee ID and email." }, "limit": { "type": "integer", "description": "Maximum number of employees to return. Defaults to 10, maximum 100." } }, "required": [ "PCID", "employeeId", "search" ] } ``` *** ## bamboohr\_talent\_list\_goals List Goals **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID to whom the goals are assigned. | | `filter` | string | No | — | Filter goals by status. If omitted, goals in all statuses except closed are returned. Unrecognized values are treated the same as omitting the parameter. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID to whom the goals are assigned." }, "filter": { "type": "string", "description": "Filter goals by status. If omitted, goals in all statuses except closed are returned. Unrecognized values are treated the same as omitting the parameter.", "enum": [ "status-inProgress", "status-completed", "status-closed", "status-all" ] } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_talent\_list\_training\_categories List Training Categories ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_talent\_list\_training\_types List Training Types ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_talent\_reopen\_goal Reopen Goal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | | `goalId` | string | Yes | — | goalId is the goal ID for the specified employee. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "string", "description": "goalId is the goal ID for the specified employee." } }, "required": [ "PCID", "employeeId", "goalId" ] } ``` *** ## bamboohr\_talent\_update\_applicant\_status Update Applicant Status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `applicationId` | integer | Yes | — | The ID of the application whose status should be updated. | | `status` | integer | Yes | — | The ID of the status to assign to the application. Use the Get Applicant Statuses endpoint to get available status IDs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationId": { "type": "integer", "description": "The ID of the application whose status should be updated." }, "status": { "type": "integer", "description": "The ID of the status to assign to the application. Use the Get Applicant Statuses endpoint to get available status IDs." } }, "required": [ "PCID", "applicationId", "status" ] } ``` *** ## bamboohr\_talent\_update\_employee\_training\_record Update Employee Training Record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeTrainingRecordId` | integer | Yes | — | The ID of the training record to update. | | `completed` | string | No | — | Completed is the only required field and must be in yyyy-mm-dd format. The other parameters are optional. | | `cost` | object | No | — | Optional cost for the training record. | | `credits` | number | No | — | Credits earned for the training. | | `hours` | number | No | — | Number of hours for the training. | | `instructor` | string | No | — | Name of the training instructor. | | `notes` | string | No | — | Optional notes about the training record. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeTrainingRecordId": { "type": "integer", "description": "The ID of the training record to update." }, "completed": { "type": "string", "description": "Completed is the only required field and must be in yyyy-mm-dd format. The other parameters are optional." }, "cost": { "type": "object", "description": "Optional cost for the training record.", "properties": { "currency": { "type": "string", "description": "ISO 4217 currency code (e.g. 'USD')." }, "amount": { "type": "string", "description": "Monetary amount as a decimal string (e.g. '100.00')." } } }, "credits": { "type": "number", "description": "Credits earned for the training." }, "hours": { "type": "number", "description": "Number of hours for the training." }, "instructor": { "type": "string", "description": "Name of the training instructor." }, "notes": { "type": "string", "description": "Optional notes about the training record." } }, "required": [ "PCID", "employeeTrainingRecordId" ] } ``` *** ## bamboohr\_talent\_update\_goal\_comment Update Goal Comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | | `goalId` | string | Yes | — | goalId is the goal ID for the specified employee. | | `commentId` | string | Yes | — | commentId is the comment ID for the specified goal. | | `text` | string | No | — | The updated text content of the comment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "string", "description": "goalId is the goal ID for the specified employee." }, "commentId": { "type": "string", "description": "commentId is the comment ID for the specified goal." }, "text": { "type": "string", "description": "The updated text content of the comment." } }, "required": [ "PCID", "employeeId", "goalId", "commentId" ] } ``` *** ## bamboohr\_talent\_update\_goal\_milestone\_progress Update Milestone Progress **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID to whom the goals are assigned. | | `goalId` | string | Yes | — | goalId is the goal ID for the specified employee. | | `milestoneId` | string | Yes | — | milestoneId is the milestone ID for the specified goal. | | `complete` | boolean | No | — | Whether the milestone is complete or not | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID to whom the goals are assigned." }, "goalId": { "type": "string", "description": "goalId is the goal ID for the specified employee." }, "milestoneId": { "type": "string", "description": "milestoneId is the milestone ID for the specified goal." }, "complete": { "type": "boolean", "description": "Whether the milestone is complete or not" } }, "required": [ "PCID", "employeeId", "goalId", "milestoneId" ] } ``` *** ## bamboohr\_talent\_update\_goal\_progress Update Goal Progress **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `employeeId` | integer | Yes | — | employeeId is the employee ID with whom the goal is associated. | | | `goalId` | integer | Yes | — | goalId is the goal ID for the specified employee. | | | `completionDate` | string | null | No | — | The date when the goal was completed in YYYY-MM-DD format. Required when percentComplete is 100. | | `percentComplete` | integer | No | — | The percentage of completion for the goal (0-100) | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "integer", "description": "goalId is the goal ID for the specified employee." }, "completionDate": { "type": [ "string", "null" ], "description": "The date when the goal was completed in YYYY-MM-DD format. Required when percentComplete is 100." }, "percentComplete": { "type": "integer", "description": "The percentage of completion for the goal (0-100)" } }, "required": [ "PCID", "employeeId", "goalId" ] } ``` *** ## bamboohr\_talent\_update\_goal\_sharing Update Goal Sharing **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | string | Yes | — | employeeId is the employee ID with whom the goal is associated. | | `goalId` | string | Yes | — | goalId is the goal ID for the specified employee. | | `sharedWithEmployeeIds` | integer\[] | No | — | List of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "string", "description": "goalId is the goal ID for the specified employee." }, "sharedWithEmployeeIds": { "type": "array", "items": { "type": "integer" }, "description": "List of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner." } }, "required": [ "PCID", "employeeId", "goalId" ] } ``` *** ## bamboohr\_talent\_update\_goal\_v1\_1 Update Goal (v1.1) **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `employeeId` | integer | Yes | — | employeeId is the employee ID with whom the goal is associated. | | | `goalId` | integer | Yes | — | goalId is the goal ID for the specified employee. | | | `alignsWithOptionId` | integer | null | No | — | ID of the option this goal aligns with | | `completionDate` | string | null | No | — | The date when the goal was completed in YYYY-MM-DD format. Only valid when percentComplete is 100; providing this field with any other percentComplete value will result in an error. Ignored when milestonesEnabled is true. | | `deletedMilestoneIds` | integer\[] | No | — | List of milestone IDs to be deleted from the goal | | | `description` | string | No | — | A detailed description of the goal | | | `dueDate` | string | No | — | The due date for the goal in YYYY-MM-DD format | | | `milestones` | object\[] | No | — | List of milestones to add to this goal | | | `milestonesEnabled` | boolean | No | — | Flag indicating whether milestones are enabled for this goal | | | `percentComplete` | integer | No | — | The percentage of completion for the goal (0-100). Defaults to 0 if omitted. Ignored when milestonesEnabled is true. | | | `sharedWithEmployeeIds` | integer\[] | No | — | List of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner. | | | `title` | string | No | — | The title of the goal | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "employeeId is the employee ID with whom the goal is associated." }, "goalId": { "type": "integer", "description": "goalId is the goal ID for the specified employee." }, "alignsWithOptionId": { "type": [ "integer", "null" ], "description": "ID of the option this goal aligns with" }, "completionDate": { "type": [ "string", "null" ], "description": "The date when the goal was completed in YYYY-MM-DD format. Only valid when percentComplete is 100; providing this field with any other percentComplete value will result in an error. Ignored when milestonesEnabled is true." }, "deletedMilestoneIds": { "type": "array", "items": { "type": "integer" }, "description": "List of milestone IDs to be deleted from the goal" }, "description": { "type": "string", "description": "A detailed description of the goal" }, "dueDate": { "type": "string", "description": "The due date for the goal in YYYY-MM-DD format" }, "milestones": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the milestone" } } }, "description": "List of milestones to add to this goal" }, "milestonesEnabled": { "type": "boolean", "description": "Flag indicating whether milestones are enabled for this goal" }, "percentComplete": { "type": "integer", "description": "The percentage of completion for the goal (0-100). Defaults to 0 if omitted. Ignored when milestonesEnabled is true." }, "sharedWithEmployeeIds": { "type": "array", "items": { "type": "integer" }, "description": "List of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner." }, "title": { "type": "string", "description": "The title of the goal" } }, "required": [ "PCID", "employeeId", "goalId" ] } ``` *** ## bamboohr\_talent\_update\_training\_category Update Training Category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `trainingCategoryId` | integer | Yes | — | The ID of the training category to update. | | `name` | string | No | — | Name of the training category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "trainingCategoryId": { "type": "integer", "description": "The ID of the training category to update." }, "name": { "type": "string", "description": "Name of the training category." } }, "required": [ "PCID", "trainingCategoryId" ] } ``` *** ## bamboohr\_talent\_update\_training\_type Update Training Type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `trainingTypeId` | integer | Yes | — | The ID of the training type to update. | | `allowEmployeesToMarkComplete` | boolean | No | — | Allows all employees who can view the training to be able to mark it complete. | | `category` | object | No | — | Category is optional and passing an empty value will remove the category from the training type. Passing a name will assign the training type to the new training category. | | `description` | string | No | — | Description for the training. | | `dueFromHireDate` | integer | No | — | Number of days before the training is due for new hires. Not valid unless training is required. | | `frequency` | integer | No | — | The frequency is the (optional) amount of months between renewing trainings. Not valid if training are not renewable. | | `linkUrl` | string | No | — | Optional URL that can be included with a training. | | `name` | string | No | — | Name of the training type. | | `renewable` | boolean | No | — | Renewable is optional but if you are setting it to true you must pass a frequency. | | `required` | boolean | No | — | Is this a required training? | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "trainingTypeId": { "type": "integer", "description": "The ID of the training type to update." }, "allowEmployeesToMarkComplete": { "type": "boolean", "description": "Allows all employees who can view the training to be able to mark it complete." }, "category": { "type": "object", "description": "Category is optional and passing an empty value will remove the category from the training type. Passing a name will assign the training type to the new training category.", "properties": { "id": { "type": "integer", "description": "Category ID" }, "name": { "type": "string", "description": "Category Name" } } }, "description": { "type": "string", "description": "Description for the training." }, "dueFromHireDate": { "type": "integer", "description": "Number of days before the training is due for new hires. Not valid unless training is required." }, "frequency": { "type": "integer", "description": "The frequency is the (optional) amount of months between renewing trainings. Not valid if training are not renewable." }, "linkUrl": { "type": "string", "description": "Optional URL that can be included with a training." }, "name": { "type": "string", "description": "Name of the training type." }, "renewable": { "type": "boolean", "description": "Renewable is optional but if you are setting it to true you must pass a frequency." }, "required": { "type": "boolean", "description": "Is this a required training?" } }, "required": [ "PCID", "trainingTypeId" ] } ``` # bamboohr-time Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bamboohr/bamboohr-time BambooHR Time - time tracking, time off requests, and hour records **Server path:** `/bamboohr-time` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bamboohr_time_adjust_time_off_balance`](#bamboohr_time_adjust_time_off_balance) | Adjust Time Off Balance | | [`bamboohr_time_assign_employees_to_break_policy`](#bamboohr_time_assign_employees_to_break_policy) | Assign Employees to Break Policy | | [`bamboohr_time_assign_time_off_policies`](#bamboohr_time_assign_time_off_policies) | Assign Time Off Policies | | [`bamboohr_time_assign_time_off_policies_v1_1`](#bamboohr_time_assign_time_off_policies_v1_1) | Assign Time Off Policies v1.1 | | [`bamboohr_time_create_break`](#bamboohr_time_create_break) | Create Break | | [`bamboohr_time_create_break_policy`](#bamboohr_time_create_break_policy) | Create Break Policy | | [`bamboohr_time_create_or_update_time_tracking_hour_records`](#bamboohr_time_create_or_update_time_tracking_hour_records) | Create or Update Hour Records | | [`bamboohr_time_create_or_update_timesheet_clock_entries`](#bamboohr_time_create_or_update_timesheet_clock_entries) | Create or Update Timesheet Clock Entries | | [`bamboohr_time_create_or_update_timesheet_hour_entries`](#bamboohr_time_create_or_update_timesheet_hour_entries) | Create or Update Timesheet Hour Entries | | [`bamboohr_time_create_time_off_history`](#bamboohr_time_create_time_off_history) | Create Time Off History Item | | [`bamboohr_time_create_time_off_request`](#bamboohr_time_create_time_off_request) | Create Time Off Request | | [`bamboohr_time_create_time_tracking_hour_record`](#bamboohr_time_create_time_tracking_hour_record) | Create Hour Record | | [`bamboohr_time_create_time_tracking_project`](#bamboohr_time_create_time_tracking_project) | Create Time Tracking Project | | [`bamboohr_time_create_timesheet_clock_in_entry`](#bamboohr_time_create_timesheet_clock_in_entry) | Create Timesheet Clock-In Entry | | [`bamboohr_time_create_timesheet_clock_out_entry`](#bamboohr_time_create_timesheet_clock_out_entry) | Create Timesheet Clock-Out Entry | | [`bamboohr_time_delete_break`](#bamboohr_time_delete_break) | Delete Break | | [`bamboohr_time_delete_break_policy`](#bamboohr_time_delete_break_policy) | Delete Break Policy | | [`bamboohr_time_delete_timesheet_clock_entries_via_post`](#bamboohr_time_delete_timesheet_clock_entries_via_post) | Delete Timesheet Clock Entries | | [`bamboohr_time_delete_timesheet_hour_entries_via_post`](#bamboohr_time_delete_timesheet_hour_entries_via_post) | Delete Timesheet Hour Entries | | [`bamboohr_time_delete_tracking_hour_record`](#bamboohr_time_delete_tracking_hour_record) | Delete Hour Record | | [`bamboohr_time_get_break`](#bamboohr_time_get_break) | Get Break | | [`bamboohr_time_get_break_policy`](#bamboohr_time_get_break_policy) | Get Break Policy | | [`bamboohr_time_get_off_balance`](#bamboohr_time_get_off_balance) | Get Time Off Balance | | [`bamboohr_time_get_tracking_record`](#bamboohr_time_get_tracking_record) | Get Time Tracking Record | | [`bamboohr_time_list_break_assessments`](#bamboohr_time_list_break_assessments) | List Break Assessments | | [`bamboohr_time_list_break_policies`](#bamboohr_time_list_break_policies) | List Break Policies | | [`bamboohr_time_list_break_policy_breaks`](#bamboohr_time_list_break_policy_breaks) | List Breaks for Break Policy | | [`bamboohr_time_list_break_policy_employees`](#bamboohr_time_list_break_policy_employees) | List Break Policy Employees | | [`bamboohr_time_list_employee_break_availabilities`](#bamboohr_time_list_employee_break_availabilities) | List Employee Break Availabilities | | [`bamboohr_time_list_employee_break_policies`](#bamboohr_time_list_employee_break_policies) | List Employee Break Policies | | [`bamboohr_time_list_employee_time_off_policies`](#bamboohr_time_list_employee_time_off_policies) | List Employee Time Off Policies | | [`bamboohr_time_list_employee_time_off_policies_v1_1`](#bamboohr_time_list_employee_time_off_policies_v1_1) | List Employee Time Off Policies v1.1 | | [`bamboohr_time_list_time_off_policies`](#bamboohr_time_list_time_off_policies) | List Time Off Policies | | [`bamboohr_time_list_time_off_requests`](#bamboohr_time_list_time_off_requests) | List Time Off Requests | | [`bamboohr_time_list_time_off_types`](#bamboohr_time_list_time_off_types) | List Time Off Types | | [`bamboohr_time_list_timesheet_entries`](#bamboohr_time_list_timesheet_entries) | List Timesheet Entries | | [`bamboohr_time_list_whos_out`](#bamboohr_time_list_whos_out) | List Who’s Out | | [`bamboohr_time_replace_breaks_for_break_policy`](#bamboohr_time_replace_breaks_for_break_policy) | Replace Breaks for Break Policy | | [`bamboohr_time_set_break_policy_employees`](#bamboohr_time_set_break_policy_employees) | Set Employees for Break Policy | | [`bamboohr_time_sync_break_policy`](#bamboohr_time_sync_break_policy) | Sync Break Policy | | [`bamboohr_time_unassign_employees_from_break_policy`](#bamboohr_time_unassign_employees_from_break_policy) | Unassign Employees from Break Policy | | [`bamboohr_time_update_break`](#bamboohr_time_update_break) | Update Break | | [`bamboohr_time_update_break_policy`](#bamboohr_time_update_break_policy) | Update Break Policy | | [`bamboohr_time_update_time_off_request_status`](#bamboohr_time_update_time_off_request_status) | Update Time Off Request Status | | [`bamboohr_time_update_time_tracking_record`](#bamboohr_time_update_time_tracking_record) | Update Hour Record | *** ## bamboohr\_time\_adjust\_time\_off\_balance Adjust Time Off Balance **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee. | | `amount` | number | No | — | The number of hours/days to adjust the balance by. | | `date` | string | No | — | The date the adjustment should be added in history. Should be in ISO8601 date format (YYYY-MM-DD). | | `note` | string | No | — | This is an optional note to show in history. | | `timeOffTypeId` | integer | No | — | The ID of the time off type to add a balance adjustment for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee." }, "amount": { "type": "number", "description": "The number of hours/days to adjust the balance by." }, "date": { "type": "string", "description": "The date the adjustment should be added in history. Should be in ISO8601 date format (YYYY-MM-DD)." }, "note": { "type": "string", "description": "This is an optional note to show in history." }, "timeOffTypeId": { "type": "integer", "description": "The ID of the time off type to add a balance adjustment for." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_time\_assign\_employees\_to\_break\_policy Assign Employees to Break Policy **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | | `employeeIds` | integer\[] | Yes | — | Array of employee IDs to assign to the break policy | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." }, "employeeIds": { "type": "array", "items": { "type": "integer" }, "description": "Array of employee IDs to assign to the break policy" } }, "required": [ "PCID", "id", "employeeIds" ] } ``` *** ## bamboohr\_time\_assign\_time\_off\_policies Assign Time Off Policies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee to assign policies to. | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee to assign policies to." }, "body": { "type": "array", "items": { "type": "object", "properties": { "timeOffPolicyId": { "type": "integer", "description": "The ID of the time off policy to assign." }, "accrualStartDate": { "type": "string", "format": "date", "description": "The date accruals should start in YYYY-MM-DD format. Set to null to remove an existing assignment." } }, "required": [ "timeOffPolicyId", "accrualStartDate" ] }, "description": "Request body" } }, "required": [ "PCID", "employeeId", "body" ] } ``` *** ## bamboohr\_time\_assign\_time\_off\_policies\_v1\_1 Assign Time Off Policies v1.1 **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee to assign policies to. | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee to assign policies to." }, "body": { "type": "array", "items": { "type": "object", "properties": { "timeOffPolicyId": { "type": "integer", "description": "The ID of the time off policy to assign." }, "accrualStartDate": { "type": "string", "format": "date", "description": "The date accruals should start in YYYY-MM-DD format. Set to null to remove an existing assignment." } }, "required": [ "timeOffPolicyId", "accrualStartDate" ] }, "description": "Request body" } }, "required": [ "PCID", "employeeId", "body" ] } ``` *** ## bamboohr\_time\_create\_break Create Break **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | | | `availabilityEndTime` | string | null | No | — | Latest time the break can be taken (HH:MM format) | | `availabilityMaxHoursWorked` | number | null | No | — | Maximum hours that can be worked before the break must be taken | | `availabilityMinHoursWorked` | number | null | No | — | Minimum hours that must be worked before the break can be taken | | `availabilityStartTime` | string | null | No | — | Earliest time the break can be taken (HH:MM format) | | `availabilityType` | object | No | — | When the break is available to be taken | | | `duration` | integer | No | — | Duration of the break in minutes | | | `name` | string | No | — | The name of the break | | | `paid` | boolean | No | — | Whether the break is paid | | | `policyId` | string | No | — | The unique identifier of the break policy this break belongs to | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." }, "availabilityEndTime": { "type": [ "string", "null" ], "description": "Latest time the break can be taken (HH:MM format)" }, "availabilityMaxHoursWorked": { "type": [ "number", "null" ], "description": "Maximum hours that can be worked before the break must be taken" }, "availabilityMinHoursWorked": { "type": [ "number", "null" ], "description": "Minimum hours that must be worked before the break can be taken" }, "availabilityStartTime": { "type": [ "string", "null" ], "description": "Earliest time the break can be taken (HH:MM format)" }, "availabilityType": { "description": "When the break is available to be taken", "enum": [ "anytime", "hours_worked", "time_of_day" ] }, "duration": { "type": "integer", "description": "Duration of the break in minutes" }, "name": { "type": "string", "description": "The name of the break" }, "paid": { "type": "boolean", "description": "Whether the break is paid" }, "policyId": { "type": "string", "description": "The unique identifier of the break policy this break belongs to" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_create\_break\_policy Create Break Policy **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `allEmployeesAssigned` | boolean | No | — | Whether all employees are assigned to this break policy | | | `breaks` | object\[] | No | — | Collection of time tracking breaks to create or update without a policy | | | `description` | string | null | No | — | Optional description of the break policy | | `employeeIds` | integer\[] | No | — | The employees that should be assigned to this policy | | | `name` | string | Yes | — | Name of the break policy | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allEmployeesAssigned": { "type": "boolean", "description": "Whether all employees are assigned to this break policy" }, "breaks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the break. If not included, a new break will be created." }, "name": { "type": "string", "description": "The name of the break" }, "paid": { "type": "boolean", "description": "Whether the break is paid" }, "duration": { "type": "integer", "description": "Duration of the break in minutes" }, "availabilityType": { "enum": [ "anytime", "hours_worked", "time_of_day" ], "description": "When the break is available to be taken" }, "availabilityMinHoursWorked": { "type": "number", "format": "float", "description": "Minimum hours that must be worked before the break can be taken" }, "availabilityMaxHoursWorked": { "type": "number", "format": "float", "description": "Maximum hours that can be worked before the break must be taken" }, "availabilityStartTime": { "type": "string", "format": "time", "description": "Earliest time the break can be taken (HH:MM format)" }, "availabilityEndTime": { "type": "string", "format": "time", "description": "Latest time the break can be taken (HH:MM format)" } } }, "description": "Collection of time tracking breaks to create or update without a policy" }, "description": { "type": [ "string", "null" ], "description": "Optional description of the break policy" }, "employeeIds": { "type": "array", "items": { "type": "integer" }, "description": "The employees that should be assigned to this policy" }, "name": { "type": "string", "description": "Name of the break policy" } }, "required": [ "PCID", "name" ] } ``` *** ## bamboohr\_time\_create\_or\_update\_time\_tracking\_hour\_records Create or Update Hour Records **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "timeTrackingId": { "type": "string", "description": "A unique identifier for the record. Use this ID to adjust or delete these hours. It can be any ID you use to track the record up to 36 characters in length. (i.e. UUID)." }, "employeeId": { "type": "integer", "description": "The ID of the employee." }, "divisionId": { "type": "integer", "description": "[Optional] The ID of the division for the employee." }, "departmentId": { "type": "integer", "description": "[Optional] The ID of the department for the employee." }, "jobTitleId": { "type": "integer", "description": "[Optional] The ID of the job title for the employee." }, "payCode": { "type": "string", "description": "[Optional] Only necessary if the payroll provider requires a pay code" }, "dateHoursWorked": { "type": "string", "description": "The date the hours were worked. Please use the ISO-8601 date format YYYY-MM-DD." }, "payRate": { "type": "number", "description": "[Optional] The rate of pay. e.g. $15.00/hour should use 15.00 here. Only necessary if the payroll provider requires a pay rate." }, "rateType": { "type": "string", "description": "The type of hours - regular or overtime. Please use either \"REG\", \"OT\", or \"DT\" here." }, "hoursWorked": { "type": "number", "description": "The number of hours worked." }, "jobCode": { "type": "integer", "description": "[Optional] A job code." }, "jobData": { "type": "string", "description": "[Optional] A list of up to four 20 characters max job numbers in comma delimited format with no spaces." } }, "required": [ "dateHoursWorked", "employeeId", "hoursWorked", "rateType", "timeTrackingId" ] }, "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## bamboohr\_time\_create\_or\_update\_timesheet\_clock\_entries Create or Update Timesheet Clock Entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `entries` | object\[] | Yes | — | Array of clock entries | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "employeeId": { "type": "integer", "description": "Unique identifier for the employee." }, "date": { "type": "string", "format": "date", "description": "Date for the timesheet entry. Must be in YYYY-MM-DD format." }, "start": { "type": "string", "description": "Start time for the timesheet entry. Local time for the employee. Must be in hh:mm 24 hour format." }, "end": { "type": "string", "description": "End time for the timesheet entry. Local time for the employee. Must be in hh:mm 24 hour format." }, "id": { "type": "integer", "description": "The ID of an existing timesheet entry. This can be specified to edit an existing entry." }, "projectId": { "type": "integer", "description": "The ID of the project to associate with the timesheet entry." }, "taskId": { "type": "integer", "description": "The ID of the task to associate with the timesheet entry." }, "note": { "type": "string", "description": "Optional note to associate with the timesheet entry." }, "breakId": { "type": "string", "format": "uuid", "description": "Optional break id to associate with the timesheet entry." } }, "required": [ "employeeId", "date", "start", "end" ] }, "description": "Array of clock entries" } }, "required": [ "PCID", "entries" ] } ``` *** ## bamboohr\_time\_create\_or\_update\_timesheet\_hour\_entries Create or Update Timesheet Hour Entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `hours` | object\[] | Yes | — | Array of hour entries to add or update | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "hours": { "type": "array", "items": { "type": "object", "properties": { "employeeId": { "type": "integer", "description": "Unique identifier for the employee" }, "date": { "type": "string", "format": "date", "description": "Date for the timesheet entry. Must be in YYYY-MM-DD format" }, "hours": { "type": "number", "format": "float", "description": "Hours worked for this timesheet entry" }, "id": { "type": "integer", "description": "The ID of an existing timesheet entry. This can be specified to edit an existing entry" }, "projectId": { "type": "integer", "description": "The ID of the project to associate with the timesheet entry" }, "taskId": { "type": "integer", "description": "The ID of the task to associate with the timesheet entry" }, "note": { "type": "string", "description": "Optional note to associate with the timesheet entry" } } }, "description": "Array of hour entries to add or update" } }, "required": [ "PCID", "hours" ] } ``` *** ## bamboohr\_time\_create\_time\_off\_history Create Time Off History Item **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee. | | `amount` | number | No | — | The number of hours/days to record. Required when eventType is `override`. | | `date` | string | No | — | The date for the history item in YYYY-MM-DD format. | | `eventType` | string | No | — | The type of history event. Defaults to `used` for the /history path and `override` for the /balance\_adjustment path when omitted. | | `note` | string | No | — | An optional note to show in history. | | `timeOffRequestId` | integer | No | — | The ID of an approved time off request. Required when eventType is `used`. | | `timeOffTypeId` | integer | No | — | The ID of the time off type. Required when eventType is `override`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee." }, "amount": { "type": "number", "description": "The number of hours/days to record. Required when eventType is `override`." }, "date": { "type": "string", "description": "The date for the history item in YYYY-MM-DD format." }, "eventType": { "type": "string", "description": "The type of history event. Defaults to `used` for the /history path and `override` for the /balance_adjustment path when omitted.", "enum": [ "used", "override" ] }, "note": { "type": "string", "description": "An optional note to show in history." }, "timeOffRequestId": { "type": "integer", "description": "The ID of an approved time off request. Required when eventType is `used`." }, "timeOffTypeId": { "type": "integer", "description": "The ID of the time off type. Required when eventType is `override`." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_time\_create\_time\_off\_request Create Time Off Request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee to create the time off request for. | | `amount` | number | No | — | Total hours or days requested. Ignored when `dates` array is provided (sum of daily amounts is used instead). | | `dates` | object\[] | No | — | Optional per-day breakdown. When provided, the top-level `amount` is ignored and the sum of daily amounts is used. | | `end` | string | No | — | End date in YYYY-MM-DD format. Must be on or after the start date. | | `notes` | object\[] | No | — | Optional notes from the employee or manager. | | `previousRequest` | integer | No | — | The ID of a previous time off request to supersede. The previous request will be cancelled. | | `start` | string | No | — | Start date in YYYY-MM-DD format. | | `status` | string | No | — | The initial status of the request. | | `timeOffTypeId` | integer | No | — | The ID of the time off type for this request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee to create the time off request for." }, "amount": { "type": "number", "description": "Total hours or days requested. Ignored when `dates` array is provided (sum of daily amounts is used instead)." }, "dates": { "type": "array", "items": { "type": "object", "properties": { "ymd": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "amount": { "type": "number", "description": "Hours or days for this date." } } }, "description": "Optional per-day breakdown. When provided, the top-level `amount` is ignored and the sum of daily amounts is used." }, "end": { "type": "string", "description": "End date in YYYY-MM-DD format. Must be on or after the start date." }, "notes": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "enum": [ "employee", "manager" ], "description": "Who the note is from." }, "note": { "type": "string", "description": "The note text." } } }, "description": "Optional notes from the employee or manager." }, "previousRequest": { "type": "integer", "description": "The ID of a previous time off request to supersede. The previous request will be cancelled." }, "start": { "type": "string", "description": "Start date in YYYY-MM-DD format." }, "status": { "type": "string", "description": "The initial status of the request.", "enum": [ "approved", "denied", "declined", "requested" ] }, "timeOffTypeId": { "type": "integer", "description": "The ID of the time off type for this request." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_time\_create\_time\_tracking\_hour\_record Create Hour Record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dateHoursWorked` | string | Yes | — | The date the hours were worked. Please use the ISO-8601 date format YYYY-MM-DD. | | `departmentId` | integer | No | — | \[Optional] The ID of the department for the employee. | | `divisionId` | integer | No | — | \[Optional] The ID of the division for the employee. | | `employeeId` | integer | Yes | — | The ID of the employee. | | `hoursWorked` | number | Yes | — | The number of hours worked. | | `jobCode` | integer | No | — | \[Optional] A job code. | | `jobData` | string | No | — | \[Optional] A list of up to four 20 characters max job numbers in comma delimited format with no spaces. | | `jobTitleId` | integer | No | — | \[Optional] The ID of the job title for the employee. | | `payCode` | string | No | — | \[Optional] Only necessary if the payroll provider requires a pay code | | `payRate` | number | No | — | \[Optional] The rate of pay. e.g. \$15.00/hour should use 15.00 here. Only necessary if the payroll provider requires a pay rate. | | `rateType` | string | Yes | — | The type of hours - regular or overtime. Please use either "REG", "OT", or "DT" here. | | `timeTrackingId` | string | Yes | — | A unique identifier for the record. Use this ID to adjust or delete these hours. It can be any ID you use to track the record up to 36 characters in length. (i.e. UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dateHoursWorked": { "type": "string", "description": "The date the hours were worked. Please use the ISO-8601 date format YYYY-MM-DD." }, "departmentId": { "type": "integer", "description": "[Optional] The ID of the department for the employee." }, "divisionId": { "type": "integer", "description": "[Optional] The ID of the division for the employee." }, "employeeId": { "type": "integer", "description": "The ID of the employee." }, "hoursWorked": { "type": "number", "description": "The number of hours worked." }, "jobCode": { "type": "integer", "description": "[Optional] A job code." }, "jobData": { "type": "string", "description": "[Optional] A list of up to four 20 characters max job numbers in comma delimited format with no spaces." }, "jobTitleId": { "type": "integer", "description": "[Optional] The ID of the job title for the employee." }, "payCode": { "type": "string", "description": "[Optional] Only necessary if the payroll provider requires a pay code" }, "payRate": { "type": "number", "description": "[Optional] The rate of pay. e.g. $15.00/hour should use 15.00 here. Only necessary if the payroll provider requires a pay rate." }, "rateType": { "type": "string", "description": "The type of hours - regular or overtime. Please use either \"REG\", \"OT\", or \"DT\" here." }, "timeTrackingId": { "type": "string", "description": "A unique identifier for the record. Use this ID to adjust or delete these hours. It can be any ID you use to track the record up to 36 characters in length. (i.e. UUID)." } }, "required": [ "PCID", "dateHoursWorked", "employeeId", "hoursWorked", "rateType", "timeTrackingId" ] } ``` *** ## bamboohr\_time\_create\_time\_tracking\_project Create Time Tracking Project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `allowAllEmployees` | boolean | No | — | Indicates if all employees can log time for this project. Defaults to true if not provided. | | `billable` | boolean | No | — | Indicates if the project is billable. Defaults to true if not provided. | | `employeeIds` | integer\[] | No | — | A list of employee IDs that can log time for this project. Only used when `allowAllEmployees` is false. | | `hasTasks` | boolean | No | — | Indicates if the project has tasks. Defaults to false if not provided. | | `name` | string | Yes | — | Name of the project. Must be unique and no more than 50 characters. | | `tasks` | object\[] | No | — | List of tasks to create and associate with the project. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allowAllEmployees": { "type": "boolean", "description": "Indicates if all employees can log time for this project. Defaults to true if not provided." }, "billable": { "type": "boolean", "description": "Indicates if the project is billable. Defaults to true if not provided." }, "employeeIds": { "type": "array", "items": { "type": "integer" }, "description": "A list of employee IDs that can log time for this project. Only used when `allowAllEmployees` is false." }, "hasTasks": { "type": "boolean", "description": "Indicates if the project has tasks. Defaults to false if not provided." }, "name": { "type": "string", "description": "Name of the project. Must be unique and no more than 50 characters." }, "tasks": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the task." }, "billable": { "type": "boolean", "description": "Indicates if the task is billable. Defaults to true if not provided." } }, "required": [ "name" ] }, "description": "List of tasks to create and associate with the project." } }, "required": [ "PCID", "name" ] } ``` *** ## bamboohr\_time\_create\_timesheet\_clock\_in\_entry Create Timesheet Clock-In Entry **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `employeeId` | integer | Yes | — | ID of the employee to clock in. | | | `breakId` | string | null | No | — | ID of the break that should be associated with the timesheet entry. | | `date` | string | null | No | — | Date for the timesheet entry. Must be in YYYY-MM-DD format. | | `note` | string | null | No | — | The note that should be associated with the timesheet entry | | `offline` | boolean | No | — | Whether this is an offline punch. When true, bypasses the shift schedule clock-in restriction. Intended for devices that store punches offline and sync later. | | | `projectId` | integer | null | No | — | ID of the time tracking project that should be associated with the timesheet entry. Required if taskId is specified. | | `start` | string | null | No | — | The time for the clock in. In 24 hour format HH:MM | | `taskId` | integer | null | No | — | ID of the time tracking task that should be associated with the timesheet entry. | | `timezone` | string | null | No | — | The timezone associated with the clock in. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "ID of the employee to clock in." }, "breakId": { "type": [ "string", "null" ], "description": "ID of the break that should be associated with the timesheet entry." }, "date": { "type": [ "string", "null" ], "description": "Date for the timesheet entry. Must be in YYYY-MM-DD format." }, "note": { "type": [ "string", "null" ], "description": "The note that should be associated with the timesheet entry" }, "offline": { "type": "boolean", "description": "Whether this is an offline punch. When true, bypasses the shift schedule clock-in restriction. Intended for devices that store punches offline and sync later." }, "projectId": { "type": [ "integer", "null" ], "description": "ID of the time tracking project that should be associated with the timesheet entry. Required if taskId is specified." }, "start": { "type": [ "string", "null" ], "description": "The time for the clock in. In 24 hour format HH:MM" }, "taskId": { "type": [ "integer", "null" ], "description": "ID of the time tracking task that should be associated with the timesheet entry." }, "timezone": { "type": [ "string", "null" ], "description": "The timezone associated with the clock in." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_time\_create\_timesheet\_clock\_out\_entry Create Timesheet Clock-Out Entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | ID of the employee to clock out. | | `date` | string | No | — | Date for the timesheet entry. Must be in YYYY-MM-DD format. | | `end` | string | No | — | The time for the clock out. In 24 hour format HH:MM | | `timezone` | string | No | — | The timezone associated with the clock out. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "ID of the employee to clock out." }, "date": { "type": "string", "description": "Date for the timesheet entry. Must be in YYYY-MM-DD format." }, "end": { "type": "string", "description": "The time for the clock out. In 24 hour format HH:MM" }, "timezone": { "type": "string", "description": "The timezone associated with the clock out." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_time\_delete\_break Delete Break **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The break ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break ID." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_delete\_break\_policy Delete Break Policy **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_delete\_timesheet\_clock\_entries\_via\_post Delete Timesheet Clock Entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `clockEntryIds` | integer\[] | Yes | — | Array of clock entry IDs to process | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clockEntryIds": { "type": "array", "items": { "type": "integer" }, "description": "Array of clock entry IDs to process" } }, "required": [ "PCID", "clockEntryIds" ] } ``` *** ## bamboohr\_time\_delete\_timesheet\_hour\_entries\_via\_post Delete Timesheet Hour Entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `hourEntryIds` | integer\[] | Yes | — | Array of hour entry IDs to process | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "hourEntryIds": { "type": "array", "items": { "type": "integer" }, "description": "Array of hour entry IDs to process" } }, "required": [ "PCID", "hourEntryIds" ] } ``` *** ## bamboohr\_time\_delete\_tracking\_hour\_record Delete Hour Record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The time tracking id is the id that was used to track the record up to 36 characters in length. (i.e. UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The time tracking id is the id that was used to track the record up to 36 characters in length. (i.e. UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_get\_break Get Break **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The break ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break ID." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_get\_break\_policy Get Break Policy **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | | `includeCounts` | boolean | No | — | Include employee and break counts | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." }, "includeCounts": { "type": "boolean", "description": "Include employee and break counts" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_get\_off\_balance Get Time Off Balance **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | | `end` | string | No | — | The date to calculate the time off balance as of, in YYYY-MM-DD format. Defaults to company today if not provided. Example: use a future date to project balance. | | `precision` | integer | No | — | Number of decimal places for balance and usedYearToDate values. Minimum 0, maximum 4. Defaults to 2. | | `employeeId` | integer | Yes | — | The ID of the employee to get time off balances for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] }, "end": { "type": "string", "description": "The date to calculate the time off balance as of, in YYYY-MM-DD format. Defaults to company today if not provided. Example: use a future date to project balance." }, "precision": { "type": "integer", "description": "Number of decimal places for balance and usedYearToDate values. Minimum 0, maximum 4. Defaults to 2." }, "employeeId": { "type": "integer", "description": "The ID of the employee to get time off balances for." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_time\_get\_tracking\_record Get Time Tracking Record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The time tracking record ID used to originally create the record. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The time tracking record ID used to originally create the record." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_list\_break\_assessments List Break Assessments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | Number of items to skip before returning results. Defaults to 0. | | `limit` | integer | No | — | Maximum number of items to return. Defaults to 100. Maximum is 500. | | `filter` | string | No | — | OData v4 filter expression. Filterable fields: `id`, `breakId`, `employeeId`, `employeeTimesheetId`, `date`, `result`, `availableYmdt`, `unavailableYmdt`, `createdAt`, `updatedAt`, `expectedDuration`, `recordedDuration`, `durationDifference`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "Number of items to skip before returning results. Defaults to 0." }, "limit": { "type": "integer", "description": "Maximum number of items to return. Defaults to 100. Maximum is 500." }, "filter": { "type": "string", "description": "OData v4 filter expression. Filterable fields: `id`, `breakId`, `employeeId`, `employeeTimesheetId`, `date`, `result`, `availableYmdt`, `unavailableYmdt`, `createdAt`, `updatedAt`, `expectedDuration`, `recordedDuration`, `durationDifference`." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_time\_list\_break\_policies List Break Policies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The offset of items to retrieve | | `limit` | integer | No | — | The maximum items to retrieve | | `filter` | string | No | — | Filter by an OData (Open Data Protocol) v4 specification | | `includeCounts` | boolean | No | — | Include employee and break counts | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The offset of items to retrieve" }, "limit": { "type": "integer", "description": "The maximum items to retrieve" }, "filter": { "type": "string", "description": "Filter by an OData (Open Data Protocol) v4 specification" }, "includeCounts": { "type": "boolean", "description": "Include employee and break counts" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_time\_list\_break\_policy\_breaks List Breaks for Break Policy **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | | `offset` | integer | No | — | The offset of items to retrieve | | `limit` | integer | No | — | The maximum items to retrieve | | `filter` | string | No | — | Filter by an OData (Open Data Protocol) v4 specification | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." }, "offset": { "type": "integer", "description": "The offset of items to retrieve" }, "limit": { "type": "integer", "description": "The maximum items to retrieve" }, "filter": { "type": "string", "description": "Filter by an OData (Open Data Protocol) v4 specification" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_list\_break\_policy\_employees List Break Policy Employees **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | | `offset` | integer | No | — | The offset of items to retrieve | | `limit` | integer | No | — | The maximum items to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." }, "offset": { "type": "integer", "description": "The offset of items to retrieve" }, "limit": { "type": "integer", "description": "The maximum items to retrieve" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_list\_employee\_break\_availabilities List Employee Break Availabilities **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The employee ID. | | `effective` | string | No | — | The employee's local time that should be used to calculate availability. Defaults to the current time. Must be in Y-m-d\TH:i:s format (no timezone offset). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The employee ID." }, "effective": { "type": "string", "description": "The employee's local time that should be used to calculate availability. Defaults to the current time. Must be in Y-m-d\\TH:i:s format (no timezone offset)." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_list\_employee\_break\_policies List Employee Break Policies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The employee ID. | | `offset` | integer | No | — | The number of items to skip before starting to collect the result set. Minimum 0. Defaults to 0. | | `limit` | integer | No | — | The maximum number of items to return. Must be between 0 and 500. Defaults to 100. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The employee ID." }, "offset": { "type": "integer", "description": "The number of items to skip before starting to collect the result set. Minimum 0. Defaults to 0." }, "limit": { "type": "integer", "description": "The maximum number of items to return. Must be between 0 and 500. Defaults to 100." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_list\_employee\_time\_off\_policies List Employee Time Off Policies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_time\_list\_employee\_time\_off\_policies\_v1\_1 List Employee Time Off Policies v1.1 **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `employeeId` | integer | Yes | — | The ID of the employee. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee." } }, "required": [ "PCID", "employeeId" ] } ``` *** ## bamboohr\_time\_list\_time\_off\_policies List Time Off Policies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_time\_list\_time\_off\_requests List Time Off Requests **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | | `id` | integer | No | — | A particular request ID to limit the response to. | | `action` | string | No | — | Limit to requests the caller can `view`, requests they can `approve`, or only their own requests via `myRequests`. Defaults to `view`. | | `employeeId` | integer | No | — | A particular employee ID to limit the response to. | | `start` | string | Yes | — | Only include requests that end on or after this date. YYYY-MM-DD format. | | `end` | string | Yes | — | Only include requests that start on or before this date. YYYY-MM-DD format. | | `type` | string | No | — | A comma-separated list of time off type IDs to filter by. If omitted, requests of all types are included. | | `status` | string | No | — | A comma-separated list of request status values to filter by. Accepted values are approved, denied, superceded, requested, and canceled. If omitted, requests of all statuses are included. | | `excludeNote` | string | No | — | When set to any truthy value, omits the `notes` object from each request in the response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] }, "id": { "type": "integer", "description": "A particular request ID to limit the response to." }, "action": { "type": "string", "description": "Limit to requests the caller can `view`, requests they can `approve`, or only their own requests via `myRequests`. Defaults to `view`.", "enum": [ "view", "approve", "myRequests" ] }, "employeeId": { "type": "integer", "description": "A particular employee ID to limit the response to." }, "start": { "type": "string", "description": "Only include requests that end on or after this date. YYYY-MM-DD format." }, "end": { "type": "string", "description": "Only include requests that start on or before this date. YYYY-MM-DD format." }, "type": { "type": "string", "description": "A comma-separated list of time off type IDs to filter by. If omitted, requests of all types are included." }, "status": { "type": "string", "description": "A comma-separated list of request status values to filter by. Accepted values are approved, denied, superceded, requested, and canceled. If omitted, requests of all statuses are included." }, "excludeNote": { "type": "string", "description": "When set to any truthy value, omits the `notes` object from each request in the response." } }, "required": [ "PCID", "start", "end" ] } ``` *** ## bamboohr\_time\_list\_time\_off\_types List Time Off Types **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | | `mode` | string | No | — | Set to `request` to limit the results to time off types the authenticated employee can request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] }, "mode": { "type": "string", "description": "Set to `request` to limit the results to time off types the authenticated employee can request.", "enum": [ "request" ] } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_time\_list\_timesheet\_entries List Timesheet Entries **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `start` | string | Yes | — | YYYY-MM-DD. Only show timesheet entries on/after the specified start date. Must be within the last 365 days. | | `end` | string | Yes | — | YYYY-MM-DD. Only show timesheet entries on/before the specified end date. Must be within the last 365 days. | | `employeeIds` | string | No | — | A comma separated list of employee IDs. When specified, only entries that match these employee IDs are returned. When omitted, entries for all accessible employees are returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "start": { "type": "string", "description": "YYYY-MM-DD. Only show timesheet entries on/after the specified start date. Must be within the last 365 days." }, "end": { "type": "string", "description": "YYYY-MM-DD. Only show timesheet entries on/before the specified end date. Must be within the last 365 days." }, "employeeIds": { "type": "string", "description": "A comma separated list of employee IDs. When specified, only entries that match these employee IDs are returned. When omitted, entries for all accessible employees are returned." } }, "required": [ "PCID", "start", "end" ] } ``` *** ## bamboohr\_time\_list\_whos\_out List Who’s Out **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | | `start` | string | No | — | Start date in YYYY-MM-DD format. Defaults to today. | | `end` | string | No | — | End date in YYYY-MM-DD format. Defaults to 14 days after the start date. | | `filter` | string | No | — | Set to `off` to disable the Who's Out visibility filter and return the unfiltered feed. Any other value leaves filtering enabled. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] }, "start": { "type": "string", "description": "Start date in YYYY-MM-DD format. Defaults to today." }, "end": { "type": "string", "description": "End date in YYYY-MM-DD format. Defaults to 14 days after the start date." }, "filter": { "type": "string", "description": "Set to `off` to disable the Who's Out visibility filter and return the unfiltered feed. Any other value leaves filtering enabled.", "enum": [ "off" ] } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_time\_replace\_breaks\_for\_break\_policy Replace Breaks for Break Policy **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | | `body` | object\[] | Yes | — | Collection of time tracking breaks to create or update without a policy | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." }, "body": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the break. If not included, a new break will be created." }, "name": { "type": "string", "description": "The name of the break" }, "paid": { "type": "boolean", "description": "Whether the break is paid" }, "duration": { "type": "integer", "description": "Duration of the break in minutes" }, "availabilityType": { "enum": [ "anytime", "hours_worked", "time_of_day" ], "description": "When the break is available to be taken" }, "availabilityMinHoursWorked": { "type": "number", "format": "float", "description": "Minimum hours that must be worked before the break can be taken" }, "availabilityMaxHoursWorked": { "type": "number", "format": "float", "description": "Maximum hours that can be worked before the break must be taken" }, "availabilityStartTime": { "type": "string", "format": "time", "description": "Earliest time the break can be taken (HH:MM format)" }, "availabilityEndTime": { "type": "string", "format": "time", "description": "Latest time the break can be taken (HH:MM format)" } } }, "description": "Collection of time tracking breaks to create or update without a policy" } }, "required": [ "PCID", "id", "body" ] } ``` *** ## bamboohr\_time\_set\_break\_policy\_employees Set Employees for Break Policy **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | | `employeeIds` | integer\[] | No | — | Array of employee IDs to assign to the break policy. Replaces all existing assignments. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." }, "employeeIds": { "type": "array", "items": { "type": "integer" }, "description": "Array of employee IDs to assign to the break policy. Replaces all existing assignments." } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_sync\_break\_policy Sync Break Policy **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | | | `allEmployeesAssigned` | boolean | No | — | Whether all employees are assigned to this break policy | | | `breaks` | object\[] | No | — | Collection of time tracking breaks to create or update without a policy | | | `description` | string | null | No | — | Optional description of the break policy | | `employeeIds` | integer\[] | No | — | The employees that should be assigned to this policy | | | `name` | string | No | — | Name of the break policy | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." }, "allEmployeesAssigned": { "type": "boolean", "description": "Whether all employees are assigned to this break policy" }, "breaks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the break. If not included, a new break will be created." }, "name": { "type": "string", "description": "The name of the break" }, "paid": { "type": "boolean", "description": "Whether the break is paid" }, "duration": { "type": "integer", "description": "Duration of the break in minutes" }, "availabilityType": { "enum": [ "anytime", "hours_worked", "time_of_day" ], "description": "When the break is available to be taken" }, "availabilityMinHoursWorked": { "type": "number", "format": "float", "description": "Minimum hours that must be worked before the break can be taken" }, "availabilityMaxHoursWorked": { "type": "number", "format": "float", "description": "Maximum hours that can be worked before the break must be taken" }, "availabilityStartTime": { "type": "string", "format": "time", "description": "Earliest time the break can be taken (HH:MM format)" }, "availabilityEndTime": { "type": "string", "format": "time", "description": "Latest time the break can be taken (HH:MM format)" } } }, "description": "Collection of time tracking breaks to create or update without a policy" }, "description": { "type": [ "string", "null" ], "description": "Optional description of the break policy" }, "employeeIds": { "type": "array", "items": { "type": "integer" }, "description": "The employees that should be assigned to this policy" }, "name": { "type": "string", "description": "Name of the break policy" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_unassign\_employees\_from\_break\_policy Unassign Employees from Break Policy **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | | `employeeIds` | integer\[] | Yes | — | Array of employee IDs to unassign from the break policy | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." }, "employeeIds": { "type": "array", "items": { "type": "integer" }, "description": "Array of employee IDs to unassign from the break policy" } }, "required": [ "PCID", "id", "employeeIds" ] } ``` *** ## bamboohr\_time\_update\_break Update Break **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `id` | string | Yes | — | The break ID. | | | `availabilityEndTime` | string | null | No | — | Latest time the break can be taken (HH:MM format) | | `availabilityMaxHoursWorked` | number | null | No | — | Maximum hours that can be worked before the break must be taken | | `availabilityMinHoursWorked` | number | null | No | — | Minimum hours that must be worked before the break can be taken | | `availabilityStartTime` | string | null | No | — | Earliest time the break can be taken (HH:MM format) | | `availabilityType` | object | No | — | When the break is available to be taken | | | `duration` | integer | No | — | Duration of the break in minutes | | | `name` | string | No | — | The name of the break | | | `paid` | boolean | No | — | Whether the break is paid | | | `policyId` | string | No | — | The unique identifier of the break policy this break belongs to | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break ID." }, "availabilityEndTime": { "type": [ "string", "null" ], "description": "Latest time the break can be taken (HH:MM format)" }, "availabilityMaxHoursWorked": { "type": [ "number", "null" ], "description": "Maximum hours that can be worked before the break must be taken" }, "availabilityMinHoursWorked": { "type": [ "number", "null" ], "description": "Minimum hours that must be worked before the break can be taken" }, "availabilityStartTime": { "type": [ "string", "null" ], "description": "Earliest time the break can be taken (HH:MM format)" }, "availabilityType": { "description": "When the break is available to be taken", "enum": [ "anytime", "hours_worked", "time_of_day" ] }, "duration": { "type": "integer", "description": "Duration of the break in minutes" }, "name": { "type": "string", "description": "The name of the break" }, "paid": { "type": "boolean", "description": "Whether the break is paid" }, "policyId": { "type": "string", "description": "The unique identifier of the break policy this break belongs to" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_update\_break\_policy Update Break Policy **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `id` | string | Yes | — | The break policy ID. | | | `allEmployeesAssigned` | boolean | No | — | Whether all employees are assigned to this break policy | | | `description` | string | null | No | — | Optional description of the break policy | | `name` | string | No | — | Name of the break policy | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The break policy ID." }, "allEmployeesAssigned": { "type": "boolean", "description": "Whether all employees are assigned to this break policy" }, "description": { "type": [ "string", "null" ], "description": "Optional description of the break policy" }, "name": { "type": "string", "description": "Name of the break policy" } }, "required": [ "PCID", "id" ] } ``` *** ## bamboohr\_time\_update\_time\_off\_request\_status Update Time Off Request Status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `requestId` | integer | Yes | — | The ID of the time off request to update. | | `note` | string | No | — | A note to attach to the change in status. | | `status` | string | No | — | The new status for the time off request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "requestId": { "type": "integer", "description": "The ID of the time off request to update." }, "note": { "type": "string", "description": "A note to attach to the change in status." }, "status": { "type": "string", "description": "The new status for the time off request.", "enum": [ "approved", "denied", "declined", "canceled", "cancelled" ] } }, "required": [ "PCID", "requestId" ] } ``` *** ## bamboohr\_time\_update\_time\_tracking\_record Update Hour Record **Parameters:** | Parameter | Type | Required | Default | Description | | | - | - | - | - | - | - | | `holidayId` | integer | null | No | — | ID of the holiday associated with this time tracking record | | `hoursWorked` | number | No | — | The updated number of hours worked. e.g. if Employee A worked 8.0 hours originally and decided they only worked 6.0, please send 6.0 here not -2.0. | | | `projectId` | integer | null | No | — | ID of the project associated with this time tracking record | | `shiftDifferentialId` | integer | null | No | — | ID of the shift differential associated with this time tracking record | | `taskId` | integer | null | No | — | ID of the task associated with this time tracking record | | `timeTrackingId` | string | No | — | The time tracking id is the id that was used to track the record up to 36 characters in length. (i.e. UUID). | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "holidayId": { "type": [ "integer", "null" ], "description": "ID of the holiday associated with this time tracking record" }, "hoursWorked": { "type": "number", "description": "The updated number of hours worked. e.g. if Employee A worked 8.0 hours originally and decided they only worked 6.0, please send 6.0 here not -2.0." }, "projectId": { "type": [ "integer", "null" ], "description": "ID of the project associated with this time tracking record" }, "shiftDifferentialId": { "type": [ "integer", "null" ], "description": "ID of the shift differential associated with this time tracking record" }, "taskId": { "type": [ "integer", "null" ], "description": "ID of the task associated with this time tracking record" }, "timeTrackingId": { "type": "string", "description": "The time tracking id is the id that was used to track the record up to 36 characters in length. (i.e. UUID)." } }, "required": [ "PCID" ] } ``` # bannerbear Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bannerbear Bannerbear Media Generation **Server path:** `/bannerbear` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bannerbear_create_animated_gif`](#bannerbear_create_animated_gif) | Create an animated GIF | | [`bannerbear_create_collection`](#bannerbear_create_collection) | Create a collection | | [`bannerbear_create_image`](#bannerbear_create_image) | Create an image | | [`bannerbear_create_movie`](#bannerbear_create_movie) | Create a movie | | [`bannerbear_create_screenshot`](#bannerbear_create_screenshot) | Capture a screenshot | | [`bannerbear_create_session`](#bannerbear_create_session) | Create a session | | [`bannerbear_create_template`](#bannerbear_create_template) | Create a template | | [`bannerbear_create_template_set`](#bannerbear_create_template_set) | Create a template set | | [`bannerbear_create_video`](#bannerbear_create_video) | Create a video | | [`bannerbear_create_video_template`](#bannerbear_create_video_template) | Create a video template | | [`bannerbear_create_webhook`](#bannerbear_create_webhook) | Create a webhook | | [`bannerbear_delete_template`](#bannerbear_delete_template) | Delete a template | | [`bannerbear_delete_webhook`](#bannerbear_delete_webhook) | Delete a webhook | | [`bannerbear_get_account`](#bannerbear_get_account) | Get account information | | [`bannerbear_get_animated_gif`](#bannerbear_get_animated_gif) | Get an animated GIF | | [`bannerbear_get_collection`](#bannerbear_get_collection) | Get a collection | | [`bannerbear_get_image`](#bannerbear_get_image) | Get an image | | [`bannerbear_get_movie`](#bannerbear_get_movie) | Get a movie | | [`bannerbear_get_screenshot`](#bannerbear_get_screenshot) | Get a screenshot | | [`bannerbear_get_session`](#bannerbear_get_session) | Get a session | | [`bannerbear_get_template`](#bannerbear_get_template) | Get a template | | [`bannerbear_get_template_set`](#bannerbear_get_template_set) | Get a template set | | [`bannerbear_get_video`](#bannerbear_get_video) | Get a video | | [`bannerbear_get_video_template`](#bannerbear_get_video_template) | Get a video template | | [`bannerbear_get_webhook`](#bannerbear_get_webhook) | Get a webhook | | [`bannerbear_list_animated_gifs`](#bannerbear_list_animated_gifs) | List animated GIFs | | [`bannerbear_list_collections`](#bannerbear_list_collections) | List collections | | [`bannerbear_list_effects`](#bannerbear_list_effects) | List available effects | | [`bannerbear_list_fonts`](#bannerbear_list_fonts) | List available fonts | | [`bannerbear_list_images`](#bannerbear_list_images) | List images | | [`bannerbear_list_movies`](#bannerbear_list_movies) | List movies | | [`bannerbear_list_screenshots`](#bannerbear_list_screenshots) | List screenshots | | [`bannerbear_list_sessions`](#bannerbear_list_sessions) | List sessions | | [`bannerbear_list_template_sets`](#bannerbear_list_template_sets) | List template sets | | [`bannerbear_list_templates`](#bannerbear_list_templates) | List templates | | [`bannerbear_list_video_templates`](#bannerbear_list_video_templates) | List video templates | | [`bannerbear_list_videos`](#bannerbear_list_videos) | List videos | | [`bannerbear_list_webhooks`](#bannerbear_list_webhooks) | List webhooks | | [`bannerbear_update_template`](#bannerbear_update_template) | Update a template | | [`bannerbear_update_template_set`](#bannerbear_update_template_set) | Update a template set | | [`bannerbear_update_video`](#bannerbear_update_video) | Update a video | *** ## bannerbear\_create\_animated\_gif Create an animated GIF **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fps` | integer | No | — | Frames per second (default 1) | | `frame_durations` | number\[] | No | — | Per-frame durations in seconds (overrides fps) | | `frames` | any\[]\[] | Yes | — | Array of modification arrays, one per frame (max 30) | | `input_media_url` | string | No | — | Movie file URL for video\_frame container layers | | `loop` | boolean | No | — | Whether the GIF loops (default true) | | `metadata` | string | No | — | Custom metadata | | `template` | string | Yes | — | Template UID | | `webhook_url` | string | No | — | Completion callback URL | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fps": { "type": "integer", "description": "Frames per second (default 1)" }, "frame_durations": { "type": "array", "items": { "type": "number" }, "description": "Per-frame durations in seconds (overrides fps)" }, "frames": { "type": "array", "items": { "type": "array" }, "description": "Array of modification arrays, one per frame (max 30)" }, "input_media_url": { "type": "string", "description": "Movie file URL for video_frame container layers" }, "loop": { "type": "boolean", "description": "Whether the GIF loops (default true)" }, "metadata": { "type": "string", "description": "Custom metadata" }, "template": { "type": "string", "description": "Template UID" }, "webhook_url": { "type": "string", "description": "Completion callback URL" } }, "required": [ "PCID", "frames", "template" ] } ``` *** ## bannerbear\_create\_collection Create a collection **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `metadata` | string | No | — | Custom metadata | | `modifications` | object\[] | Yes | — | Array of layer modifications applied to all templates | | `template_set` | string | Yes | — | Template Set UID | | `transparent` | boolean | No | — | Render with transparent background | | `webhook_url` | string | No | — | Completion callback URL | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "metadata": { "type": "string", "description": "Custom metadata" }, "modifications": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Layer name from the template" }, "text": { "type": "string", "description": "Text content for text layers" }, "color": { "type": "string", "description": "Text color (hex)" }, "background": { "type": "string", "description": "Background color (hex)" }, "image_url": { "type": "string", "description": "Image URL for image layers" }, "chart_data": { "type": "string", "description": "Comma-delimited data for chart layers" }, "rating": { "type": "integer", "description": "Rating value 0-100 for star rating layers" }, "target": { "type": "string", "description": "URL for QR code layers or PDF link" }, "bar_code_data": { "type": "string", "description": "Data for barcode layers" }, "font_family": { "type": "string", "description": "Font family override" }, "text_align_h": { "type": "string", "enum": [ "left", "center", "right" ], "description": "Horizontal text alignment" }, "text_align_v": { "type": "string", "enum": [ "top", "center", "bottom" ], "description": "Vertical text alignment" }, "effect": { "type": "string", "description": "Image effect name" }, "hide": { "type": "boolean", "description": "Hide this layer" } }, "required": [ "name" ] }, "description": "Array of layer modifications applied to all templates" }, "template_set": { "type": "string", "description": "Template Set UID" }, "transparent": { "type": "boolean", "description": "Render with transparent background" }, "webhook_url": { "type": "string", "description": "Completion callback URL" } }, "required": [ "PCID", "modifications", "template_set" ] } ``` *** ## bannerbear\_create\_image Create an image **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `metadata` | string | No | — | Custom metadata string | | `modifications` | object\[] | Yes | — | Array of layer modifications | | `render_pdf` | boolean | No | — | Also generate a PDF version (3x quota cost) | | `template` | string | Yes | — | Template UID to generate from | | `template_version` | integer | No | — | Specific template version number | | `transparent` | boolean | No | — | Render with transparent background (PNG only) | | `webhook_url` | string | No | — | URL to receive completion callback | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "metadata": { "type": "string", "description": "Custom metadata string" }, "modifications": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Layer name from the template" }, "text": { "type": "string", "description": "Text content for text layers" }, "color": { "type": "string", "description": "Text color (hex)" }, "background": { "type": "string", "description": "Background color (hex)" }, "image_url": { "type": "string", "description": "Image URL for image layers" }, "chart_data": { "type": "string", "description": "Comma-delimited data for chart layers" }, "rating": { "type": "integer", "description": "Rating value 0-100 for star rating layers" }, "target": { "type": "string", "description": "URL for QR code layers or PDF link" }, "bar_code_data": { "type": "string", "description": "Data for barcode layers" }, "font_family": { "type": "string", "description": "Font family override" }, "text_align_h": { "type": "string", "enum": [ "left", "center", "right" ], "description": "Horizontal text alignment" }, "text_align_v": { "type": "string", "enum": [ "top", "center", "bottom" ], "description": "Vertical text alignment" }, "effect": { "type": "string", "description": "Image effect name" }, "hide": { "type": "boolean", "description": "Hide this layer" } }, "required": [ "name" ] }, "description": "Array of layer modifications" }, "render_pdf": { "type": "boolean", "description": "Also generate a PDF version (3x quota cost)" }, "template": { "type": "string", "description": "Template UID to generate from" }, "template_version": { "type": "integer", "description": "Specific template version number" }, "transparent": { "type": "boolean", "description": "Render with transparent background (PNG only)" }, "webhook_url": { "type": "string", "description": "URL to receive completion callback" } }, "required": [ "PCID", "modifications", "template" ] } ``` *** ## bannerbear\_create\_movie Create a movie **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `height` | integer | Yes | — | Output height in pixels | | `inputs` | object\[] | Yes | — | Array of input clips (max 10) | | `metadata` | string | No | — | Custom metadata | | `soundtrack_url` | string | No | — | Audio overlay URL for the entire movie | | `transition` | string | No | — | Transition effect between clips | | `webhook_url` | string | No | — | Completion callback URL | | `width` | integer | Yes | — | Output width in pixels | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "height": { "type": "integer", "description": "Output height in pixels" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "asset_url": { "type": "string", "description": "URL of video or image asset" }, "trim_to_length_in_seconds": { "type": "integer", "description": "Trim clip to this duration in seconds" }, "mute": { "type": "boolean", "description": "Mute this clip's audio" }, "soundtrack_url": { "type": "string", "description": "Per-clip audio overlay URL" } }, "required": [ "asset_url" ] }, "description": "Array of input clips (max 10)" }, "metadata": { "type": "string", "description": "Custom metadata" }, "soundtrack_url": { "type": "string", "description": "Audio overlay URL for the entire movie" }, "transition": { "type": "string", "description": "Transition effect between clips", "enum": [ "fade", "pixelize", "slidedown", "slideright", "slideup", "slideleft" ] }, "webhook_url": { "type": "string", "description": "Completion callback URL" }, "width": { "type": "integer", "description": "Output width in pixels" } }, "required": [ "PCID", "height", "inputs", "width" ] } ``` *** ## bannerbear\_create\_screenshot Capture a screenshot **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `height` | integer | No | — | Browser viewport height (default: full page) | | `language` | string | No | — | Two-letter ISO 639-1 language code | | `metadata` | string | No | — | Custom metadata | | `mobile` | boolean | No | — | Use mobile user agent | | `url` | string | Yes | — | Website URL to capture | | `webhook_url` | string | No | — | Completion callback URL | | `width` | integer | No | — | Browser viewport width (default 1200) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "height": { "type": "integer", "description": "Browser viewport height (default: full page)" }, "language": { "type": "string", "description": "Two-letter ISO 639-1 language code" }, "metadata": { "type": "string", "description": "Custom metadata" }, "mobile": { "type": "boolean", "description": "Use mobile user agent" }, "url": { "type": "string", "description": "Website URL to capture" }, "webhook_url": { "type": "string", "description": "Completion callback URL" }, "width": { "type": "integer", "description": "Browser viewport width (default 1200)" } }, "required": [ "PCID", "url" ] } ``` *** ## bannerbear\_create\_session Create a session **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `custom_fonts` | string\[] | No | — | Specific fonts to display in the editor | | `metadata` | string | No | — | Custom metadata | | `mode` | string | No | — | Session mode | | `template` | string | Yes | — | Template UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom_fonts": { "type": "array", "items": { "type": "string" }, "description": "Specific fonts to display in the editor" }, "metadata": { "type": "string", "description": "Custom metadata" }, "mode": { "type": "string", "description": "Session mode", "enum": [ "default", "limited", "preview" ] }, "template": { "type": "string", "description": "Template UID" } }, "required": [ "PCID", "template" ] } ``` *** ## bannerbear\_create\_template Create a template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `height` | integer | Yes | — | Template height in pixels | | `metadata` | string | No | — | Custom metadata string | | `name` | string | Yes | — | Template name | | `tags` | string\[] | No | — | Template tags | | `width` | integer | Yes | — | Template width in pixels | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "height": { "type": "integer", "description": "Template height in pixels" }, "metadata": { "type": "string", "description": "Custom metadata string" }, "name": { "type": "string", "description": "Template name" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Template tags" }, "width": { "type": "integer", "description": "Template width in pixels" } }, "required": [ "PCID", "height", "name", "width" ] } ``` *** ## bannerbear\_create\_template\_set Create a template set **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | No | — | Template set name | | `templates` | string\[] | Yes | — | Array of template UIDs to include | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Template set name" }, "templates": { "type": "array", "items": { "type": "string" }, "description": "Array of template UIDs to include" } }, "required": [ "PCID", "templates" ] } ``` *** ## bannerbear\_create\_video Create a video **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `create_gif_preview` | boolean | No | — | Generate GIF preview alongside MP4 | | `frame_durations` | number\[] | No | — | Duration in seconds for each frame | | `frames` | any\[]\[] | No | — | Array of modification arrays for multi\_overlay render type | | `input_media_url` | string | No | — | Video or audio URL (required for overlay/transcribe build packs) | | `metadata` | string | No | — | Custom metadata | | `modifications` | object\[] | No | — | Layer modifications | | `video_template` | string | Yes | — | Video template UID | | `webhook_url` | string | No | — | Completion callback URL | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "create_gif_preview": { "type": "boolean", "description": "Generate GIF preview alongside MP4" }, "frame_durations": { "type": "array", "items": { "type": "number" }, "description": "Duration in seconds for each frame" }, "frames": { "type": "array", "items": { "type": "array" }, "description": "Array of modification arrays for multi_overlay render type" }, "input_media_url": { "type": "string", "description": "Video or audio URL (required for overlay/transcribe build packs)" }, "metadata": { "type": "string", "description": "Custom metadata" }, "modifications": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Layer name from the template" }, "text": { "type": "string", "description": "Text content for text layers" }, "color": { "type": "string", "description": "Text color (hex)" }, "background": { "type": "string", "description": "Background color (hex)" }, "image_url": { "type": "string", "description": "Image URL for image layers" }, "chart_data": { "type": "string", "description": "Comma-delimited data for chart layers" }, "rating": { "type": "integer", "description": "Rating value 0-100 for star rating layers" }, "target": { "type": "string", "description": "URL for QR code layers or PDF link" }, "bar_code_data": { "type": "string", "description": "Data for barcode layers" }, "font_family": { "type": "string", "description": "Font family override" }, "text_align_h": { "type": "string", "enum": [ "left", "center", "right" ], "description": "Horizontal text alignment" }, "text_align_v": { "type": "string", "enum": [ "top", "center", "bottom" ], "description": "Vertical text alignment" }, "effect": { "type": "string", "description": "Image effect name" }, "hide": { "type": "boolean", "description": "Hide this layer" } }, "required": [ "name" ] }, "description": "Layer modifications" }, "video_template": { "type": "string", "description": "Video template UID" }, "webhook_url": { "type": "string", "description": "Completion callback URL" } }, "required": [ "PCID", "video_template" ] } ``` *** ## bannerbear\_create\_video\_template Create a video template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `approval_required` | boolean | No | — | Require approval before final render (transcribe only) | | `render_type` | string | Yes | — | Video render type | | `template` | string | Yes | — | Parent image template UID | | `transcription_layer_name` | string | No | — | Name of the text layer for transcription (transcribe only) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "approval_required": { "type": "boolean", "description": "Require approval before final render (transcribe only)" }, "render_type": { "type": "string", "description": "Video render type", "enum": [ "overlay", "transcribe", "multi_overlay" ] }, "template": { "type": "string", "description": "Parent image template UID" }, "transcription_layer_name": { "type": "string", "description": "Name of the text layer for transcription (transcribe only)" } }, "required": [ "PCID", "render_type", "template" ] } ``` *** ## bannerbear\_create\_webhook Create a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `event` | string | Yes | — | Event type to listen for | | `url` | string | Yes | — | Webhook receiver URL | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "event": { "type": "string", "description": "Event type to listen for", "enum": [ "template_created", "template_edited", "image_created", "collection_created", "video_created", "animated_gif_created", "movie_created", "screenshot_created" ] }, "url": { "type": "string", "description": "Webhook receiver URL" } }, "required": [ "PCID", "event", "url" ] } ``` *** ## bannerbear\_delete\_template Delete a template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Template UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Template UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_delete\_webhook Delete a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Webhook UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Webhook UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_account Get account information ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_get\_animated\_gif Get an animated GIF **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Animated GIF UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Animated GIF UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_collection Get a collection **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Collection UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Collection UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_image Get an image **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Image UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Image UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_movie Get a movie **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Movie UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Movie UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_screenshot Get a screenshot **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Screenshot UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Screenshot UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_session Get a session **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Session UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Session UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_template Get a template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Template UID | | `extended` | boolean | No | — | Include extended template details | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Template UID" }, "extended": { "type": "boolean", "description": "Include extended template details" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_template\_set Get a template set **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Template Set UID | | `extended` | boolean | No | — | Include extended details | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Template Set UID" }, "extended": { "type": "boolean", "description": "Include extended details" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_video Get a video **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Video UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Video UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_video\_template Get a video template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Video Template UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Video Template UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_get\_webhook Get a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Webhook UID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Webhook UID" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_list\_animated\_gifs List animated GIFs **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_collections List collections **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_effects List available effects ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_fonts List available fonts ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_images List images **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number | | `limit` | integer | No | — | Results per page (max 100) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number" }, "limit": { "type": "integer", "description": "Results per page (max 100)" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_movies List movies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_screenshots List screenshots **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_sessions List sessions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_template\_sets List template sets **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number | | `extended` | boolean | No | — | Include extended details | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number" }, "extended": { "type": "boolean", "description": "Include extended details" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_templates List templates **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number for pagination | | `limit` | integer | No | — | Number of results per page (max 100) | | `tag` | string | No | — | Filter templates by tag | | `name` | string | No | — | Filter templates by name (partial match) | | `extended` | boolean | No | — | Include extended template details | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number for pagination" }, "limit": { "type": "integer", "description": "Number of results per page (max 100)" }, "tag": { "type": "string", "description": "Filter templates by tag" }, "name": { "type": "string", "description": "Filter templates by name (partial match)" }, "extended": { "type": "boolean", "description": "Include extended template details" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_video\_templates List video templates **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_videos List videos **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_list\_webhooks List webhooks ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bannerbear\_update\_template Update a template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Template UID | | `height` | integer | No | — | Template height | | `metadata` | string | No | — | Custom metadata | | `name` | string | No | — | Template name | | `tags` | string\[] | No | — | Template tags | | `width` | integer | No | — | Template width | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Template UID" }, "height": { "type": "integer", "description": "Template height" }, "metadata": { "type": "string", "description": "Custom metadata" }, "name": { "type": "string", "description": "Template name" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Template tags" }, "width": { "type": "integer", "description": "Template width" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_update\_template\_set Update a template set **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Template Set UID | | `name` | string | No | — | Updated name | | `templates` | string\[] | No | — | Replacement array of template UIDs | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Template Set UID" }, "name": { "type": "string", "description": "Updated name" }, "templates": { "type": "array", "items": { "type": "string" }, "description": "Replacement array of template UIDs" } }, "required": [ "PCID", "uid" ] } ``` *** ## bannerbear\_update\_video Update a video **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uid` | string | Yes | — | Video UID | | `approved` | boolean | No | — | Approve the video for final rendering | | `transcription` | object\[] | No | — | Corrected transcription lines | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uid": { "type": "string", "description": "Video UID" }, "approved": { "type": "boolean", "description": "Approve the video for final rendering" }, "transcription": { "type": "array", "items": { "type": "object" }, "description": "Corrected transcription lines" } }, "required": [ "PCID", "uid" ] } ``` # bart Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bart BART Transit **Server path:** `/bart` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bart_get_fare`](#bart_get_fare) | Get fare between two BART stations | | [`bart_get_realtime_departures`](#bart_get_realtime_departures) | Get real-time estimated departures for a station | | [`bart_get_route_info`](#bart_get_route_info) | Get detailed information for a route | | [`bart_get_service_advisories`](#bart_get_service_advisories) | Get current BART service advisories | | [`bart_get_station_info`](#bart_get_station_info) | Get detailed information for a station | | [`bart_list_routes`](#bart_list_routes) | List all BART routes | | [`bart_list_stations`](#bart_list_stations) | List all BART stations | | [`bart_plan_trip`](#bart_plan_trip) | Plan a trip between two BART stations | *** ## bart\_get\_fare Get fare between two BART stations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `orig` | string | Yes | — | Origin station abbreviation code (e.g. EMBR). Use list\_stations to get valid codes. | | `dest` | string | Yes | — | Destination station abbreviation code (e.g. DALY). Use list\_stations to get valid codes. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "orig": { "type": "string", "description": "Origin station abbreviation code (e.g. EMBR). Use list_stations to get valid codes." }, "dest": { "type": "string", "description": "Destination station abbreviation code (e.g. DALY). Use list_stations to get valid codes." } }, "required": [ "PCID", "orig", "dest" ] } ``` *** ## bart\_get\_realtime\_departures Get real-time estimated departures for a station **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `orig` | string | Yes | — | Station abbreviation code (e.g. EMBR for Embarcadero, MONT for Montgomery, 12TH for 12th St Oakland). Use list\_stations to get valid abbreviation codes. | | `dir` | string | No | — | Filter by direction: n (northbound) or s (southbound) | | `plat` | integer | No | — | Filter by platform number (1-4) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "orig": { "type": "string", "description": "Station abbreviation code (e.g. EMBR for Embarcadero, MONT for Montgomery, 12TH for 12th St Oakland). Use list_stations to get valid abbreviation codes." }, "dir": { "type": "string", "description": "Filter by direction: n (northbound) or s (southbound)", "enum": [ "n", "s" ] }, "plat": { "type": "integer", "description": "Filter by platform number (1-4)" } }, "required": [ "PCID", "orig" ] } ``` *** ## bart\_get\_route\_info Get detailed information for a route **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `route` | integer | Yes | — | Route number (e.g. 1, 2, 3). Use list\_routes to get valid route numbers. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "route": { "type": "integer", "description": "Route number (e.g. 1, 2, 3). Use list_routes to get valid route numbers." } }, "required": [ "PCID", "route" ] } ``` *** ## bart\_get\_service\_advisories Get current BART service advisories ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bart\_get\_station\_info Get detailed information for a station **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `orig` | string | Yes | — | Station abbreviation code (e.g. EMBR for Embarcadero). Use list\_stations to get valid abbreviation codes. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "orig": { "type": "string", "description": "Station abbreviation code (e.g. EMBR for Embarcadero). Use list_stations to get valid abbreviation codes." } }, "required": [ "PCID", "orig" ] } ``` *** ## bart\_list\_routes List all BART routes ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bart\_list\_stations List all BART stations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bart\_plan\_trip Plan a trip between two BART stations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cmd` | string | Yes | — | Command type: "depart" to find next departing trains, "arrive" to find trains arriving by a specific time | | `orig` | string | Yes | — | Origin station abbreviation code (e.g. EMBR). Use list\_stations to get valid codes. | | `dest` | string | Yes | — | Destination station abbreviation code (e.g. DALY). Use list\_stations to get valid codes. | | `date` | string | No | — | Date for the trip (MM/DD/YYYY format, or "now" for today). Defaults to today. | | `time` | string | No | — | Time for the trip (h:mm+am/pm format, e.g. "5:30pm", or "now" for current time). Defaults to current time. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cmd": { "type": "string", "description": "Command type: \"depart\" to find next departing trains, \"arrive\" to find trains arriving by a specific time", "enum": [ "depart", "arrive" ] }, "orig": { "type": "string", "description": "Origin station abbreviation code (e.g. EMBR). Use list_stations to get valid codes." }, "dest": { "type": "string", "description": "Destination station abbreviation code (e.g. DALY). Use list_stations to get valid codes." }, "date": { "type": "string", "description": "Date for the trip (MM/DD/YYYY format, or \"now\" for today). Defaults to today." }, "time": { "type": "string", "description": "Time for the trip (h:mm+am/pm format, e.g. \"5:30pm\", or \"now\" for current time). Defaults to current time." } }, "required": [ "PCID", "cmd", "orig", "dest" ] } ``` # base Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/base Base - e-commerce management for orders, products, shipping, and CRM **PinkConnect service:** `base` | **Type:** Application (parent with child servers) | **PCID required:** Yes base is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [base-orders](/api-reference/mcp-servers/application/base/base-orders) | `/base-orders` | 28 | Base Orders - manage orders, returns, invoices, and payments | | [base-products](/api-reference/mcp-servers/application/base/base-products) | `/base-products` | 29 | Base Products - manage product catalog, inventory, warehouses, and pricing | | [base-shipping](/api-reference/mcp-servers/application/base/base-shipping) | `/base-shipping` | 15 | Base Shipping & CRM - manage courier shipments, labels, and customer records | # base-orders Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/base/base-orders Base Orders - manage orders, returns, invoices, and payments **Server path:** `/base-orders` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`base_orders_add_invoice`](#base_orders_add_invoice) | Issue an invoice for an order. | | [`base_orders_add_order`](#base_orders_add_order) | Create a new order in Base. | | [`base_orders_add_order_product`](#base_orders_add_order_product) | Add a product to an existing order. | | [`base_orders_add_order_return`](#base_orders_add_order_return) | Create a new order return. | | [`base_orders_delete_order_product`](#base_orders_delete_order_product) | Remove a product from an order. | | [`base_orders_delete_orders`](#base_orders_delete_orders) | Delete multiple orders by their IDs. | | [`base_orders_get_invoice_file`](#base_orders_get_invoice_file) | Download an invoice PDF file (returned as base64-encoded content). | | [`base_orders_get_invoices`](#base_orders_get_invoices) | Retrieve invoices. Returns up to 100 per call. | | [`base_orders_get_journal_list`](#base_orders_get_journal_list) | Retrieve order event journal. Returns a log of order-related events. | | [`base_orders_get_order_extra_fields`](#base_orders_get_order_extra_fields) | Retrieve custom extra field definitions for orders. | | [`base_orders_get_order_payments_history`](#base_orders_get_order_payments_history) | Retrieve payment history for an order. | | [`base_orders_get_order_return_reasons_list`](#base_orders_get_order_return_reasons_list) | Retrieve the list of order return reasons. | | [`base_orders_get_order_return_status_list`](#base_orders_get_order_return_status_list) | Retrieve the list of order return statuses. | | [`base_orders_get_order_returns`](#base_orders_get_order_returns) | Retrieve order returns. Returns up to 100 per call. | | [`base_orders_get_order_sources`](#base_orders_get_order_sources) | Retrieve the list of order sources (e.g., shop, marketplace). | | [`base_orders_get_order_status_list`](#base_orders_get_order_status_list) | Retrieve the list of order statuses. | | [`base_orders_get_order_transaction_data`](#base_orders_get_order_transaction_data) | Retrieve transaction details for an order. | | [`base_orders_get_orders`](#base_orders_get_orders) | Retrieve orders from Base. Returns up to 100 orders per call. | | [`base_orders_get_orders_by_email`](#base_orders_get_orders_by_email) | Search for orders by customer email address. | | [`base_orders_get_orders_by_phone`](#base_orders_get_orders_by_phone) | Search for orders by customer phone number. | | [`base_orders_get_series`](#base_orders_get_series) | Retrieve invoice/receipt numbering series. | | [`base_orders_set_order_fields`](#base_orders_set_order_fields) | Update fields of an existing order. | | [`base_orders_set_order_payment`](#base_orders_set_order_payment) | Record a payment for an order. | | [`base_orders_set_order_product_fields`](#base_orders_set_order_product_fields) | Update fields of a product within an order. | | [`base_orders_set_order_return_fields`](#base_orders_set_order_return_fields) | Update fields of an order return. | | [`base_orders_set_order_return_status`](#base_orders_set_order_return_status) | Change the status of an order return. | | [`base_orders_set_order_status`](#base_orders_set_order_status) | Change the status of a single order. | | [`base_orders_set_order_statuses`](#base_orders_set_order_statuses) | Change the status of multiple orders at once. | *** ## base\_orders\_add\_invoice Issue an invoice for an order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | | `series_id` | number | Yes | — | Invoice series identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." }, "series_id": { "type": "number", "description": "Invoice series identifier." } }, "required": [ "PCID", "order_id", "series_id" ] } ``` *** ## base\_orders\_add\_order Create a new order in Base. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_status_id` | string | Yes | — | Order status identifier. | | `date_add` | number | No | — | Unix timestamp for order creation date. | | `currency` | string | No | — | ISO 4217 currency code (e.g., USD, EUR). | | `email` | string | Yes | — | Customer email address. | | `phone` | string | No | — | Customer phone number. | | `user_login` | string | No | — | Customer username. | | `user_comments` | string | No | — | Customer notes. | | `admin_comments` | string | No | — | Seller internal notes. | | `payment_method` | string | No | — | Payment method name. | | `payment_method_cod` | boolean | No | — | Cash on delivery flag. | | `paid` | boolean | No | — | Whether order is paid. | | `delivery_method` | string | No | — | Delivery method name. | | `delivery_price` | number | No | — | Shipping cost. | | `delivery_fullname` | string | No | — | Recipient full name. | | `delivery_company` | string | No | — | Recipient company. | | `delivery_address` | string | No | — | Delivery street address. | | `delivery_city` | string | No | — | Delivery city. | | `delivery_state` | string | No | — | Delivery state/province. | | `delivery_postcode` | string | No | — | Delivery postal code. | | `delivery_country_code` | string | No | — | ISO country code for delivery. | | `invoice_fullname` | string | No | — | Invoice recipient name. | | `invoice_company` | string | No | — | Invoice company name. | | `invoice_nip` | string | No | — | Tax identification number. | | `invoice_address` | string | No | — | Invoice address. | | `invoice_city` | string | No | — | Invoice city. | | `invoice_postcode` | string | No | — | Invoice postal code. | | `invoice_country_code` | string | No | — | Invoice country code. | | `want_invoice` | boolean | No | — | Whether to issue an invoice. | | `extra_field_1` | string | No | — | Custom extra field 1. | | `extra_field_2` | string | No | — | Custom extra field 2. | | `products` | object\[] | Yes | — | Array of product objects. Each should have: storage, storage\_id, product\_id, variant\_id, name, sku, ean, price\_brutto, tax\_rate, quantity, weight. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_status_id": { "type": "string", "description": "Order status identifier." }, "date_add": { "type": "number", "description": "Unix timestamp for order creation date." }, "currency": { "type": "string", "description": "ISO 4217 currency code (e.g., USD, EUR)." }, "email": { "type": "string", "description": "Customer email address." }, "phone": { "type": "string", "description": "Customer phone number." }, "user_login": { "type": "string", "description": "Customer username." }, "user_comments": { "type": "string", "description": "Customer notes." }, "admin_comments": { "type": "string", "description": "Seller internal notes." }, "payment_method": { "type": "string", "description": "Payment method name." }, "payment_method_cod": { "type": "boolean", "description": "Cash on delivery flag." }, "paid": { "type": "boolean", "description": "Whether order is paid." }, "delivery_method": { "type": "string", "description": "Delivery method name." }, "delivery_price": { "type": "number", "description": "Shipping cost." }, "delivery_fullname": { "type": "string", "description": "Recipient full name." }, "delivery_company": { "type": "string", "description": "Recipient company." }, "delivery_address": { "type": "string", "description": "Delivery street address." }, "delivery_city": { "type": "string", "description": "Delivery city." }, "delivery_state": { "type": "string", "description": "Delivery state/province." }, "delivery_postcode": { "type": "string", "description": "Delivery postal code." }, "delivery_country_code": { "type": "string", "description": "ISO country code for delivery." }, "invoice_fullname": { "type": "string", "description": "Invoice recipient name." }, "invoice_company": { "type": "string", "description": "Invoice company name." }, "invoice_nip": { "type": "string", "description": "Tax identification number." }, "invoice_address": { "type": "string", "description": "Invoice address." }, "invoice_city": { "type": "string", "description": "Invoice city." }, "invoice_postcode": { "type": "string", "description": "Invoice postal code." }, "invoice_country_code": { "type": "string", "description": "Invoice country code." }, "want_invoice": { "type": "boolean", "description": "Whether to issue an invoice." }, "extra_field_1": { "type": "string", "description": "Custom extra field 1." }, "extra_field_2": { "type": "string", "description": "Custom extra field 2." }, "products": { "type": "array", "items": { "type": "object" }, "description": "Array of product objects. Each should have: storage, storage_id, product_id, variant_id, name, sku, ean, price_brutto, tax_rate, quantity, weight." } }, "required": [ "PCID", "order_status_id", "email", "products" ] } ``` *** ## base\_orders\_add\_order\_product Add a product to an existing order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | | `storage` | string | Yes | — | Storage type (e.g., 'db' for catalog). | | `storage_id` | number | No | — | Storage identifier. | | `product_id` | string | Yes | — | Product identifier. | | `variant_id` | number | No | — | Product variant ID. | | `name` | string | Yes | — | Product display name. | | `sku` | string | No | — | Stock keeping unit. | | `ean` | string | No | — | European article number. | | `attributes` | string | No | — | Product attributes string. | | `price_brutto` | number | Yes | — | Gross price. | | `tax_rate` | number | No | — | Tax rate percentage. | | `quantity` | number | Yes | — | Quantity. | | `weight` | number | No | — | Product weight. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." }, "storage": { "type": "string", "description": "Storage type (e.g., 'db' for catalog)." }, "storage_id": { "type": "number", "description": "Storage identifier." }, "product_id": { "type": "string", "description": "Product identifier." }, "variant_id": { "type": "number", "description": "Product variant ID." }, "name": { "type": "string", "description": "Product display name." }, "sku": { "type": "string", "description": "Stock keeping unit." }, "ean": { "type": "string", "description": "European article number." }, "attributes": { "type": "string", "description": "Product attributes string." }, "price_brutto": { "type": "number", "description": "Gross price." }, "tax_rate": { "type": "number", "description": "Tax rate percentage." }, "quantity": { "type": "number", "description": "Quantity." }, "weight": { "type": "number", "description": "Product weight." } }, "required": [ "PCID", "order_id", "storage", "product_id", "name", "price_brutto", "quantity" ] } ``` *** ## base\_orders\_add\_order\_return Create a new order return. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Original order identifier. | | `status_id` | number | Yes | — | Return status identifier. | | `reference_number` | string | No | — | Return reference number. | | `date_add` | number | No | — | Unix timestamp for return date. | | `currency` | string | No | — | ISO currency code. | | `admin_comments` | string | No | — | Internal notes. | | `email` | string | No | — | Customer email. | | `phone` | string | No | — | Customer phone. | | `delivery_fullname` | string | No | — | Recipient name. | | `delivery_address` | string | No | — | Return address. | | `delivery_city` | string | No | — | City. | | `delivery_postcode` | string | No | — | Postal code. | | `delivery_country_code` | string | No | — | Country code. | | `products` | object\[] | Yes | — | Array of returned product objects. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Original order identifier." }, "status_id": { "type": "number", "description": "Return status identifier." }, "reference_number": { "type": "string", "description": "Return reference number." }, "date_add": { "type": "number", "description": "Unix timestamp for return date." }, "currency": { "type": "string", "description": "ISO currency code." }, "admin_comments": { "type": "string", "description": "Internal notes." }, "email": { "type": "string", "description": "Customer email." }, "phone": { "type": "string", "description": "Customer phone." }, "delivery_fullname": { "type": "string", "description": "Recipient name." }, "delivery_address": { "type": "string", "description": "Return address." }, "delivery_city": { "type": "string", "description": "City." }, "delivery_postcode": { "type": "string", "description": "Postal code." }, "delivery_country_code": { "type": "string", "description": "Country code." }, "products": { "type": "array", "items": { "type": "object" }, "description": "Array of returned product objects." } }, "required": [ "PCID", "order_id", "status_id", "products" ] } ``` *** ## base\_orders\_delete\_order\_product Remove a product from an order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | | `order_product_id` | number | Yes | — | Order line item identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." }, "order_product_id": { "type": "number", "description": "Order line item identifier." } }, "required": [ "PCID", "order_id", "order_product_id" ] } ``` *** ## base\_orders\_delete\_orders Delete multiple orders by their IDs. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_ids` | string\[] | Yes | — | Array of order IDs to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_ids": { "type": "array", "items": { "type": "string" }, "description": "Array of order IDs to delete." } }, "required": [ "PCID", "order_ids" ] } ``` *** ## base\_orders\_get\_invoice\_file Download an invoice PDF file (returned as base64-encoded content). **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `invoice_id` | number | Yes | — | Invoice identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "invoice_id": { "type": "number", "description": "Invoice identifier." } }, "required": [ "PCID", "invoice_id" ] } ``` *** ## base\_orders\_get\_invoices Retrieve invoices. Returns up to 100 per call. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `date_from` | number | Yes | — | Unix timestamp. Retrieve invoices created after this date. | | `invoice_id` | number | No | — | Retrieve a specific invoice by ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "date_from": { "type": "number", "description": "Unix timestamp. Retrieve invoices created after this date." }, "invoice_id": { "type": "number", "description": "Retrieve a specific invoice by ID." } }, "required": [ "PCID", "date_from" ] } ``` *** ## base\_orders\_get\_journal\_list Retrieve order event journal. Returns a log of order-related events. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `last_log_id` | number | No | — | Last event ID for pagination. Returns events after this ID. | | `logs_types` | string\[] | No | — | Array of event type IDs to filter by. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "last_log_id": { "type": "number", "description": "Last event ID for pagination. Returns events after this ID." }, "logs_types": { "type": "array", "items": { "type": "string" }, "description": "Array of event type IDs to filter by." } }, "required": [ "PCID" ] } ``` *** ## base\_orders\_get\_order\_extra\_fields Retrieve custom extra field definitions for orders. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_orders\_get\_order\_payments\_history Retrieve payment history for an order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." } }, "required": [ "PCID", "order_id" ] } ``` *** ## base\_orders\_get\_order\_return\_reasons\_list Retrieve the list of order return reasons. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_orders\_get\_order\_return\_status\_list Retrieve the list of order return statuses. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_orders\_get\_order\_returns Retrieve order returns. Returns up to 100 per call. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `date_confirmed_from` | number | Yes | — | Unix timestamp. Retrieve returns confirmed after this date. | | `get_unconfirmed_orders` | boolean | No | — | Include unconfirmed returns. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "date_confirmed_from": { "type": "number", "description": "Unix timestamp. Retrieve returns confirmed after this date." }, "get_unconfirmed_orders": { "type": "boolean", "description": "Include unconfirmed returns." } }, "required": [ "PCID", "date_confirmed_from" ] } ``` *** ## base\_orders\_get\_order\_sources Retrieve the list of order sources (e.g., shop, marketplace). ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_orders\_get\_order\_status\_list Retrieve the list of order statuses. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_orders\_get\_order\_transaction\_data Retrieve transaction details for an order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." } }, "required": [ "PCID", "order_id" ] } ``` *** ## base\_orders\_get\_orders Retrieve orders from Base. Returns up to 100 orders per call. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `date_confirmed_from` | number | Yes | — | Unix timestamp. Retrieve orders confirmed after this date. | | `date_confirmed_to` | number | No | — | Unix timestamp. Retrieve orders confirmed before this date. | | `order_id` | number | No | — | Retrieve a specific order by ID. | | `get_unconfirmed_orders` | boolean | No | — | Include unconfirmed orders (default: false). | | `include_custom_extra_fields` | boolean | No | — | Include custom extra field values. | | `status_id` | number | No | — | Filter by order status ID. | | `filter_email` | string | No | — | Filter orders by customer email. | | `filter_order_source` | string | No | — | Filter by order source. | | `filter_order_source_id` | number | No | — | Filter by order source account ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "date_confirmed_from": { "type": "number", "description": "Unix timestamp. Retrieve orders confirmed after this date." }, "date_confirmed_to": { "type": "number", "description": "Unix timestamp. Retrieve orders confirmed before this date." }, "order_id": { "type": "number", "description": "Retrieve a specific order by ID." }, "get_unconfirmed_orders": { "type": "boolean", "description": "Include unconfirmed orders (default: false)." }, "include_custom_extra_fields": { "type": "boolean", "description": "Include custom extra field values." }, "status_id": { "type": "number", "description": "Filter by order status ID." }, "filter_email": { "type": "string", "description": "Filter orders by customer email." }, "filter_order_source": { "type": "string", "description": "Filter by order source." }, "filter_order_source_id": { "type": "number", "description": "Filter by order source account ID." } }, "required": [ "PCID", "date_confirmed_from" ] } ``` *** ## base\_orders\_get\_orders\_by\_email Search for orders by customer email address. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `email` | string | Yes | — | Customer email to search for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email": { "type": "string", "description": "Customer email to search for." } }, "required": [ "PCID", "email" ] } ``` *** ## base\_orders\_get\_orders\_by\_phone Search for orders by customer phone number. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `phone` | string | Yes | — | Customer phone number to search for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "phone": { "type": "string", "description": "Customer phone number to search for." } }, "required": [ "PCID", "phone" ] } ``` *** ## base\_orders\_get\_series Retrieve invoice/receipt numbering series. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_orders\_set\_order\_fields Update fields of an existing order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | | `admin_comments` | string | No | — | Seller internal notes. | | `user_comments` | string | No | — | Customer notes. | | `payment_method` | string | No | — | Payment method name. | | `payment_method_cod` | boolean | No | — | Cash on delivery flag. | | `delivery_method` | string | No | — | Delivery method name. | | `delivery_price` | number | No | — | Shipping cost. | | `delivery_fullname` | string | No | — | Recipient full name. | | `delivery_company` | string | No | — | Recipient company. | | `delivery_address` | string | No | — | Delivery street address. | | `delivery_city` | string | No | — | Delivery city. | | `delivery_postcode` | string | No | — | Delivery postal code. | | `delivery_country_code` | string | No | — | Delivery country code. | | `email` | string | No | — | Customer email. | | `phone` | string | No | — | Customer phone. | | `extra_field_1` | string | No | — | Custom extra field 1. | | `extra_field_2` | string | No | — | Custom extra field 2. | | `custom_extra_fields` | object | No | — | Custom extra fields as key-value pairs. | | `want_invoice` | boolean | No | — | Whether to issue an invoice. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." }, "admin_comments": { "type": "string", "description": "Seller internal notes." }, "user_comments": { "type": "string", "description": "Customer notes." }, "payment_method": { "type": "string", "description": "Payment method name." }, "payment_method_cod": { "type": "boolean", "description": "Cash on delivery flag." }, "delivery_method": { "type": "string", "description": "Delivery method name." }, "delivery_price": { "type": "number", "description": "Shipping cost." }, "delivery_fullname": { "type": "string", "description": "Recipient full name." }, "delivery_company": { "type": "string", "description": "Recipient company." }, "delivery_address": { "type": "string", "description": "Delivery street address." }, "delivery_city": { "type": "string", "description": "Delivery city." }, "delivery_postcode": { "type": "string", "description": "Delivery postal code." }, "delivery_country_code": { "type": "string", "description": "Delivery country code." }, "email": { "type": "string", "description": "Customer email." }, "phone": { "type": "string", "description": "Customer phone." }, "extra_field_1": { "type": "string", "description": "Custom extra field 1." }, "extra_field_2": { "type": "string", "description": "Custom extra field 2." }, "custom_extra_fields": { "type": "object", "description": "Custom extra fields as key-value pairs." }, "want_invoice": { "type": "boolean", "description": "Whether to issue an invoice." } }, "required": [ "PCID", "order_id" ] } ``` *** ## base\_orders\_set\_order\_payment Record a payment for an order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | | `payment_done` | number | Yes | — | Amount paid. | | `payment_date` | number | No | — | Unix timestamp of payment. | | `payment_comment` | string | No | — | Payment notes. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." }, "payment_done": { "type": "number", "description": "Amount paid." }, "payment_date": { "type": "number", "description": "Unix timestamp of payment." }, "payment_comment": { "type": "string", "description": "Payment notes." } }, "required": [ "PCID", "order_id", "payment_done" ] } ``` *** ## base\_orders\_set\_order\_product\_fields Update fields of a product within an order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | | `order_product_id` | number | Yes | — | Order line item identifier. | | `name` | string | No | — | Product name. | | `sku` | string | No | — | Stock keeping unit. | | `ean` | string | No | — | European article number. | | `attributes` | string | No | — | Product attributes. | | `price_brutto` | number | No | — | Gross price. | | `tax_rate` | number | No | — | Tax rate. | | `quantity` | number | No | — | Quantity. | | `weight` | number | No | — | Weight. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." }, "order_product_id": { "type": "number", "description": "Order line item identifier." }, "name": { "type": "string", "description": "Product name." }, "sku": { "type": "string", "description": "Stock keeping unit." }, "ean": { "type": "string", "description": "European article number." }, "attributes": { "type": "string", "description": "Product attributes." }, "price_brutto": { "type": "number", "description": "Gross price." }, "tax_rate": { "type": "number", "description": "Tax rate." }, "quantity": { "type": "number", "description": "Quantity." }, "weight": { "type": "number", "description": "Weight." } }, "required": [ "PCID", "order_id", "order_product_id" ] } ``` *** ## base\_orders\_set\_order\_return\_fields Update fields of an order return. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `return_id` | number | Yes | — | Return identifier. | | `admin_comments` | string | No | — | Internal notes. | | `extra_field_1` | string | No | — | Custom extra field 1. | | `extra_field_2` | string | No | — | Custom extra field 2. | | `custom_extra_fields` | object | No | — | Custom extra fields as key-value pairs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "return_id": { "type": "number", "description": "Return identifier." }, "admin_comments": { "type": "string", "description": "Internal notes." }, "extra_field_1": { "type": "string", "description": "Custom extra field 1." }, "extra_field_2": { "type": "string", "description": "Custom extra field 2." }, "custom_extra_fields": { "type": "object", "description": "Custom extra fields as key-value pairs." } }, "required": [ "PCID", "return_id" ] } ``` *** ## base\_orders\_set\_order\_return\_status Change the status of an order return. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `return_id` | number | Yes | — | Return identifier. | | `status_id` | number | Yes | — | New status identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "return_id": { "type": "number", "description": "Return identifier." }, "status_id": { "type": "number", "description": "New status identifier." } }, "required": [ "PCID", "return_id", "status_id" ] } ``` *** ## base\_orders\_set\_order\_status Change the status of a single order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | | `status_id` | number | Yes | — | New status identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." }, "status_id": { "type": "number", "description": "New status identifier." } }, "required": [ "PCID", "order_id", "status_id" ] } ``` *** ## base\_orders\_set\_order\_statuses Change the status of multiple orders at once. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_ids` | string\[] | Yes | — | Array of order IDs. | | `status_id` | number | Yes | — | Status to apply to all orders. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_ids": { "type": "array", "items": { "type": "string" }, "description": "Array of order IDs." }, "status_id": { "type": "number", "description": "Status to apply to all orders." } }, "required": [ "PCID", "order_ids", "status_id" ] } ``` # base-products Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/base/base-products Base Products - manage product catalog, inventory, warehouses, and pricing **Server path:** `/base-products` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`base_products_add_inventory`](#base_products_add_inventory) | Create a new product catalog. | | [`base_products_add_inventory_category`](#base_products_add_inventory_category) | Add a category to the product catalog. | | [`base_products_add_inventory_manufacturer`](#base_products_add_inventory_manufacturer) | Add or update a manufacturer. | | [`base_products_add_inventory_price_group`](#base_products_add_inventory_price_group) | Add a new price group. | | [`base_products_add_inventory_product`](#base_products_add_inventory_product) | Add or update a product in the catalog. | | [`base_products_add_inventory_warehouse`](#base_products_add_inventory_warehouse) | Add a new warehouse. | | [`base_products_delete_inventory`](#base_products_delete_inventory) | Delete a product catalog. | | [`base_products_delete_inventory_category`](#base_products_delete_inventory_category) | Delete a category from the product catalog. | | [`base_products_delete_inventory_manufacturer`](#base_products_delete_inventory_manufacturer) | Delete a manufacturer. | | [`base_products_delete_inventory_price_group`](#base_products_delete_inventory_price_group) | Delete a price group. | | [`base_products_delete_inventory_product`](#base_products_delete_inventory_product) | Delete a product from the catalog. | | [`base_products_delete_inventory_warehouse`](#base_products_delete_inventory_warehouse) | Delete a warehouse. | | [`base_products_get_external_storage_categories`](#base_products_get_external_storage_categories) | Retrieve categories from an external storage. | | [`base_products_get_external_storage_products_data`](#base_products_get_external_storage_products_data) | Retrieve detailed product data from an external storage. | | [`base_products_get_external_storage_products_list`](#base_products_get_external_storage_products_list) | Retrieve product list from an external storage. | | [`base_products_get_external_storages_list`](#base_products_get_external_storages_list) | Retrieve the list of connected external storages (e.g., shops, marketplaces). | | [`base_products_get_inventories`](#base_products_get_inventories) | Retrieve the list of product catalogs. | | [`base_products_get_inventory_categories`](#base_products_get_inventory_categories) | Retrieve product categories from the catalog. | | [`base_products_get_inventory_extra_fields`](#base_products_get_inventory_extra_fields) | Retrieve custom extra field definitions for inventory products. | | [`base_products_get_inventory_manufacturers`](#base_products_get_inventory_manufacturers) | Retrieve the list of manufacturers. | | [`base_products_get_inventory_price_groups`](#base_products_get_inventory_price_groups) | Retrieve the list of price groups. | | [`base_products_get_inventory_product_logs`](#base_products_get_inventory_product_logs) | Retrieve event logs for a specific product. | | [`base_products_get_inventory_products_data`](#base_products_get_inventory_products_data) | Retrieve detailed data for specific products. | | [`base_products_get_inventory_products_list`](#base_products_get_inventory_products_list) | Retrieve a list of products from a catalog with basic data. | | [`base_products_get_inventory_products_prices`](#base_products_get_inventory_products_prices) | Retrieve prices for products in a catalog. | | [`base_products_get_inventory_products_stock`](#base_products_get_inventory_products_stock) | Retrieve stock levels for products in a catalog. | | [`base_products_get_inventory_warehouses`](#base_products_get_inventory_warehouses) | Retrieve the list of warehouses. | | [`base_products_update_inventory_products_prices`](#base_products_update_inventory_products_prices) | Update prices for products. Max 1000 products per call. | | [`base_products_update_inventory_products_stock`](#base_products_update_inventory_products_stock) | Update stock levels for products. Max 1000 products per call. | *** ## base\_products\_add\_inventory Create a new product catalog. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | No | — | Catalog ID. Omit to create new, provide to update existing. | | `name` | string | Yes | — | Catalog name. | | `description` | string | No | — | Catalog description. | | `languages` | string\[] | No | — | Array of supported language codes (e.g., \['en', 'pl']). | | `default_language` | string | No | — | Default language code. | | `price_groups` | string\[] | No | — | Array of price group IDs. | | `default_price_group` | number | No | — | Default price group ID. | | `warehouses` | string\[] | No | — | Array of warehouse IDs. | | `default_warehouse` | string | No | — | Default warehouse ID. | | `reservations` | boolean | No | — | Enable stock reservations. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog ID. Omit to create new, provide to update existing." }, "name": { "type": "string", "description": "Catalog name." }, "description": { "type": "string", "description": "Catalog description." }, "languages": { "type": "array", "items": { "type": "string" }, "description": "Array of supported language codes (e.g., ['en', 'pl'])." }, "default_language": { "type": "string", "description": "Default language code." }, "price_groups": { "type": "array", "items": { "type": "string" }, "description": "Array of price group IDs." }, "default_price_group": { "type": "number", "description": "Default price group ID." }, "warehouses": { "type": "array", "items": { "type": "string" }, "description": "Array of warehouse IDs." }, "default_warehouse": { "type": "string", "description": "Default warehouse ID." }, "reservations": { "type": "boolean", "description": "Enable stock reservations." } }, "required": [ "PCID", "name" ] } ``` *** ## base\_products\_add\_inventory\_category Add a category to the product catalog. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | No | — | Catalog identifier. | | `category_id` | number | No | — | Category ID. Omit for new, provide to update. | | `name` | string | Yes | — | Category name. | | `parent_id` | number | No | — | Parent category ID (0 for root). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog identifier." }, "category_id": { "type": "number", "description": "Category ID. Omit for new, provide to update." }, "name": { "type": "string", "description": "Category name." }, "parent_id": { "type": "number", "description": "Parent category ID (0 for root)." } }, "required": [ "PCID", "name" ] } ``` *** ## base\_products\_add\_inventory\_manufacturer Add or update a manufacturer. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `manufacturer_id` | number | No | — | Manufacturer ID. Omit for new, provide to update. | | `manufacturer_name` | string | Yes | — | Manufacturer name. | | `manufacturer_url` | string | No | — | Website URL. | | `manufacturer_email` | string | No | — | Email address. | | `manufacturer_phone` | string | No | — | Phone number. | | `manufacturer_city` | string | No | — | City. | | `manufacturer_country_code` | string | No | — | Country code. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "manufacturer_id": { "type": "number", "description": "Manufacturer ID. Omit for new, provide to update." }, "manufacturer_name": { "type": "string", "description": "Manufacturer name." }, "manufacturer_url": { "type": "string", "description": "Website URL." }, "manufacturer_email": { "type": "string", "description": "Email address." }, "manufacturer_phone": { "type": "string", "description": "Phone number." }, "manufacturer_city": { "type": "string", "description": "City." }, "manufacturer_country_code": { "type": "string", "description": "Country code." } }, "required": [ "PCID", "manufacturer_name" ] } ``` *** ## base\_products\_add\_inventory\_price\_group Add a new price group. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `price_group_id` | number | No | — | Price group ID. Omit for new, provide to update. | | `name` | string | Yes | — | Price group name. | | `description` | string | No | — | Description. | | `currency` | string | No | — | ISO currency code. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "price_group_id": { "type": "number", "description": "Price group ID. Omit for new, provide to update." }, "name": { "type": "string", "description": "Price group name." }, "description": { "type": "string", "description": "Description." }, "currency": { "type": "string", "description": "ISO currency code." } }, "required": [ "PCID", "name" ] } ``` *** ## base\_products\_add\_inventory\_product Add or update a product in the catalog. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | Yes | — | Catalog identifier. | | `product_id` | string | Yes | — | Product ID. Use '0' or 'new' to create new. | | `is_bundle` | boolean | No | — | Whether this is a bundle product. | | `sku` | string | No | — | Stock keeping unit. | | `ean` | string | No | — | European article number. | | `tax_rate` | number | No | — | Tax rate percentage. | | `weight` | number | No | — | Weight in kg. | | `height` | number | No | — | Height in cm. | | `width` | number | No | — | Width in cm. | | `length` | number | No | — | Length in cm. | | `category_id` | number | No | — | Category ID. | | `manufacturer_id` | number | No | — | Manufacturer ID. | | `prices` | object | No | — | Prices by price group ID, e.g. \{"1": 29.99, "2": 25.99}. | | `stock` | object | No | — | Stock levels by warehouse ID, e.g. \{"1": 100, "2": 50}. | | `locations` | object | No | — | Warehouse locations by warehouse ID. | | `text_fields` | object | No | — | Text fields: name, description, features, etc. Keyed by language code. | | `images` | object | No | — | Image URLs by position number, e.g. \{"1": "https\://...", "2": "https\://..."}. | | `tags` | string\[] | No | — | Array of tag strings. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog identifier." }, "product_id": { "type": "string", "description": "Product ID. Use '0' or 'new' to create new." }, "is_bundle": { "type": "boolean", "description": "Whether this is a bundle product." }, "sku": { "type": "string", "description": "Stock keeping unit." }, "ean": { "type": "string", "description": "European article number." }, "tax_rate": { "type": "number", "description": "Tax rate percentage." }, "weight": { "type": "number", "description": "Weight in kg." }, "height": { "type": "number", "description": "Height in cm." }, "width": { "type": "number", "description": "Width in cm." }, "length": { "type": "number", "description": "Length in cm." }, "category_id": { "type": "number", "description": "Category ID." }, "manufacturer_id": { "type": "number", "description": "Manufacturer ID." }, "prices": { "type": "object", "description": "Prices by price group ID, e.g. {\"1\": 29.99, \"2\": 25.99}." }, "stock": { "type": "object", "description": "Stock levels by warehouse ID, e.g. {\"1\": 100, \"2\": 50}." }, "locations": { "type": "object", "description": "Warehouse locations by warehouse ID." }, "text_fields": { "type": "object", "description": "Text fields: name, description, features, etc. Keyed by language code." }, "images": { "type": "object", "description": "Image URLs by position number, e.g. {\"1\": \"https://...\", \"2\": \"https://...\"}." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of tag strings." } }, "required": [ "PCID", "inventory_id", "product_id" ] } ``` *** ## base\_products\_add\_inventory\_warehouse Add a new warehouse. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `warehouse_id` | number | No | — | Warehouse ID. Omit for new, provide to update. | | `name` | string | Yes | — | Warehouse name. | | `description` | string | No | — | Warehouse description. | | `stock_edition` | boolean | No | — | Allow stock editing. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "warehouse_id": { "type": "number", "description": "Warehouse ID. Omit for new, provide to update." }, "name": { "type": "string", "description": "Warehouse name." }, "description": { "type": "string", "description": "Warehouse description." }, "stock_edition": { "type": "boolean", "description": "Allow stock editing." } }, "required": [ "PCID", "name" ] } ``` *** ## base\_products\_delete\_inventory Delete a product catalog. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | Yes | — | Catalog identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog identifier." } }, "required": [ "PCID", "inventory_id" ] } ``` *** ## base\_products\_delete\_inventory\_category Delete a category from the product catalog. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `category_id` | number | Yes | — | Category identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category_id": { "type": "number", "description": "Category identifier." } }, "required": [ "PCID", "category_id" ] } ``` *** ## base\_products\_delete\_inventory\_manufacturer Delete a manufacturer. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `manufacturer_id` | number | Yes | — | Manufacturer identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "manufacturer_id": { "type": "number", "description": "Manufacturer identifier." } }, "required": [ "PCID", "manufacturer_id" ] } ``` *** ## base\_products\_delete\_inventory\_price\_group Delete a price group. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `price_group_id` | number | Yes | — | Price group identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "price_group_id": { "type": "number", "description": "Price group identifier." } }, "required": [ "PCID", "price_group_id" ] } ``` *** ## base\_products\_delete\_inventory\_product Delete a product from the catalog. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `product_id` | number | Yes | — | Product identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "product_id": { "type": "number", "description": "Product identifier." } }, "required": [ "PCID", "product_id" ] } ``` *** ## base\_products\_delete\_inventory\_warehouse Delete a warehouse. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `warehouse_id` | number | Yes | — | Warehouse identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "warehouse_id": { "type": "number", "description": "Warehouse identifier." } }, "required": [ "PCID", "warehouse_id" ] } ``` *** ## base\_products\_get\_external\_storage\_categories Retrieve categories from an external storage. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `storage_id` | string | Yes | — | Storage identifier (e.g., 'shop\_2445'). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "storage_id": { "type": "string", "description": "Storage identifier (e.g., 'shop_2445')." } }, "required": [ "PCID", "storage_id" ] } ``` *** ## base\_products\_get\_external\_storage\_products\_data Retrieve detailed product data from an external storage. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `storage_id` | string | Yes | — | Storage identifier. | | `products` | string\[] | Yes | — | Array of product IDs to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "storage_id": { "type": "string", "description": "Storage identifier." }, "products": { "type": "array", "items": { "type": "string" }, "description": "Array of product IDs to retrieve." } }, "required": [ "PCID", "storage_id", "products" ] } ``` *** ## base\_products\_get\_external\_storage\_products\_list Retrieve product list from an external storage. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `storage_id` | string | Yes | — | Storage identifier. | | `filter_category_id` | number | No | — | Filter by category ID. | | `filter_sort` | string | No | — | Sort field. | | `page` | number | No | — | Page number. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "storage_id": { "type": "string", "description": "Storage identifier." }, "filter_category_id": { "type": "number", "description": "Filter by category ID." }, "filter_sort": { "type": "string", "description": "Sort field." }, "page": { "type": "number", "description": "Page number." } }, "required": [ "PCID", "storage_id" ] } ``` *** ## base\_products\_get\_external\_storages\_list Retrieve the list of connected external storages (e.g., shops, marketplaces). ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_products\_get\_inventories Retrieve the list of product catalogs. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_products\_get\_inventory\_categories Retrieve product categories from the catalog. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | No | — | Catalog identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog identifier." } }, "required": [ "PCID" ] } ``` *** ## base\_products\_get\_inventory\_extra\_fields Retrieve custom extra field definitions for inventory products. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_products\_get\_inventory\_manufacturers Retrieve the list of manufacturers. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | number | No | — | Page number (1000 per page). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "number", "description": "Page number (1000 per page)." } }, "required": [ "PCID" ] } ``` *** ## base\_products\_get\_inventory\_price\_groups Retrieve the list of price groups. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_products\_get\_inventory\_product\_logs Retrieve event logs for a specific product. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `product_id` | number | Yes | — | Product identifier. | | `date_from` | number | Yes | — | Unix timestamp. Retrieve logs from this date. | | `date_to` | number | No | — | Unix timestamp. Retrieve logs until this date. | | `log_type` | string\[] | No | — | Array of log type IDs to filter. | | `sort` | number | No | — | Sort order: 0 = ascending, 1 = descending. | | `page` | number | No | — | Page number. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "product_id": { "type": "number", "description": "Product identifier." }, "date_from": { "type": "number", "description": "Unix timestamp. Retrieve logs from this date." }, "date_to": { "type": "number", "description": "Unix timestamp. Retrieve logs until this date." }, "log_type": { "type": "array", "items": { "type": "string" }, "description": "Array of log type IDs to filter." }, "sort": { "type": "number", "description": "Sort order: 0 = ascending, 1 = descending." }, "page": { "type": "number", "description": "Page number." } }, "required": [ "PCID", "product_id", "date_from" ] } ``` *** ## base\_products\_get\_inventory\_products\_data Retrieve detailed data for specific products. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | Yes | — | Catalog identifier. | | `products` | string\[] | Yes | — | Array of product IDs to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog identifier." }, "products": { "type": "array", "items": { "type": "string" }, "description": "Array of product IDs to retrieve." } }, "required": [ "PCID", "inventory_id", "products" ] } ``` *** ## base\_products\_get\_inventory\_products\_list Retrieve a list of products from a catalog with basic data. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | Yes | — | Catalog identifier. | | `filter_id` | number | No | — | Filter by product ID. | | `filter_category_id` | number | No | — | Filter by category ID. | | `filter_ean` | string | No | — | Filter by EAN code. | | `filter_sku` | string | No | — | Filter by SKU. | | `filter_name` | string | No | — | Filter by product name (partial match). | | `filter_price_from` | number | No | — | Minimum price filter. | | `filter_price_to` | number | No | — | Maximum price filter. | | `filter_stock_from` | number | No | — | Minimum stock filter. | | `filter_stock_to` | number | No | — | Maximum stock filter. | | `page` | number | No | — | Page number (1000 products per page). | | `filter_sort` | string | No | — | Sort field (e.g., 'name ASC', 'price DESC'). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog identifier." }, "filter_id": { "type": "number", "description": "Filter by product ID." }, "filter_category_id": { "type": "number", "description": "Filter by category ID." }, "filter_ean": { "type": "string", "description": "Filter by EAN code." }, "filter_sku": { "type": "string", "description": "Filter by SKU." }, "filter_name": { "type": "string", "description": "Filter by product name (partial match)." }, "filter_price_from": { "type": "number", "description": "Minimum price filter." }, "filter_price_to": { "type": "number", "description": "Maximum price filter." }, "filter_stock_from": { "type": "number", "description": "Minimum stock filter." }, "filter_stock_to": { "type": "number", "description": "Maximum stock filter." }, "page": { "type": "number", "description": "Page number (1000 products per page)." }, "filter_sort": { "type": "string", "description": "Sort field (e.g., 'name ASC', 'price DESC')." } }, "required": [ "PCID", "inventory_id" ] } ``` *** ## base\_products\_get\_inventory\_products\_prices Retrieve prices for products in a catalog. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | Yes | — | Catalog identifier. | | `page` | number | No | — | Page number (1000 products per page). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog identifier." }, "page": { "type": "number", "description": "Page number (1000 products per page)." } }, "required": [ "PCID", "inventory_id" ] } ``` *** ## base\_products\_get\_inventory\_products\_stock Retrieve stock levels for products in a catalog. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | Yes | — | Catalog identifier. | | `page` | number | No | — | Page number (1000 products per page). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog identifier." }, "page": { "type": "number", "description": "Page number (1000 products per page)." } }, "required": [ "PCID", "inventory_id" ] } ``` *** ## base\_products\_get\_inventory\_warehouses Retrieve the list of warehouses. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_products\_update\_inventory\_products\_prices Update prices for products. Max 1000 products per call. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | Yes | — | Catalog identifier. | | `products` | object | Yes | — | Price updates. Object with product IDs as keys, each mapping to price group values, e.g. \{"123": \{"1": 29.99}}. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog identifier." }, "products": { "type": "object", "description": "Price updates. Object with product IDs as keys, each mapping to price group values, e.g. {\"123\": {\"1\": 29.99}}." } }, "required": [ "PCID", "inventory_id", "products" ] } ``` *** ## base\_products\_update\_inventory\_products\_stock Update stock levels for products. Max 1000 products per call. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inventory_id` | number | Yes | — | Catalog identifier. | | `products` | object | Yes | — | Stock updates. Object with product IDs as keys, each mapping to warehouse stock levels, e.g. \{"123": \{"1": 50}}. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inventory_id": { "type": "number", "description": "Catalog identifier." }, "products": { "type": "object", "description": "Stock updates. Object with product IDs as keys, each mapping to warehouse stock levels, e.g. {\"123\": {\"1\": 50}}." } }, "required": [ "PCID", "inventory_id", "products" ] } ``` # base-shipping Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/base/base-shipping Base Shipping & CRM - manage courier shipments, labels, and customer records **Server path:** `/base-shipping` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`base_shipping_add_crm_client`](#base_shipping_add_crm_client) | Add or update a CRM client record. | | [`base_shipping_create_package`](#base_shipping_create_package) | Create a courier shipment for an order. | | [`base_shipping_create_package_manual`](#base_shipping_create_package_manual) | Add a manually-created shipment to an order (e.g., for a tracking number obtained outside Base). | | [`base_shipping_delete_courier_package`](#base_shipping_delete_courier_package) | Delete a courier shipment package. | | [`base_shipping_delete_crm_client`](#base_shipping_delete_crm_client) | Delete a CRM client record. | | [`base_shipping_get_courier_accounts`](#base_shipping_get_courier_accounts) | Retrieve courier accounts for a specific courier. | | [`base_shipping_get_courier_fields`](#base_shipping_get_courier_fields) | Retrieve the shipment form fields required for a specific courier. | | [`base_shipping_get_courier_services`](#base_shipping_get_courier_services) | Retrieve additional services available for a courier shipment. | | [`base_shipping_get_couriers_list`](#base_shipping_get_couriers_list) | Retrieve the list of available courier integrations. | | [`base_shipping_get_crm_client_data`](#base_shipping_get_crm_client_data) | Retrieve detailed data for a specific CRM client. | | [`base_shipping_get_crm_clients`](#base_shipping_get_crm_clients) | Retrieve CRM clients. Returns up to 100 per page. | | [`base_shipping_get_label`](#base_shipping_get_label) | Download a shipping label for a package. | | [`base_shipping_get_order_packages`](#base_shipping_get_order_packages) | Retrieve shipment packages for an order. | | [`base_shipping_get_package_details`](#base_shipping_get_package_details) | Retrieve detailed information about a shipment package. | | [`base_shipping_get_protocol`](#base_shipping_get_protocol) | Download a parcel protocol document for packages. | *** ## base\_shipping\_add\_crm\_client Add or update a CRM client record. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `crm_client_id` | number | No | — | Client ID. Omit to create new, provide to update. | | `invoice_company` | string | No | — | Company name. | | `invoice_tax_id` | string | No | — | Tax identification number. | | `invoice_fullname` | string | No | — | Full name. | | `invoice_address` | string | No | — | Address. | | `invoice_city` | string | No | — | City. | | `invoice_postcode` | string | No | — | Postal code. | | `invoice_country_code` | string | No | — | Country code. | | `email` | string | No | — | Email address. | | `phone` | string | No | — | Phone number. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "crm_client_id": { "type": "number", "description": "Client ID. Omit to create new, provide to update." }, "invoice_company": { "type": "string", "description": "Company name." }, "invoice_tax_id": { "type": "string", "description": "Tax identification number." }, "invoice_fullname": { "type": "string", "description": "Full name." }, "invoice_address": { "type": "string", "description": "Address." }, "invoice_city": { "type": "string", "description": "City." }, "invoice_postcode": { "type": "string", "description": "Postal code." }, "invoice_country_code": { "type": "string", "description": "Country code." }, "email": { "type": "string", "description": "Email address." }, "phone": { "type": "string", "description": "Phone number." } }, "required": [ "PCID" ] } ``` *** ## base\_shipping\_create\_package Create a courier shipment for an order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | | `courier_code` | string | Yes | — | Courier code (from getCouriersList). | | `account_id` | number | Yes | — | Courier account ID (from getCourierAccounts). | | `fields` | object\[] | Yes | — | Array of form field objects with 'id' and 'value' keys (from getCourierFields). | | `packages` | object\[] | Yes | — | Array of package objects with weight, size\_x, size\_y, size\_z. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." }, "courier_code": { "type": "string", "description": "Courier code (from getCouriersList)." }, "account_id": { "type": "number", "description": "Courier account ID (from getCourierAccounts)." }, "fields": { "type": "array", "items": { "type": "object" }, "description": "Array of form field objects with 'id' and 'value' keys (from getCourierFields)." }, "packages": { "type": "array", "items": { "type": "object" }, "description": "Array of package objects with weight, size_x, size_y, size_z." } }, "required": [ "PCID", "order_id", "courier_code", "account_id", "fields", "packages" ] } ``` *** ## base\_shipping\_create\_package\_manual Add a manually-created shipment to an order (e.g., for a tracking number obtained outside Base). **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | | `courier_code` | string | Yes | — | Courier code. | | `package_number` | string | Yes | — | Tracking number. | | `pickup_date` | number | No | — | Unix timestamp for pickup date. | | `return_shipment` | boolean | No | — | Whether this is a return shipment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." }, "courier_code": { "type": "string", "description": "Courier code." }, "package_number": { "type": "string", "description": "Tracking number." }, "pickup_date": { "type": "number", "description": "Unix timestamp for pickup date." }, "return_shipment": { "type": "boolean", "description": "Whether this is a return shipment." } }, "required": [ "PCID", "order_id", "courier_code", "package_number" ] } ``` *** ## base\_shipping\_delete\_courier\_package Delete a courier shipment package. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courier_code` | string | Yes | — | Courier code. | | `package_id` | number | Yes | — | Package/shipment identifier. | | `package_number` | string | No | — | Tracking number (optional alternative to package\_id). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courier_code": { "type": "string", "description": "Courier code." }, "package_id": { "type": "number", "description": "Package/shipment identifier." }, "package_number": { "type": "string", "description": "Tracking number (optional alternative to package_id)." } }, "required": [ "PCID", "courier_code", "package_id" ] } ``` *** ## base\_shipping\_delete\_crm\_client Delete a CRM client record. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `crm_client_id` | number | Yes | — | Client identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "crm_client_id": { "type": "number", "description": "Client identifier." } }, "required": [ "PCID", "crm_client_id" ] } ``` *** ## base\_shipping\_get\_courier\_accounts Retrieve courier accounts for a specific courier. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courier_code` | string | Yes | — | Courier code. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courier_code": { "type": "string", "description": "Courier code." } }, "required": [ "PCID", "courier_code" ] } ``` *** ## base\_shipping\_get\_courier\_fields Retrieve the shipment form fields required for a specific courier. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courier_code` | string | Yes | — | Courier code. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courier_code": { "type": "string", "description": "Courier code." } }, "required": [ "PCID", "courier_code" ] } ``` *** ## base\_shipping\_get\_courier\_services Retrieve additional services available for a courier shipment. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courier_code` | string | Yes | — | Courier code. | | `order_id` | number | Yes | — | Order identifier. | | `account_id` | number | Yes | — | Courier account ID. | | `fields` | object\[] | Yes | — | Array of current field values. | | `packages` | object\[] | Yes | — | Array of package specifications. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courier_code": { "type": "string", "description": "Courier code." }, "order_id": { "type": "number", "description": "Order identifier." }, "account_id": { "type": "number", "description": "Courier account ID." }, "fields": { "type": "array", "items": { "type": "object" }, "description": "Array of current field values." }, "packages": { "type": "array", "items": { "type": "object" }, "description": "Array of package specifications." } }, "required": [ "PCID", "courier_code", "order_id", "account_id", "fields", "packages" ] } ``` *** ## base\_shipping\_get\_couriers\_list Retrieve the list of available courier integrations. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## base\_shipping\_get\_crm\_client\_data Retrieve detailed data for a specific CRM client. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `crm_client_id` | number | Yes | — | Client identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "crm_client_id": { "type": "number", "description": "Client identifier." } }, "required": [ "PCID", "crm_client_id" ] } ``` *** ## base\_shipping\_get\_crm\_clients Retrieve CRM clients. Returns up to 100 per page. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filter_invoice_company` | string | No | — | Filter by company name. | | `filter_invoice_tax_id` | string | No | — | Filter by tax ID. | | `filter_email` | string | No | — | Filter by email. | | `filter_phone` | string | No | — | Filter by phone. | | `page` | number | No | — | Page number (100 clients per page). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter_invoice_company": { "type": "string", "description": "Filter by company name." }, "filter_invoice_tax_id": { "type": "string", "description": "Filter by tax ID." }, "filter_email": { "type": "string", "description": "Filter by email." }, "filter_phone": { "type": "string", "description": "Filter by phone." }, "page": { "type": "number", "description": "Page number (100 clients per page)." } }, "required": [ "PCID" ] } ``` *** ## base\_shipping\_get\_label Download a shipping label for a package. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courier_code` | string | Yes | — | Courier code. | | `package_id` | number | Yes | — | Package/shipment identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courier_code": { "type": "string", "description": "Courier code." }, "package_id": { "type": "number", "description": "Package/shipment identifier." } }, "required": [ "PCID", "courier_code", "package_id" ] } ``` *** ## base\_shipping\_get\_order\_packages Retrieve shipment packages for an order. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `order_id` | number | Yes | — | Order identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order_id": { "type": "number", "description": "Order identifier." } }, "required": [ "PCID", "order_id" ] } ``` *** ## base\_shipping\_get\_package\_details Retrieve detailed information about a shipment package. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `package_id` | number | Yes | — | Package/shipment identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "package_id": { "type": "number", "description": "Package/shipment identifier." } }, "required": [ "PCID", "package_id" ] } ``` *** ## base\_shipping\_get\_protocol Download a parcel protocol document for packages. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courier_code` | string | Yes | — | Courier code. | | `package_ids` | string\[] | Yes | — | Array of package/shipment IDs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courier_code": { "type": "string", "description": "Courier code." }, "package_ids": { "type": "array", "items": { "type": "string" }, "description": "Array of package/shipment IDs." } }, "required": [ "PCID", "courier_code", "package_ids" ] } ``` # basecamp Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/basecamp Basecamp - Projects, tasks, messages, files, and automation **PinkConnect service:** `basecamp` | **Type:** Application (parent with child servers) | **PCID required:** Yes basecamp is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [basecamp-automation](/api-reference/mcp-servers/application/basecamp/basecamp-automation) | `/basecamp-automation` | 46 | Basecamp Automation & Templates | | [basecamp-messages](/api-reference/mcp-servers/application/basecamp/basecamp-messages) | `/basecamp-messages` | 55 | Basecamp Messages & Files | | [basecamp-projects](/api-reference/mcp-servers/application/basecamp/basecamp-projects) | `/basecamp-projects` | 44 | Basecamp Projects & People | | [basecamp-tasks](/api-reference/mcp-servers/application/basecamp/basecamp-tasks) | `/basecamp-tasks` | 58 | Basecamp Tasks & Scheduling | # basecamp-automation Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/basecamp/basecamp-automation Basecamp Automation & Templates **Server path:** `/basecamp-automation` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`basecamp_automation_archive_recording`](#basecamp_automation_archive_recording) | Archive a recording | | [`basecamp_automation_clone_tool`](#basecamp_automation_clone_tool) | Clone an existing tool to create a new one | | [`basecamp_automation_create_answer`](#basecamp_automation_create_answer) | Create a new answer for a question | | [`basecamp_automation_create_lineup_marker`](#basecamp_automation_create_lineup_marker) | Create a new lineup marker | | [`basecamp_automation_create_project_from_template`](#basecamp_automation_create_project_from_template) | Create a project from a template (asynchronous) | | [`basecamp_automation_create_question`](#basecamp_automation_create_question) | Create a new question in a questionnaire | | [`basecamp_automation_create_template`](#basecamp_automation_create_template) | Create a new template | | [`basecamp_automation_create_webhook`](#basecamp_automation_create_webhook) | Create a new webhook for a project | | [`basecamp_automation_delete_lineup_marker`](#basecamp_automation_delete_lineup_marker) | Delete a lineup marker | | [`basecamp_automation_delete_template`](#basecamp_automation_delete_template) | Delete a template (trash it) | | [`basecamp_automation_delete_tool`](#basecamp_automation_delete_tool) | Delete a tool (trash it) | | [`basecamp_automation_delete_webhook`](#basecamp_automation_delete_webhook) | Delete a webhook | | [`basecamp_automation_disable_tool`](#basecamp_automation_disable_tool) | Disable a tool (hide it from the project dock) | | [`basecamp_automation_enable_tool`](#basecamp_automation_enable_tool) | Enable a tool (show it on the project dock) | | [`basecamp_automation_get_answer`](#basecamp_automation_get_answer) | Get a single answer by id | | [`basecamp_automation_get_answers_by_person`](#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. | | [`basecamp_automation_get_project_construction`](#basecamp_automation_get_project_construction) | Get the status of a project construction | | [`basecamp_automation_get_question`](#basecamp_automation_get_question) | Get a single question by id | | [`basecamp_automation_get_question_reminders`](#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`](#basecamp_automation_get_questionnaire) | Get a questionnaire (automatic check-ins container) by id | | [`basecamp_automation_get_recording`](#basecamp_automation_get_recording) | Get a single recording by id | | [`basecamp_automation_get_search_metadata`](#basecamp_automation_get_search_metadata) | Get search metadata (available filter options) | | [`basecamp_automation_get_template`](#basecamp_automation_get_template) | Get a single template by id | | [`basecamp_automation_get_tool`](#basecamp_automation_get_tool) | Get a dock tool by id | | [`basecamp_automation_get_webhook`](#basecamp_automation_get_webhook) | Get a single webhook by id | | [`basecamp_automation_list_answers`](#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. | | [`basecamp_automation_list_events`](#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. | | [`basecamp_automation_list_lineup_markers`](#basecamp_automation_list_lineup_markers) | List all lineup markers for the account | | [`basecamp_automation_list_question_answerers`](#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. | | [`basecamp_automation_list_questions`](#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. | | [`basecamp_automation_list_recordings`](#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. | | [`basecamp_automation_list_templates`](#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. | | [`basecamp_automation_list_webhooks`](#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. | | [`basecamp_automation_pause_question`](#basecamp_automation_pause_question) | Pause a check-in question (stops sending reminders) | | [`basecamp_automation_reposition_tool`](#basecamp_automation_reposition_tool) | Reposition a tool on the project dock | | [`basecamp_automation_resume_question`](#basecamp_automation_resume_question) | Resume a paused check-in question (resumes sending reminders) | | [`basecamp_automation_search`](#basecamp_automation_search) | Search for content across the account | | [`basecamp_automation_trash_recording`](#basecamp_automation_trash_recording) | Trash a recording | | [`basecamp_automation_unarchive_recording`](#basecamp_automation_unarchive_recording) | Unarchive a recording (restore to active status) | | [`basecamp_automation_update_answer`](#basecamp_automation_update_answer) | Update an existing answer | | [`basecamp_automation_update_lineup_marker`](#basecamp_automation_update_lineup_marker) | Update an existing lineup marker | | [`basecamp_automation_update_question`](#basecamp_automation_update_question) | Update an existing question | | [`basecamp_automation_update_question_notification_settings`](#basecamp_automation_update_question_notification_settings) | Update notification settings for a check-in question | | [`basecamp_automation_update_template`](#basecamp_automation_update_template) | Update an existing template | | [`basecamp_automation_update_tool`](#basecamp_automation_update_tool) | Update (rename) an existing tool | | [`basecamp_automation_update_webhook`](#basecamp_automation_update_webhook) | Update an existing webhook | *** ## basecamp\_automation\_archive\_recording Archive a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## basecamp\_automation\_clone\_tool Clone an existing tool to create a new one **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `source_recording_id` | integer | Yes | — | Source Recording Id | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "source_recording_id": { "type": "integer", "description": "Source Recording Id" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "source_recording_id" ] } ``` *** ## basecamp\_automation\_create\_answer Create a new answer for a question **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionId` | integer | Yes | — | Question Id | | `content` | string | Yes | — | The content value | | `group_on` | string | No | — | Group On | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionId": { "type": "integer", "description": "Question Id" }, "content": { "type": "string", "description": "The content value" }, "group_on": { "type": "string", "description": "Group On" } }, "required": [ "PCID", "questionId", "content" ] } ``` *** ## basecamp\_automation\_create\_lineup\_marker Create a new lineup marker **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `date` | string | Yes | — | The date value | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "date": { "type": "string", "description": "The date value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "date", "name" ] } ``` *** ## basecamp\_automation\_create\_project\_from\_template Create a project from a template (asynchronous) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `templateId` | integer | Yes | — | Template Id | | `description` | string | No | — | The description value | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateId": { "type": "integer", "description": "Template Id" }, "description": { "type": "string", "description": "The description value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "templateId", "name" ] } ``` *** ## basecamp\_automation\_create\_question Create a new question in a questionnaire **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionnaireId` | integer | Yes | — | Questionnaire Id | | `schedule` | object | Yes | — | The schedule value | | `title` | string | Yes | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionnaireId": { "type": "integer", "description": "Questionnaire Id" }, "schedule": { "type": "object", "description": "The schedule value", "properties": { "frequency": { "type": "string", "description": "The frequency value" }, "days": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The days value" }, "hour": { "type": "integer", "description": "The hour value" }, "minute": { "type": "integer", "description": "The minute value" }, "week_instance": { "type": "integer", "description": "Week Instance" }, "week_interval": { "type": "integer", "description": "Week Interval" }, "month_interval": { "type": "integer", "description": "Month Interval" }, "start_date": { "type": "string", "description": "Start date for filtering" }, "end_date": { "type": "string", "description": "End date for filtering" } } }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "questionnaireId", "schedule", "title" ] } ``` *** ## basecamp\_automation\_create\_template Create a new template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `description` | string | No | — | The description value | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "The description value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "name" ] } ``` *** ## basecamp\_automation\_create\_webhook Create a new webhook for a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucketId` | integer | Yes | — | Bucket Id | | `active` | boolean | No | — | The active value | | `payload_url` | string | Yes | — | Payload Url | | `types` | string\[] | Yes | — | The types value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bucketId": { "type": "integer", "description": "Bucket Id" }, "active": { "type": "boolean", "description": "The active value" }, "payload_url": { "type": "string", "description": "Payload Url" }, "types": { "type": "array", "items": { "type": "string" }, "description": "The types value" } }, "required": [ "PCID", "bucketId", "payload_url", "types" ] } ``` *** ## basecamp\_automation\_delete\_lineup\_marker Delete a lineup marker **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `markerId` | integer | Yes | — | Marker Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "markerId": { "type": "integer", "description": "Marker Id" } }, "required": [ "PCID", "markerId" ] } ``` *** ## basecamp\_automation\_delete\_template Delete a template (trash it) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `templateId` | integer | Yes | — | Template Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateId": { "type": "integer", "description": "Template Id" } }, "required": [ "PCID", "templateId" ] } ``` *** ## basecamp\_automation\_delete\_tool Delete a tool (trash it) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `toolId` | integer | Yes | — | Tool Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "toolId": { "type": "integer", "description": "Tool Id" } }, "required": [ "PCID", "toolId" ] } ``` *** ## basecamp\_automation\_delete\_webhook Delete a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucketId` | integer | Yes | — | Bucket (project) ID | | `webhookId` | integer | Yes | — | Webhook Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bucketId": { "type": "integer", "description": "Bucket (project) ID" }, "webhookId": { "type": "integer", "description": "Webhook Id" } }, "required": [ "PCID", "bucketId", "webhookId" ] } ``` *** ## basecamp\_automation\_disable\_tool Disable a tool (hide it from the project dock) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `toolId` | integer | Yes | — | Tool Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "toolId": { "type": "integer", "description": "Tool Id" } }, "required": [ "PCID", "toolId" ] } ``` *** ## basecamp\_automation\_enable\_tool Enable a tool (show it on the project dock) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `toolId` | integer | Yes | — | Tool Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "toolId": { "type": "integer", "description": "Tool Id" } }, "required": [ "PCID", "toolId" ] } ``` *** ## basecamp\_automation\_get\_answer Get a single answer by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `answerId` | integer | Yes | — | Answer Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "answerId": { "type": "integer", "description": "Answer Id" } }, "required": [ "PCID", "answerId" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionId` | integer | Yes | — | Question Id | | `personId` | integer | Yes | — | Person Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionId": { "type": "integer", "description": "Question Id" }, "personId": { "type": "integer", "description": "Person Id" } }, "required": [ "PCID", "questionId", "personId" ] } ``` *** ## basecamp\_automation\_get\_project\_construction Get the status of a project construction **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `templateId` | integer | Yes | — | Template Id | | `constructionId` | integer | Yes | — | Construction Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateId": { "type": "integer", "description": "Template Id" }, "constructionId": { "type": "integer", "description": "Construction Id" } }, "required": [ "PCID", "templateId", "constructionId" ] } ``` *** ## basecamp\_automation\_get\_question Get a single question by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionId` | integer | Yes | — | Question Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionId": { "type": "integer", "description": "Question Id" } }, "required": [ "PCID", "questionId" ] } ``` *** ## 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. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_automation\_get\_questionnaire Get a questionnaire (automatic check-ins container) by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionnaireId` | integer | Yes | — | Questionnaire Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionnaireId": { "type": "integer", "description": "Questionnaire Id" } }, "required": [ "PCID", "questionnaireId" ] } ``` *** ## basecamp\_automation\_get\_recording Get a single recording by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## basecamp\_automation\_get\_search\_metadata Get search metadata (available filter options) ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_automation\_get\_template Get a single template by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `templateId` | integer | Yes | — | Template Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateId": { "type": "integer", "description": "Template Id" } }, "required": [ "PCID", "templateId" ] } ``` *** ## basecamp\_automation\_get\_tool Get a dock tool by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `toolId` | integer | Yes | — | Tool Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "toolId": { "type": "integer", "description": "Tool Id" } }, "required": [ "PCID", "toolId" ] } ``` *** ## basecamp\_automation\_get\_webhook Get a single webhook by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucketId` | integer | Yes | — | Bucket (project) ID | | `webhookId` | integer | Yes | — | Webhook Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bucketId": { "type": "integer", "description": "Bucket (project) ID" }, "webhookId": { "type": "integer", "description": "Webhook Id" } }, "required": [ "PCID", "bucketId", "webhookId" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionId` | integer | Yes | — | Question Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionId": { "type": "integer", "description": "Question Id" } }, "required": [ "PCID", "questionId" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## basecamp\_automation\_list\_lineup\_markers List all lineup markers for the account ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionId` | integer | Yes | — | Question Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionId": { "type": "integer", "description": "Question Id" } }, "required": [ "PCID", "questionId" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionnaireId` | integer | Yes | — | Questionnaire Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionnaireId": { "type": "integer", "description": "Questionnaire Id" } }, "required": [ "PCID", "questionnaireId" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `type` | string | Yes | — | Comment\|Document\|Kanban::Card\|Kanban::Step\|Message\|Question::Answer\|Schedule::Entry\|Todo\|Todolist\|Upload\|Vault | | `bucket` | string | No | — | The bucket value | | `status` | string | No | — | active\|archived\|trashed | | `sort` | string | No | — | created\_at\|updated\_at | | `direction` | string | No | — | asc\|desc | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "type": { "type": "string", "description": "Comment|Document|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault" }, "bucket": { "type": "string", "description": "The bucket value" }, "status": { "type": "string", "description": "active|archived|trashed" }, "sort": { "type": "string", "description": "created_at|updated_at" }, "direction": { "type": "string", "description": "asc|desc" } }, "required": [ "PCID", "type" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `status` | string | No | — | active\|archived\|trashed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "status": { "type": "string", "description": "active|archived|trashed" } }, "required": [ "PCID" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucketId` | integer | Yes | — | Bucket Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bucketId": { "type": "integer", "description": "Bucket Id" } }, "required": [ "PCID", "bucketId" ] } ``` *** ## basecamp\_automation\_pause\_question Pause a check-in question (stops sending reminders) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionId` | integer | Yes | — | Question Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionId": { "type": "integer", "description": "Question Id" } }, "required": [ "PCID", "questionId" ] } ``` *** ## basecamp\_automation\_reposition\_tool Reposition a tool on the project dock **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `toolId` | integer | Yes | — | Tool Id | | `position` | integer | Yes | — | The position value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "toolId": { "type": "integer", "description": "Tool Id" }, "position": { "type": "integer", "description": "The position value" } }, "required": [ "PCID", "toolId", "position" ] } ``` *** ## basecamp\_automation\_resume\_question Resume a paused check-in question (resumes sending reminders) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionId` | integer | Yes | — | Question Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionId": { "type": "integer", "description": "Question Id" } }, "required": [ "PCID", "questionId" ] } ``` *** ## basecamp\_automation\_search Search for content across the account **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `q` | string | Yes | — | The q value | | `sort` | string | No | — | best\_match\|created\_at | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "q": { "type": "string", "description": "The q value" }, "sort": { "type": "string", "description": "best_match|created_at" } }, "required": [ "PCID", "q" ] } ``` *** ## basecamp\_automation\_trash\_recording Trash a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## basecamp\_automation\_unarchive\_recording Unarchive a recording (restore to active status) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## basecamp\_automation\_update\_answer Update an existing answer **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `answerId` | integer | Yes | — | Answer Id | | `content` | string | Yes | — | The content value | | `group_on` | string | No | — | Group On | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "answerId": { "type": "integer", "description": "Answer Id" }, "content": { "type": "string", "description": "The content value" }, "group_on": { "type": "string", "description": "Group On" } }, "required": [ "PCID", "answerId", "content" ] } ``` *** ## basecamp\_automation\_update\_lineup\_marker Update an existing lineup marker **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `markerId` | integer | Yes | — | Marker Id | | `date` | string | No | — | The date value | | `name` | string | No | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "markerId": { "type": "integer", "description": "Marker Id" }, "date": { "type": "string", "description": "The date value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "markerId" ] } ``` *** ## basecamp\_automation\_update\_question Update an existing question **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionId` | integer | Yes | — | Question Id | | `paused` | boolean | No | — | The paused value | | `schedule` | object | No | — | The schedule value | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionId": { "type": "integer", "description": "Question Id" }, "paused": { "type": "boolean", "description": "The paused value" }, "schedule": { "type": "object", "description": "The schedule value", "properties": { "frequency": { "type": "string", "description": "The frequency value" }, "days": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The days value" }, "hour": { "type": "integer", "description": "The hour value" }, "minute": { "type": "integer", "description": "The minute value" }, "week_instance": { "type": "integer", "description": "Week Instance" }, "week_interval": { "type": "integer", "description": "Week Interval" }, "month_interval": { "type": "integer", "description": "Month Interval" }, "start_date": { "type": "string", "description": "Start date for filtering" }, "end_date": { "type": "string", "description": "End date for filtering" } } }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "questionId" ] } ``` *** ## basecamp\_automation\_update\_question\_notification\_settings Update notification settings for a check-in question **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `questionId` | integer | Yes | — | Question Id | | `digest_include_unanswered` | boolean | No | — | Include unanswered in digest | | `notify_on_answer` | boolean | No | — | Notify when someone answers | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "questionId": { "type": "integer", "description": "Question Id" }, "digest_include_unanswered": { "type": "boolean", "description": "Include unanswered in digest" }, "notify_on_answer": { "type": "boolean", "description": "Notify when someone answers" } }, "required": [ "PCID", "questionId" ] } ``` *** ## basecamp\_automation\_update\_template Update an existing template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `templateId` | integer | Yes | — | Template Id | | `description` | string | No | — | The description value | | `name` | string | No | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateId": { "type": "integer", "description": "Template Id" }, "description": { "type": "string", "description": "The description value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "templateId" ] } ``` *** ## basecamp\_automation\_update\_tool Update (rename) an existing tool **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `toolId` | integer | Yes | — | Tool Id | | `title` | string | Yes | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "toolId": { "type": "integer", "description": "Tool Id" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "toolId", "title" ] } ``` *** ## basecamp\_automation\_update\_webhook Update an existing webhook **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucketId` | integer | Yes | — | Bucket (project) ID | | `webhookId` | integer | Yes | — | Webhook Id | | `active` | boolean | No | — | The active value | | `payload_url` | string | No | — | Payload Url | | `types` | string\[] | No | — | The types value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bucketId": { "type": "integer", "description": "Bucket (project) ID" }, "webhookId": { "type": "integer", "description": "Webhook Id" }, "active": { "type": "boolean", "description": "The active value" }, "payload_url": { "type": "string", "description": "Payload Url" }, "types": { "type": "array", "items": { "type": "string" }, "description": "The types value" } }, "required": [ "PCID", "bucketId", "webhookId" ] } ``` # basecamp-messages Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/basecamp/basecamp-messages Basecamp Messages & Files **Server path:** `/basecamp-messages` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`basecamp_messages_create_attachment`](#basecamp_messages_create_attachment) | Create an attachment (upload a file for embedding) | | [`basecamp_messages_create_campfire_line`](#basecamp_messages_create_campfire_line) | Create a new line (message) in a campfire | | [`basecamp_messages_create_campfire_upload`](#basecamp_messages_create_campfire_upload) | Upload a file to a campfire | | [`basecamp_messages_create_chatbot`](#basecamp_messages_create_chatbot) | Create a new chatbot for a campfire | | [`basecamp_messages_create_comment`](#basecamp_messages_create_comment) | Create a new comment on a recording | | [`basecamp_messages_create_document`](#basecamp_messages_create_document) | Create a new document in a vault | | [`basecamp_messages_create_event_boost`](#basecamp_messages_create_event_boost) | Create a boost on a specific event within a recording | | [`basecamp_messages_create_forward_reply`](#basecamp_messages_create_forward_reply) | Create a reply to a forward | | [`basecamp_messages_create_message`](#basecamp_messages_create_message) | Create a new message on a message board | | [`basecamp_messages_create_message_type`](#basecamp_messages_create_message_type) | Create a new message type in a project | | [`basecamp_messages_create_recording_boost`](#basecamp_messages_create_recording_boost) | Create a boost on a recording | | [`basecamp_messages_create_upload`](#basecamp_messages_create_upload) | Create a new upload in a vault | | [`basecamp_messages_create_vault`](#basecamp_messages_create_vault) | Create a new vault (subfolder) in a vault | | [`basecamp_messages_delete_boost`](#basecamp_messages_delete_boost) | Delete a boost | | [`basecamp_messages_delete_campfire_line`](#basecamp_messages_delete_campfire_line) | Delete a campfire line | | [`basecamp_messages_delete_chatbot`](#basecamp_messages_delete_chatbot) | Delete a chatbot | | [`basecamp_messages_delete_message_type`](#basecamp_messages_delete_message_type) | Delete a message type | | [`basecamp_messages_get_boost`](#basecamp_messages_get_boost) | Get a single boost | | [`basecamp_messages_get_campfire`](#basecamp_messages_get_campfire) | Get a campfire by ID | | [`basecamp_messages_get_campfire_line`](#basecamp_messages_get_campfire_line) | Get a campfire line by ID | | [`basecamp_messages_get_chatbot`](#basecamp_messages_get_chatbot) | Get a chatbot by ID | | [`basecamp_messages_get_comment`](#basecamp_messages_get_comment) | Get a single comment by id | | [`basecamp_messages_get_document`](#basecamp_messages_get_document) | Get a single document by id | | [`basecamp_messages_get_forward`](#basecamp_messages_get_forward) | Get a forward by ID | | [`basecamp_messages_get_forward_reply`](#basecamp_messages_get_forward_reply) | Get a forward reply by ID | | [`basecamp_messages_get_inbox`](#basecamp_messages_get_inbox) | Get an inbox by ID | | [`basecamp_messages_get_message`](#basecamp_messages_get_message) | Get a single message by id | | [`basecamp_messages_get_message_board`](#basecamp_messages_get_message_board) | Get a message board | | [`basecamp_messages_get_message_type`](#basecamp_messages_get_message_type) | Get a single message type by id | | [`basecamp_messages_get_upload`](#basecamp_messages_get_upload) | Get a single upload by id | | [`basecamp_messages_get_vault`](#basecamp_messages_get_vault) | Get a single vault by id | | [`basecamp_messages_list_campfire_lines`](#basecamp_messages_list_campfire_lines) | List all lines (messages) in a campfire **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_campfire_uploads`](#basecamp_messages_list_campfire_uploads) | List uploaded files in a campfire **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_campfires`](#basecamp_messages_list_campfires) | List all campfires across the account **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_chatbots`](#basecamp_messages_list_chatbots) | List all chatbots for a campfire **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_comments`](#basecamp_messages_list_comments) | List comments on a recording **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_documents`](#basecamp_messages_list_documents) | List documents in a vault **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_event_boosts`](#basecamp_messages_list_event_boosts) | List boosts on a specific event within a recording | | [`basecamp_messages_list_forward_replies`](#basecamp_messages_list_forward_replies) | List all replies to a forward **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_forwards`](#basecamp_messages_list_forwards) | List all forwards in an inbox **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_message_types`](#basecamp_messages_list_message_types) | List message types 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_messages_list_messages`](#basecamp_messages_list_messages) | List messages on a message board **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_recording_boosts`](#basecamp_messages_list_recording_boosts) | List boosts on a recording | | [`basecamp_messages_list_upload_versions`](#basecamp_messages_list_upload_versions) | List versions of an upload **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_uploads`](#basecamp_messages_list_uploads) | List uploads in a vault **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_list_vaults`](#basecamp_messages_list_vaults) | List vaults (subfolders) in a vault **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_messages_pin_message`](#basecamp_messages_pin_message) | Pin a message to the top of the message board | | [`basecamp_messages_unpin_message`](#basecamp_messages_unpin_message) | Unpin a message from the message board | | [`basecamp_messages_update_chatbot`](#basecamp_messages_update_chatbot) | Update an existing chatbot | | [`basecamp_messages_update_comment`](#basecamp_messages_update_comment) | Update an existing comment | | [`basecamp_messages_update_document`](#basecamp_messages_update_document) | Update an existing document | | [`basecamp_messages_update_message`](#basecamp_messages_update_message) | Update an existing message | | [`basecamp_messages_update_message_type`](#basecamp_messages_update_message_type) | Update an existing message type | | [`basecamp_messages_update_upload`](#basecamp_messages_update_upload) | Update an existing upload | | [`basecamp_messages_update_vault`](#basecamp_messages_update_vault) | Update an existing vault | *** ## basecamp\_messages\_create\_attachment Create an attachment (upload a file for embedding) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | The name value | | `body` | string | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name value" }, "body": { "type": "string", "description": "Request body" } }, "required": [ "PCID", "name", "body" ] } ``` *** ## basecamp\_messages\_create\_campfire\_line Create a new line (message) in a campfire **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | | `content` | string | Yes | — | The content value | | `content_type` | string | No | — | Content Type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" }, "content": { "type": "string", "description": "The content value" }, "content_type": { "type": "string", "description": "Content Type" } }, "required": [ "PCID", "campfireId", "content" ] } ``` *** ## basecamp\_messages\_create\_campfire\_upload Upload a file to a campfire **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | | `name` | string | Yes | — | Filename for the uploaded file (e.g. "report.pdf"). | | `body` | string | Yes | — | Raw binary content of the file. Set the Content-Type header to match the file's media type (e.g. "image/png", "application/pdf"). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" }, "name": { "type": "string", "description": "Filename for the uploaded file (e.g. \"report.pdf\")." }, "body": { "type": "string", "description": "Raw binary content of the file. Set the Content-Type header to match the file's media type (e.g. \"image/png\", \"application/pdf\")." } }, "required": [ "PCID", "campfireId", "name", "body" ] } ``` *** ## basecamp\_messages\_create\_chatbot Create a new chatbot for a campfire **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | | `command_url` | string | No | — | Command Url | | `service_name` | string | Yes | — | Service Name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" }, "command_url": { "type": "string", "description": "Command Url" }, "service_name": { "type": "string", "description": "Service Name" } }, "required": [ "PCID", "campfireId", "service_name" ] } ``` *** ## basecamp\_messages\_create\_comment Create a new comment on a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | | `content` | string | Yes | — | The content value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" }, "content": { "type": "string", "description": "The content value" } }, "required": [ "PCID", "recordingId", "content" ] } ``` *** ## basecamp\_messages\_create\_document Create a new document in a vault **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `vaultId` | integer | Yes | — | Vault Id | | `content` | string | No | — | The content value | | `status` | string | No | — | active\|drafted | | `subscriptions` | integer\[] | No | — | The subscriptions value | | `title` | string | Yes | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vaultId": { "type": "integer", "description": "Vault Id" }, "content": { "type": "string", "description": "The content value" }, "status": { "type": "string", "description": "active|drafted" }, "subscriptions": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The subscriptions value" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "vaultId", "title" ] } ``` *** ## basecamp\_messages\_create\_event\_boost Create a boost on a specific event within a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | | `eventId` | integer | Yes | — | Event Id | | `content` | string | Yes | — | The content value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" }, "eventId": { "type": "integer", "description": "Event Id" }, "content": { "type": "string", "description": "The content value" } }, "required": [ "PCID", "recordingId", "eventId", "content" ] } ``` *** ## basecamp\_messages\_create\_forward\_reply Create a reply to a forward **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `forwardId` | integer | Yes | — | Forward Id | | `content` | string | Yes | — | The content value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "forwardId": { "type": "integer", "description": "Forward Id" }, "content": { "type": "string", "description": "The content value" } }, "required": [ "PCID", "forwardId", "content" ] } ``` *** ## basecamp\_messages\_create\_message Create a new message on a message board **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `boardId` | integer | Yes | — | Board Id | | `category_id` | integer | No | — | Category Id | | `content` | string | No | — | The content value | | `status` | string | No | — | active\|drafted | | `subject` | string | Yes | — | The subject value | | `subscriptions` | integer\[] | No | — | The subscriptions value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "boardId": { "type": "integer", "description": "Board Id" }, "category_id": { "type": "integer", "description": "Category Id" }, "content": { "type": "string", "description": "The content value" }, "status": { "type": "string", "description": "active|drafted" }, "subject": { "type": "string", "description": "The subject value" }, "subscriptions": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The subscriptions value" } }, "required": [ "PCID", "boardId", "subject" ] } ``` *** ## basecamp\_messages\_create\_message\_type Create a new message type in a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `icon` | string | Yes | — | The icon value | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "icon": { "type": "string", "description": "The icon value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "icon", "name" ] } ``` *** ## basecamp\_messages\_create\_recording\_boost Create a boost on a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | | `content` | string | Yes | — | The content value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" }, "content": { "type": "string", "description": "The content value" } }, "required": [ "PCID", "recordingId", "content" ] } ``` *** ## basecamp\_messages\_create\_upload Create a new upload in a vault **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `vaultId` | integer | Yes | — | Vault Id | | `attachable_sgid` | string | Yes | — | Attachable Sgid | | `base_name` | string | No | — | Base Name | | `description` | string | No | — | The description value | | `subscriptions` | integer\[] | No | — | The subscriptions value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vaultId": { "type": "integer", "description": "Vault Id" }, "attachable_sgid": { "type": "string", "description": "Attachable Sgid" }, "base_name": { "type": "string", "description": "Base Name" }, "description": { "type": "string", "description": "The description value" }, "subscriptions": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The subscriptions value" } }, "required": [ "PCID", "vaultId", "attachable_sgid" ] } ``` *** ## basecamp\_messages\_create\_vault Create a new vault (subfolder) in a vault **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `vaultId` | integer | Yes | — | Vault Id | | `title` | string | Yes | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vaultId": { "type": "integer", "description": "Vault Id" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "vaultId", "title" ] } ``` *** ## basecamp\_messages\_delete\_boost Delete a boost **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `boostId` | integer | Yes | — | Boost Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "boostId": { "type": "integer", "description": "Boost Id" } }, "required": [ "PCID", "boostId" ] } ``` *** ## basecamp\_messages\_delete\_campfire\_line Delete a campfire line **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | | `lineId` | integer | Yes | — | Line Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" }, "lineId": { "type": "integer", "description": "Line Id" } }, "required": [ "PCID", "campfireId", "lineId" ] } ``` *** ## basecamp\_messages\_delete\_chatbot Delete a chatbot **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | | `chatbotId` | integer | Yes | — | Chatbot Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" }, "chatbotId": { "type": "integer", "description": "Chatbot Id" } }, "required": [ "PCID", "campfireId", "chatbotId" ] } ``` *** ## basecamp\_messages\_delete\_message\_type Delete a message type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `typeId` | integer | Yes | — | Type Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "typeId": { "type": "integer", "description": "Type Id" } }, "required": [ "PCID", "typeId" ] } ``` *** ## basecamp\_messages\_get\_boost Get a single boost **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `boostId` | integer | Yes | — | Boost Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "boostId": { "type": "integer", "description": "Boost Id" } }, "required": [ "PCID", "boostId" ] } ``` *** ## basecamp\_messages\_get\_campfire Get a campfire by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" } }, "required": [ "PCID", "campfireId" ] } ``` *** ## basecamp\_messages\_get\_campfire\_line Get a campfire line by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | | `lineId` | integer | Yes | — | Line Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" }, "lineId": { "type": "integer", "description": "Line Id" } }, "required": [ "PCID", "campfireId", "lineId" ] } ``` *** ## basecamp\_messages\_get\_chatbot Get a chatbot by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | | `chatbotId` | integer | Yes | — | Chatbot Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" }, "chatbotId": { "type": "integer", "description": "Chatbot Id" } }, "required": [ "PCID", "campfireId", "chatbotId" ] } ``` *** ## basecamp\_messages\_get\_comment Get a single comment by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `commentId` | integer | Yes | — | Comment Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commentId": { "type": "integer", "description": "Comment Id" } }, "required": [ "PCID", "commentId" ] } ``` *** ## basecamp\_messages\_get\_document Get a single document by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `documentId` | integer | Yes | — | Document Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentId": { "type": "integer", "description": "Document Id" } }, "required": [ "PCID", "documentId" ] } ``` *** ## basecamp\_messages\_get\_forward Get a forward by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `forwardId` | integer | Yes | — | Forward Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "forwardId": { "type": "integer", "description": "Forward Id" } }, "required": [ "PCID", "forwardId" ] } ``` *** ## basecamp\_messages\_get\_forward\_reply Get a forward reply by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `forwardId` | integer | Yes | — | Forward Id | | `replyId` | integer | Yes | — | Reply Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "forwardId": { "type": "integer", "description": "Forward Id" }, "replyId": { "type": "integer", "description": "Reply Id" } }, "required": [ "PCID", "forwardId", "replyId" ] } ``` *** ## basecamp\_messages\_get\_inbox Get an inbox by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inboxId` | integer | Yes | — | Inbox Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inboxId": { "type": "integer", "description": "Inbox Id" } }, "required": [ "PCID", "inboxId" ] } ``` *** ## basecamp\_messages\_get\_message Get a single message by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `messageId` | integer | Yes | — | Message Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "messageId": { "type": "integer", "description": "Message Id" } }, "required": [ "PCID", "messageId" ] } ``` *** ## basecamp\_messages\_get\_message\_board Get a message board **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `boardId` | integer | Yes | — | Board Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "boardId": { "type": "integer", "description": "Board Id" } }, "required": [ "PCID", "boardId" ] } ``` *** ## basecamp\_messages\_get\_message\_type Get a single message type by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `typeId` | integer | Yes | — | Type Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "typeId": { "type": "integer", "description": "Type Id" } }, "required": [ "PCID", "typeId" ] } ``` *** ## basecamp\_messages\_get\_upload Get a single upload by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uploadId` | integer | Yes | — | Upload Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uploadId": { "type": "integer", "description": "Upload Id" } }, "required": [ "PCID", "uploadId" ] } ``` *** ## basecamp\_messages\_get\_vault Get a single vault by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `vaultId` | integer | Yes | — | Vault Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vaultId": { "type": "integer", "description": "Vault Id" } }, "required": [ "PCID", "vaultId" ] } ``` *** ## basecamp\_messages\_list\_campfire\_lines List all lines (messages) in a campfire **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | | `sort` | string | No | — | created\_at\|updated\_at | | `direction` | string | No | — | asc\|desc | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" }, "sort": { "type": "string", "description": "created_at|updated_at" }, "direction": { "type": "string", "description": "asc|desc" } }, "required": [ "PCID", "campfireId" ] } ``` *** ## basecamp\_messages\_list\_campfire\_uploads List uploaded files in a campfire **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | | `sort` | string | No | — | created\_at\|updated\_at | | `direction` | string | No | — | asc\|desc | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" }, "sort": { "type": "string", "description": "created_at|updated_at" }, "direction": { "type": "string", "description": "asc|desc" } }, "required": [ "PCID", "campfireId" ] } ``` *** ## basecamp\_messages\_list\_campfires List all campfires across the account **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_messages\_list\_chatbots List all chatbots for a campfire **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" } }, "required": [ "PCID", "campfireId" ] } ``` *** ## basecamp\_messages\_list\_comments List comments on a recording **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## basecamp\_messages\_list\_documents List documents in a vault **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `vaultId` | integer | Yes | — | Vault Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vaultId": { "type": "integer", "description": "Vault Id" } }, "required": [ "PCID", "vaultId" ] } ``` *** ## basecamp\_messages\_list\_event\_boosts List boosts on a specific event within a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | | `eventId` | integer | Yes | — | Event Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" }, "eventId": { "type": "integer", "description": "Event Id" } }, "required": [ "PCID", "recordingId", "eventId" ] } ``` *** ## basecamp\_messages\_list\_forward\_replies List all replies to a forward **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `forwardId` | integer | Yes | — | Forward Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "forwardId": { "type": "integer", "description": "Forward Id" } }, "required": [ "PCID", "forwardId" ] } ``` *** ## basecamp\_messages\_list\_forwards List all forwards in an inbox **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `inboxId` | integer | Yes | — | Inbox Id | | `sort` | string | No | — | created\_at\|updated\_at | | `direction` | string | No | — | asc\|desc | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "inboxId": { "type": "integer", "description": "Inbox Id" }, "sort": { "type": "string", "description": "created_at|updated_at" }, "direction": { "type": "string", "description": "asc|desc" } }, "required": [ "PCID", "inboxId" ] } ``` *** ## basecamp\_messages\_list\_message\_types List message types in a project **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_messages\_list\_messages List messages on a message board **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `boardId` | integer | Yes | — | Board Id | | `sort` | string | No | — | created\_at\|updated\_at | | `direction` | string | No | — | asc\|desc | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "boardId": { "type": "integer", "description": "Board Id" }, "sort": { "type": "string", "description": "created_at|updated_at" }, "direction": { "type": "string", "description": "asc|desc" } }, "required": [ "PCID", "boardId" ] } ``` *** ## basecamp\_messages\_list\_recording\_boosts List boosts on a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## basecamp\_messages\_list\_upload\_versions List versions of an upload **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uploadId` | integer | Yes | — | Upload Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uploadId": { "type": "integer", "description": "Upload Id" } }, "required": [ "PCID", "uploadId" ] } ``` *** ## basecamp\_messages\_list\_uploads List uploads in a vault **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `vaultId` | integer | Yes | — | Vault Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vaultId": { "type": "integer", "description": "Vault Id" } }, "required": [ "PCID", "vaultId" ] } ``` *** ## basecamp\_messages\_list\_vaults List vaults (subfolders) in a vault **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `vaultId` | integer | Yes | — | Vault Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vaultId": { "type": "integer", "description": "Vault Id" } }, "required": [ "PCID", "vaultId" ] } ``` *** ## basecamp\_messages\_pin\_message Pin a message to the top of the message board **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `messageId` | integer | Yes | — | Message Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "messageId": { "type": "integer", "description": "Message Id" } }, "required": [ "PCID", "messageId" ] } ``` *** ## basecamp\_messages\_unpin\_message Unpin a message from the message board **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `messageId` | integer | Yes | — | Message Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "messageId": { "type": "integer", "description": "Message Id" } }, "required": [ "PCID", "messageId" ] } ``` *** ## basecamp\_messages\_update\_chatbot Update an existing chatbot **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campfireId` | integer | Yes | — | Campfire Id | | `chatbotId` | integer | Yes | — | Chatbot Id | | `command_url` | string | No | — | Command Url | | `service_name` | string | Yes | — | Service Name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campfireId": { "type": "integer", "description": "Campfire Id" }, "chatbotId": { "type": "integer", "description": "Chatbot Id" }, "command_url": { "type": "string", "description": "Command Url" }, "service_name": { "type": "string", "description": "Service Name" } }, "required": [ "PCID", "campfireId", "chatbotId", "service_name" ] } ``` *** ## basecamp\_messages\_update\_comment Update an existing comment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `commentId` | integer | Yes | — | Comment Id | | `content` | string | Yes | — | The content value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commentId": { "type": "integer", "description": "Comment Id" }, "content": { "type": "string", "description": "The content value" } }, "required": [ "PCID", "commentId", "content" ] } ``` *** ## basecamp\_messages\_update\_document Update an existing document **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `documentId` | integer | Yes | — | Document Id | | `content` | string | No | — | The content value | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentId": { "type": "integer", "description": "Document Id" }, "content": { "type": "string", "description": "The content value" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "documentId" ] } ``` *** ## basecamp\_messages\_update\_message Update an existing message **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `messageId` | integer | Yes | — | Message Id | | `category_id` | integer | No | — | Category Id | | `content` | string | No | — | The content value | | `status` | string | No | — | active\|drafted | | `subject` | string | No | — | The subject value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "messageId": { "type": "integer", "description": "Message Id" }, "category_id": { "type": "integer", "description": "Category Id" }, "content": { "type": "string", "description": "The content value" }, "status": { "type": "string", "description": "active|drafted" }, "subject": { "type": "string", "description": "The subject value" } }, "required": [ "PCID", "messageId" ] } ``` *** ## basecamp\_messages\_update\_message\_type Update an existing message type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `typeId` | integer | Yes | — | Type Id | | `icon` | string | No | — | The icon value | | `name` | string | No | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "typeId": { "type": "integer", "description": "Type Id" }, "icon": { "type": "string", "description": "The icon value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "typeId" ] } ``` *** ## basecamp\_messages\_update\_upload Update an existing upload **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uploadId` | integer | Yes | — | Upload Id | | `base_name` | string | No | — | Base Name | | `description` | string | No | — | The description value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uploadId": { "type": "integer", "description": "Upload Id" }, "base_name": { "type": "string", "description": "Base Name" }, "description": { "type": "string", "description": "The description value" } }, "required": [ "PCID", "uploadId" ] } ``` *** ## basecamp\_messages\_update\_vault Update an existing vault **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `vaultId` | integer | Yes | — | Vault Id | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "vaultId": { "type": "integer", "description": "Vault Id" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "vaultId" ] } ``` # basecamp-projects Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/basecamp/basecamp-projects Basecamp Projects & People **Server path:** `/basecamp-projects` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`basecamp_projects_create_project`](#basecamp_projects_create_project) | Create a new project | | [`basecamp_projects_disable_out_of_office`](#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`](#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`](#basecamp_projects_get_account) | Get the account for the current access token | | [`basecamp_projects_get_assigned_todos`](#basecamp_projects_get_assigned_todos) | Get todos assigned to a specific person | | [`basecamp_projects_get_client_approval`](#basecamp_projects_get_client_approval) | Get a single client approval by id | | [`basecamp_projects_get_client_correspondence`](#basecamp_projects_get_client_correspondence) | Get a single client correspondence by id | | [`basecamp_projects_get_client_reply`](#basecamp_projects_get_client_reply) | Get a single client reply by id | | [`basecamp_projects_get_my_assignments`](#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`](#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`](#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`](#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`](#basecamp_projects_get_my_preferences) | Get the current user's preferences | | [`basecamp_projects_get_my_profile`](#basecamp_projects_get_my_profile) | Get the current authenticated user's profile | | [`basecamp_projects_get_out_of_office`](#basecamp_projects_get_out_of_office) | Get the out of office status for a person | | [`basecamp_projects_get_overdue_todos`](#basecamp_projects_get_overdue_todos) | Get overdue todos grouped by lateness | | [`basecamp_projects_get_person`](#basecamp_projects_get_person) | Get a person by ID | | [`basecamp_projects_get_person_progress`](#basecamp_projects_get_person_progress) | Get a person's activity timeline | | [`basecamp_projects_get_progress_report`](#basecamp_projects_get_progress_report) | Get account-wide activity feed (progress report) | | [`basecamp_projects_get_project`](#basecamp_projects_get_project) | Get a single project by id | | [`basecamp_projects_get_project_timeline`](#basecamp_projects_get_project_timeline) | Get project timeline | | [`basecamp_projects_get_subscription`](#basecamp_projects_get_subscription) | Get subscription information for a recording | | [`basecamp_projects_get_upcoming_schedule`](#basecamp_projects_get_upcoming_schedule) | Get upcoming schedule entries within a date window | | [`basecamp_projects_list_assignable_people`](#basecamp_projects_list_assignable_people) | List people who can be assigned todos | | [`basecamp_projects_list_client_approvals`](#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`](#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`](#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`](#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`](#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`](#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`](#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`](#basecamp_projects_mark_as_read) | Mark specified items as read | | [`basecamp_projects_remove_account_logo`](#basecamp_projects_remove_account_logo) | Remove the account logo. Only administrators and account owners can use this endpoint. | | [`basecamp_projects_set_client_visibility`](#basecamp_projects_set_client_visibility) | Set client visibility for a recording | | [`basecamp_projects_subscribe`](#basecamp_projects_subscribe) | Subscribe the current user to a recording | | [`basecamp_projects_trash_project`](#basecamp_projects_trash_project) | Trash a project (returns 204 No Content) | | [`basecamp_projects_unsubscribe`](#basecamp_projects_unsubscribe) | Unsubscribe the current user from a recording | | [`basecamp_projects_update_account_logo`](#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`](#basecamp_projects_update_account_name) | Rename the current account. Only account owners can use this endpoint. | | [`basecamp_projects_update_my_preferences`](#basecamp_projects_update_my_preferences) | Update the current user's preferences | | [`basecamp_projects_update_my_profile`](#basecamp_projects_update_my_profile) | Update the current authenticated user's profile (returns 204 No Content) | | [`basecamp_projects_update_project`](#basecamp_projects_update_project) | Update an existing project | | [`basecamp_projects_update_project_access`](#basecamp_projects_update_project_access) | Update project access (grant/revoke/create people) | | [`basecamp_projects_update_subscription`](#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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "The description value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "name" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "personId": { "type": "integer", "description": "Person Id" } }, "required": [ "PCID", "personId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "personId": { "type": "integer", "description": "Person Id" }, "out_of_office": { "type": "object", "description": "Out Of Office", "properties": { "start_date": { "type": "string", "description": "Start date in ISO 8601 format (YYYY-MM-DD)" }, "end_date": { "type": "string", "description": "End date in ISO 8601 format (YYYY-MM-DD)" } }, "required": [ "end_date", "start_date" ] } }, "required": [ "PCID", "personId", "out_of_office" ] } ``` *** ## basecamp\_projects\_get\_account Get the account for the current access token ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_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" | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "personId": { "type": "integer", "description": "Person Id" }, "group_by": { "type": "string", "description": "Group by \"bucket\" or \"date\"" } }, "required": [ "PCID", "personId" ] } ``` *** ## basecamp\_projects\_get\_client\_approval Get a single client approval by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `approvalId` | integer | Yes | — | Approval Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "approvalId": { "type": "integer", "description": "Approval Id" } }, "required": [ "PCID", "approvalId" ] } ``` *** ## basecamp\_projects\_get\_client\_correspondence Get a single client correspondence by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `correspondenceId` | integer | Yes | — | Correspondence Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "correspondenceId": { "type": "integer", "description": "Correspondence Id" } }, "required": [ "PCID", "correspondenceId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" }, "replyId": { "type": "integer", "description": "Reply Id" } }, "required": [ "PCID", "recordingId", "replyId" ] } ``` *** ## 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. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_projects\_get\_my\_completed\_assignments Get the current user's completed assignments. Archived and trashed recordings are excluded. This endpoint is not paginated. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "scope": { "type": "string", "description": "Filter by due date range: overdue, due_today, due_tomorrow, due_later_this_week, due_next_week, due_later" } }, "required": [ "PCID" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number for paginating through read items. Defaults to 1." } }, "required": [ "PCID" ] } ``` *** ## basecamp\_projects\_get\_my\_preferences Get the current user's preferences ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_projects\_get\_my\_profile Get the current authenticated user's profile ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "personId": { "type": "integer", "description": "Person Id" } }, "required": [ "PCID", "personId" ] } ``` *** ## basecamp\_projects\_get\_overdue\_todos Get overdue todos grouped by lateness ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_projects\_get\_person Get a person by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `personId` | integer | Yes | — | Person Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "personId": { "type": "integer", "description": "Person Id" } }, "required": [ "PCID", "personId" ] } ``` *** ## basecamp\_projects\_get\_person\_progress Get a person's activity timeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `personId` | integer | Yes | — | Person Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "personId": { "type": "integer", "description": "Person Id" } }, "required": [ "PCID", "personId" ] } ``` *** ## basecamp\_projects\_get\_progress\_report Get account-wide activity feed (progress report) ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_projects\_get\_project Get a single project by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | integer | Yes | — | Project Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "integer", "description": "Project Id" } }, "required": [ "PCID", "projectId" ] } ``` *** ## basecamp\_projects\_get\_project\_timeline Get project timeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | integer | Yes | — | Project Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "integer", "description": "Project Id" } }, "required": [ "PCID", "projectId" ] } ``` *** ## basecamp\_projects\_get\_subscription Get subscription information for a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "window_starts_on": { "type": "string", "description": "Window Starts On" }, "window_ends_on": { "type": "string", "description": "Window Ends On" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_projects\_list\_assignable\_people List people who can be assigned todos ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sort` | string | No | — | created\_at\|updated\_at | | `direction` | string | No | — | asc\|desc | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sort": { "type": "string", "description": "created_at|updated_at" }, "direction": { "type": "string", "description": "asc|desc" } }, "required": [ "PCID" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sort` | string | No | — | created\_at\|updated\_at | | `direction` | string | No | — | asc\|desc | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sort": { "type": "string", "description": "created_at|updated_at" }, "direction": { "type": "string", "description": "asc|desc" } }, "required": [ "PCID" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## 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. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## 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. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | integer | Yes | — | Project Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "integer", "description": "Project Id" } }, "required": [ "PCID", "projectId" ] } ``` *** ## 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:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `status` | string | No | — | active\|archived\|trashed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "status": { "type": "string", "description": "active|archived|trashed" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "readables": { "type": "array", "items": { "type": "string" }, "description": "Array of readable_sgid values identifying the items to mark as read" } }, "required": [ "PCID", "readables" ] } ``` *** ## basecamp\_projects\_remove\_account\_logo Remove the account logo. Only administrators and account owners can use this endpoint. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" }, "visible_to_clients": { "type": "boolean", "description": "Visible To Clients" } }, "required": [ "PCID", "recordingId", "visible_to_clients" ] } ``` *** ## basecamp\_projects\_subscribe Subscribe the current user to a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## basecamp\_projects\_trash\_project Trash a project (returns 204 No Content) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | integer | Yes | — | Project Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "integer", "description": "Project Id" } }, "required": [ "PCID", "projectId" ] } ``` *** ## basecamp\_projects\_unsubscribe Unsubscribe the current user from a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "logo": { "type": "string", "description": "The logo value" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "name" ] } ``` *** ## basecamp\_projects\_update\_my\_preferences Update the current user's preferences **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `person` | object | Yes | — | The person value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "person": { "type": "object", "description": "The person value", "properties": { "time_zone_name": { "type": "string", "description": "Time zone name (e.g. \"America/Chicago\", \"London\", \"UTC\")" }, "first_week_day": { "type": "string", "description": "First day of the week: Sunday, Monday, Tuesday, etc." }, "time_format": { "type": "string", "description": "Time display format: twelve_hour or twenty_four_hour" } } } }, "required": [ "PCID", "person" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bio": { "type": "string", "description": "The bio value" }, "email_address": { "type": "string", "description": "Email Address" }, "first_week_day": { "type": "string", "description": "First Week Day", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "location": { "type": "string", "description": "The location value" }, "name": { "type": "string", "description": "The name value" }, "time_format": { "type": "string", "description": "Time Format" }, "time_zone_name": { "type": "string", "description": "Time Zone Name" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "integer", "description": "Project Id" }, "admissions": { "type": "string", "description": "invite|employee|team" }, "description": { "type": "string", "description": "The description value" }, "name": { "type": "string", "description": "The name value" }, "schedule_attributes": { "type": "object", "description": "Schedule Attributes", "properties": { "start_date": { "type": "string", "description": "Start date for filtering" }, "end_date": { "type": "string", "description": "End date for filtering" } } } }, "required": [ "PCID", "projectId", "name" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "integer", "description": "Project Id" }, "create": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "format": "password", "description": "The name value" }, "email_address": { "type": "string", "format": "password", "description": "Email Address" }, "title": { "type": "string", "format": "password", "description": "The title value" }, "company_name": { "type": "string", "format": "password", "description": "Company Name" } }, "required": [ "email_address", "name" ] }, "description": "The create value" }, "grant": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The grant value" }, "revoke": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The revoke value" } }, "required": [ "PCID", "projectId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" }, "subscriptions": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The subscriptions value" }, "unsubscriptions": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The unsubscriptions value" } }, "required": [ "PCID", "recordingId" ] } ``` # basecamp-tasks Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/basecamp/basecamp-tasks Basecamp Tasks & Scheduling **Server path:** `/basecamp-tasks` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`basecamp_tasks_complete_todo`](#basecamp_tasks_complete_todo) | Mark a todo as complete | | [`basecamp_tasks_create_card`](#basecamp_tasks_create_card) | Create a card in a column | | [`basecamp_tasks_create_card_column`](#basecamp_tasks_create_card_column) | Create a column in a card table | | [`basecamp_tasks_create_card_step`](#basecamp_tasks_create_card_step) | Create a step on a card | | [`basecamp_tasks_create_gauge_needle`](#basecamp_tasks_create_gauge_needle) | Create a gauge needle (progress update) for a project | | [`basecamp_tasks_create_schedule_entry`](#basecamp_tasks_create_schedule_entry) | Create a new schedule entry | | [`basecamp_tasks_create_timesheet_entry`](#basecamp_tasks_create_timesheet_entry) | Create a timesheet entry on a recording | | [`basecamp_tasks_create_todo`](#basecamp_tasks_create_todo) | Create a new todo in a todolist | | [`basecamp_tasks_create_todolist`](#basecamp_tasks_create_todolist) | Create a new todolist in a todoset | | [`basecamp_tasks_create_todolist_group`](#basecamp_tasks_create_todolist_group) | Create a new group in a todolist | | [`basecamp_tasks_destroy_gauge_needle`](#basecamp_tasks_destroy_gauge_needle) | Destroy a gauge needle | | [`basecamp_tasks_disable_card_column_on_hold`](#basecamp_tasks_disable_card_column_on_hold) | Disable on-hold section in a column | | [`basecamp_tasks_enable_card_column_on_hold`](#basecamp_tasks_enable_card_column_on_hold) | Enable on-hold section in a column | | [`basecamp_tasks_get_card`](#basecamp_tasks_get_card) | Get a card by ID | | [`basecamp_tasks_get_card_column`](#basecamp_tasks_get_card_column) | Get a card column by ID | | [`basecamp_tasks_get_card_step`](#basecamp_tasks_get_card_step) | Get a step by ID | | [`basecamp_tasks_get_card_table`](#basecamp_tasks_get_card_table) | Get a card table by ID | | [`basecamp_tasks_get_gauge_needle`](#basecamp_tasks_get_gauge_needle) | Get a gauge needle by ID | | [`basecamp_tasks_get_hill_chart`](#basecamp_tasks_get_hill_chart) | Get the hill chart for a todoset | | [`basecamp_tasks_get_project_timesheet`](#basecamp_tasks_get_project_timesheet) | Get timesheet for a specific project | | [`basecamp_tasks_get_recording_timesheet`](#basecamp_tasks_get_recording_timesheet) | Get timesheet for a specific recording | | [`basecamp_tasks_get_schedule`](#basecamp_tasks_get_schedule) | Get a schedule | | [`basecamp_tasks_get_schedule_entry`](#basecamp_tasks_get_schedule_entry) | Get a single schedule entry by id. Note: Recurring entries will redirect (302) to their recordable URL. Use GetScheduleEntryOccurrence for recurring entries instead. | | [`basecamp_tasks_get_schedule_entry_occurrence`](#basecamp_tasks_get_schedule_entry_occurrence) | Get a specific occurrence of a recurring schedule entry | | [`basecamp_tasks_get_timesheet_entry`](#basecamp_tasks_get_timesheet_entry) | Get a single timesheet entry | | [`basecamp_tasks_get_timesheet_report`](#basecamp_tasks_get_timesheet_report) | Get account-wide timesheet report | | [`basecamp_tasks_get_todo`](#basecamp_tasks_get_todo) | Get a single todo by id | | [`basecamp_tasks_get_todolist_or_group`](#basecamp_tasks_get_todolist_or_group) | Get a single todolist or todolist group by id The endpoint is polymorphic - the same URI returns either a Todolist or TodolistGroup | | [`basecamp_tasks_get_todoset`](#basecamp_tasks_get_todoset) | Get a todoset (container for todolists in a project) | | [`basecamp_tasks_list_cards`](#basecamp_tasks_list_cards) | List cards in a column **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_tasks_list_gauge_needles`](#basecamp_tasks_list_gauge_needles) | List gauge needles for a project, ordered newest first. | | [`basecamp_tasks_list_gauges`](#basecamp_tasks_list_gauges) | List gauges across all projects the authenticated user has access to. Gauges are sorted by risk level (red, yellow, green), then alphabetically. | | [`basecamp_tasks_list_schedule_entries`](#basecamp_tasks_list_schedule_entries) | List entries on a schedule **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_tasks_list_todolist_groups`](#basecamp_tasks_list_todolist_groups) | List groups in a todolist **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_tasks_list_todolists`](#basecamp_tasks_list_todolists) | List todolists in a todoset **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_tasks_list_todos`](#basecamp_tasks_list_todos) | List todos in a todolist **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. | | [`basecamp_tasks_move_card`](#basecamp_tasks_move_card) | Move a card to a different column | | [`basecamp_tasks_move_card_column`](#basecamp_tasks_move_card_column) | Move a column within a card table | | [`basecamp_tasks_reposition_card_step`](#basecamp_tasks_reposition_card_step) | Reposition a step within a card | | [`basecamp_tasks_reposition_todo`](#basecamp_tasks_reposition_todo) | Reposition a todo within its todolist | | [`basecamp_tasks_reposition_todolist_group`](#basecamp_tasks_reposition_todolist_group) | Reposition a todolist group | | [`basecamp_tasks_set_card_column_color`](#basecamp_tasks_set_card_column_color) | Set the color of a column | | [`basecamp_tasks_set_card_step_completion`](#basecamp_tasks_set_card_step_completion) | Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete) | | [`basecamp_tasks_subscribe_to_card_column`](#basecamp_tasks_subscribe_to_card_column) | Subscribe to a card column (watch for changes) | | [`basecamp_tasks_toggle_gauge`](#basecamp_tasks_toggle_gauge) | Enable or disable the gauge for a project. Only project admins can toggle gauges. | | [`basecamp_tasks_trash_todo`](#basecamp_tasks_trash_todo) | Trash a todo (returns 204 No Content) | | [`basecamp_tasks_uncomplete_todo`](#basecamp_tasks_uncomplete_todo) | Mark a todo as incomplete | | [`basecamp_tasks_unsubscribe_from_card_column`](#basecamp_tasks_unsubscribe_from_card_column) | Unsubscribe from a card column (stop watching for changes) | | [`basecamp_tasks_update_card`](#basecamp_tasks_update_card) | Update an existing card | | [`basecamp_tasks_update_card_column`](#basecamp_tasks_update_card_column) | Update an existing column | | [`basecamp_tasks_update_card_step`](#basecamp_tasks_update_card_step) | Update an existing step | | [`basecamp_tasks_update_gauge_needle`](#basecamp_tasks_update_gauge_needle) | Update a gauge needle's description. Position and color are immutable. | | [`basecamp_tasks_update_hill_chart_settings`](#basecamp_tasks_update_hill_chart_settings) | Track or untrack todolists on a hill chart | | [`basecamp_tasks_update_schedule_entry`](#basecamp_tasks_update_schedule_entry) | Update an existing schedule entry | | [`basecamp_tasks_update_schedule_settings`](#basecamp_tasks_update_schedule_settings) | Update schedule settings | | [`basecamp_tasks_update_timesheet_entry`](#basecamp_tasks_update_timesheet_entry) | Update a timesheet entry | | [`basecamp_tasks_update_todo`](#basecamp_tasks_update_todo) | Update an existing todo | | [`basecamp_tasks_update_todolist_or_group`](#basecamp_tasks_update_todolist_or_group) | Update an existing todolist or todolist group The endpoint is polymorphic - updates either a Todolist or TodolistGroup | *** ## basecamp\_tasks\_complete\_todo Mark a todo as complete **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todoId` | integer | Yes | — | Todo Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todoId": { "type": "integer", "description": "Todo Id" } }, "required": [ "PCID", "todoId" ] } ``` *** ## basecamp\_tasks\_create\_card Create a card in a column **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `columnId` | integer | Yes | — | Column Id | | `content` | string | No | — | The content value | | `due_on` | string | No | — | Due On | | `notify` | boolean | No | — | The notify value | | `title` | string | Yes | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "columnId": { "type": "integer", "description": "Column Id" }, "content": { "type": "string", "description": "The content value" }, "due_on": { "type": "string", "description": "Due On" }, "notify": { "type": "boolean", "description": "The notify value" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "columnId", "title" ] } ``` *** ## basecamp\_tasks\_create\_card\_column Create a column in a card table **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cardTableId` | integer | Yes | — | Card Table Id | | `description` | string | No | — | The description value | | `title` | string | Yes | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cardTableId": { "type": "integer", "description": "Card Table Id" }, "description": { "type": "string", "description": "The description value" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "cardTableId", "title" ] } ``` *** ## basecamp\_tasks\_create\_card\_step Create a step on a card **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cardId` | integer | Yes | — | Card Id | | `assignee_ids` | integer\[] | No | — | Assignee Ids | | `due_on` | string | No | — | Due On | | `title` | string | Yes | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cardId": { "type": "integer", "description": "Card Id" }, "assignee_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Assignee Ids" }, "due_on": { "type": "string", "description": "Due On" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "cardId", "title" ] } ``` *** ## basecamp\_tasks\_create\_gauge\_needle Create a gauge needle (progress update) for a project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | integer | Yes | — | Project Id | | `gauge_needle` | object | Yes | — | Gauge Needle | | `notify` | string | No | — | Who to notify: "everyone", "working\_on", "custom", or omit for nobody | | `subscriptions` | integer\[] | No | — | Array of people IDs to notify (only used when notify is "custom") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "integer", "description": "Project Id" }, "gauge_needle": { "type": "object", "description": "Gauge Needle", "properties": { "position": { "type": "integer", "description": "Position of the needle (0-100)" }, "color": { "type": "string", "description": "Status color: green (default), yellow, or red" }, "description": { "type": "string", "description": "Rich text (HTML) description of the progress update" } }, "required": [ "position" ] }, "notify": { "type": "string", "description": "Who to notify: \"everyone\", \"working_on\", \"custom\", or omit for nobody" }, "subscriptions": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Array of people IDs to notify (only used when notify is \"custom\")" } }, "required": [ "PCID", "projectId", "gauge_needle" ] } ``` *** ## basecamp\_tasks\_create\_schedule\_entry Create a new schedule entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `scheduleId` | integer | Yes | — | Schedule Id | | `all_day` | boolean | No | — | All Day | | `description` | string | No | — | The description value | | `ends_at` | string | Yes | — | Ends At | | `notify` | boolean | No | — | The notify value | | `participant_ids` | integer\[] | No | — | Participant Ids | | `starts_at` | string | Yes | — | Starts At | | `subscriptions` | integer\[] | No | — | The subscriptions value | | `summary` | string | Yes | — | The summary value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "scheduleId": { "type": "integer", "description": "Schedule Id" }, "all_day": { "type": "boolean", "description": "All Day" }, "description": { "type": "string", "description": "The description value" }, "ends_at": { "type": "string", "description": "Ends At" }, "notify": { "type": "boolean", "description": "The notify value" }, "participant_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Participant Ids" }, "starts_at": { "type": "string", "description": "Starts At" }, "subscriptions": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The subscriptions value" }, "summary": { "type": "string", "description": "The summary value" } }, "required": [ "PCID", "scheduleId", "ends_at", "starts_at", "summary" ] } ``` *** ## basecamp\_tasks\_create\_timesheet\_entry Create a timesheet entry on a recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | | `date` | string | Yes | — | The date value | | `description` | string | No | — | The description value | | `hours` | string | Yes | — | The hours value | | `person_id` | integer | No | — | Person Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" }, "date": { "type": "string", "description": "The date value" }, "description": { "type": "string", "description": "The description value" }, "hours": { "type": "string", "description": "The hours value" }, "person_id": { "type": "integer", "description": "Person Id" } }, "required": [ "PCID", "recordingId", "date", "hours" ] } ``` *** ## basecamp\_tasks\_create\_todo Create a new todo in a todolist **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todolistId` | integer | Yes | — | Todolist Id | | `assignee_ids` | integer\[] | No | — | Assignee Ids | | `completion_subscriber_ids` | integer\[] | No | — | Completion Subscriber Ids | | `content` | string | Yes | — | The content value | | `description` | string | No | — | The description value | | `due_on` | string | No | — | Due On | | `notify` | boolean | No | — | The notify value | | `starts_on` | string | No | — | Starts On | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todolistId": { "type": "integer", "description": "Todolist Id" }, "assignee_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Assignee Ids" }, "completion_subscriber_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Completion Subscriber Ids" }, "content": { "type": "string", "description": "The content value" }, "description": { "type": "string", "description": "The description value" }, "due_on": { "type": "string", "description": "Due On" }, "notify": { "type": "boolean", "description": "The notify value" }, "starts_on": { "type": "string", "description": "Starts On" } }, "required": [ "PCID", "todolistId", "content" ] } ``` *** ## basecamp\_tasks\_create\_todolist Create a new todolist in a todoset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todosetId` | integer | Yes | — | Todoset Id | | `description` | string | No | — | The description value | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todosetId": { "type": "integer", "description": "Todoset Id" }, "description": { "type": "string", "description": "The description value" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "todosetId", "name" ] } ``` *** ## basecamp\_tasks\_create\_todolist\_group Create a new group in a todolist **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todolistId` | integer | Yes | — | Todolist Id | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todolistId": { "type": "integer", "description": "Todolist Id" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "todolistId", "name" ] } ``` *** ## basecamp\_tasks\_destroy\_gauge\_needle Destroy a gauge needle **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `needleId` | integer | Yes | — | Needle Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "needleId": { "type": "integer", "description": "Needle Id" } }, "required": [ "PCID", "needleId" ] } ``` *** ## basecamp\_tasks\_disable\_card\_column\_on\_hold Disable on-hold section in a column **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucketId` | integer | Yes | — | Bucket Id | | `columnId` | integer | Yes | — | Column Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bucketId": { "type": "integer", "description": "Bucket Id" }, "columnId": { "type": "integer", "description": "Column Id" } }, "required": [ "PCID", "bucketId", "columnId" ] } ``` *** ## basecamp\_tasks\_enable\_card\_column\_on\_hold Enable on-hold section in a column **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucketId` | integer | Yes | — | Bucket Id | | `columnId` | integer | Yes | — | Column Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bucketId": { "type": "integer", "description": "Bucket Id" }, "columnId": { "type": "integer", "description": "Column Id" } }, "required": [ "PCID", "bucketId", "columnId" ] } ``` *** ## basecamp\_tasks\_get\_card Get a card by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cardId` | integer | Yes | — | Card Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cardId": { "type": "integer", "description": "Card Id" } }, "required": [ "PCID", "cardId" ] } ``` *** ## basecamp\_tasks\_get\_card\_column Get a card column by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `columnId` | integer | Yes | — | Column Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "columnId": { "type": "integer", "description": "Column Id" } }, "required": [ "PCID", "columnId" ] } ``` *** ## basecamp\_tasks\_get\_card\_step Get a step by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `stepId` | integer | Yes | — | Step Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stepId": { "type": "integer", "description": "Step Id" } }, "required": [ "PCID", "stepId" ] } ``` *** ## basecamp\_tasks\_get\_card\_table Get a card table by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cardTableId` | integer | Yes | — | Card Table Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cardTableId": { "type": "integer", "description": "Card Table Id" } }, "required": [ "PCID", "cardTableId" ] } ``` *** ## basecamp\_tasks\_get\_gauge\_needle Get a gauge needle by ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `needleId` | integer | Yes | — | Needle Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "needleId": { "type": "integer", "description": "Needle Id" } }, "required": [ "PCID", "needleId" ] } ``` *** ## basecamp\_tasks\_get\_hill\_chart Get the hill chart for a todoset **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todosetId` | integer | Yes | — | Todoset Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todosetId": { "type": "integer", "description": "Todoset Id" } }, "required": [ "PCID", "todosetId" ] } ``` *** ## basecamp\_tasks\_get\_project\_timesheet Get timesheet for a specific project **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | integer | Yes | — | Project Id | | `from` | string | No | — | The from value | | `to` | string | No | — | The to value | | `person_id` | integer | No | — | Person Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "integer", "description": "Project Id" }, "from": { "type": "string", "description": "The from value" }, "to": { "type": "string", "description": "The to value" }, "person_id": { "type": "integer", "description": "Person Id" } }, "required": [ "PCID", "projectId" ] } ``` *** ## basecamp\_tasks\_get\_recording\_timesheet Get timesheet for a specific recording **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `recordingId` | integer | Yes | — | Recording Id | | `from` | string | No | — | The from value | | `to` | string | No | — | The to value | | `person_id` | integer | No | — | Person Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "recordingId": { "type": "integer", "description": "Recording Id" }, "from": { "type": "string", "description": "The from value" }, "to": { "type": "string", "description": "The to value" }, "person_id": { "type": "integer", "description": "Person Id" } }, "required": [ "PCID", "recordingId" ] } ``` *** ## basecamp\_tasks\_get\_schedule Get a schedule **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `scheduleId` | integer | Yes | — | Schedule Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "scheduleId": { "type": "integer", "description": "Schedule Id" } }, "required": [ "PCID", "scheduleId" ] } ``` *** ## basecamp\_tasks\_get\_schedule\_entry Get a single schedule entry by id. Note: Recurring entries will redirect (302) to their recordable URL. Use GetScheduleEntryOccurrence for recurring entries instead. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `entryId` | integer | Yes | — | Entry Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entryId": { "type": "integer", "description": "Entry Id" } }, "required": [ "PCID", "entryId" ] } ``` *** ## basecamp\_tasks\_get\_schedule\_entry\_occurrence Get a specific occurrence of a recurring schedule entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `entryId` | integer | Yes | — | Entry Id | | `date` | string | Yes | — | The date value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entryId": { "type": "integer", "description": "Entry Id" }, "date": { "type": "string", "description": "The date value" } }, "required": [ "PCID", "entryId", "date" ] } ``` *** ## basecamp\_tasks\_get\_timesheet\_entry Get a single timesheet entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `entryId` | integer | Yes | — | Entry Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entryId": { "type": "integer", "description": "Entry Id" } }, "required": [ "PCID", "entryId" ] } ``` *** ## basecamp\_tasks\_get\_timesheet\_report Get account-wide timesheet report **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `from` | string | No | — | The from value | | `to` | string | No | — | The to value | | `person_id` | integer | No | — | Person Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "from": { "type": "string", "description": "The from value" }, "to": { "type": "string", "description": "The to value" }, "person_id": { "type": "integer", "description": "Person Id" } }, "required": [ "PCID" ] } ``` *** ## basecamp\_tasks\_get\_todo Get a single todo by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todoId` | integer | Yes | — | Todo Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todoId": { "type": "integer", "description": "Todo Id" } }, "required": [ "PCID", "todoId" ] } ``` *** ## basecamp\_tasks\_get\_todolist\_or\_group Get a single todolist or todolist group by id The endpoint is polymorphic - the same URI returns either a Todolist or TodolistGroup **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## basecamp\_tasks\_get\_todoset Get a todoset (container for todolists in a project) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todosetId` | integer | Yes | — | Todoset Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todosetId": { "type": "integer", "description": "Todoset Id" } }, "required": [ "PCID", "todosetId" ] } ``` *** ## basecamp\_tasks\_list\_cards List cards in a column **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `columnId` | integer | Yes | — | Column Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "columnId": { "type": "integer", "description": "Column Id" } }, "required": [ "PCID", "columnId" ] } ``` *** ## basecamp\_tasks\_list\_gauge\_needles List gauge needles for a project, ordered newest first. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | integer | Yes | — | Project Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "integer", "description": "Project Id" } }, "required": [ "PCID", "projectId" ] } ``` *** ## basecamp\_tasks\_list\_gauges List gauges across all projects the authenticated user has access to. Gauges are sorted by risk level (red, yellow, green), then alphabetically. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucket_ids` | string | No | — | Comma-separated list of project IDs. When provided, results are returned in the order specified instead of by risk level. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bucket_ids": { "type": "string", "description": "Comma-separated list of project IDs. When provided, results are returned in the order specified instead of by risk level." } }, "required": [ "PCID" ] } ``` *** ## basecamp\_tasks\_list\_schedule\_entries List entries on a schedule **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `scheduleId` | integer | Yes | — | Schedule Id | | `status` | string | No | — | active\|archived\|trashed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "scheduleId": { "type": "integer", "description": "Schedule Id" }, "status": { "type": "string", "description": "active|archived|trashed" } }, "required": [ "PCID", "scheduleId" ] } ``` *** ## basecamp\_tasks\_list\_todolist\_groups List groups in a todolist **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todolistId` | integer | Yes | — | Todolist Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todolistId": { "type": "integer", "description": "Todolist Id" } }, "required": [ "PCID", "todolistId" ] } ``` *** ## basecamp\_tasks\_list\_todolists List todolists in a todoset **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todosetId` | integer | Yes | — | Todoset Id | | `status` | string | No | — | active\|archived\|trashed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todosetId": { "type": "integer", "description": "Todoset Id" }, "status": { "type": "string", "description": "active|archived|trashed" } }, "required": [ "PCID", "todosetId" ] } ``` *** ## basecamp\_tasks\_list\_todos List todos in a todolist **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL to fetch additional pages. X-Total-Count header provides total count. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todolistId` | integer | Yes | — | Todolist Id | | `status` | string | No | — | active\|archived\|trashed | | `completed` | boolean | No | — | The completed value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todolistId": { "type": "integer", "description": "Todolist Id" }, "status": { "type": "string", "description": "active|archived|trashed" }, "completed": { "type": "boolean", "description": "The completed value" } }, "required": [ "PCID", "todolistId" ] } ``` *** ## basecamp\_tasks\_move\_card Move a card to a different column **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cardId` | integer | Yes | — | Card Id | | `column_id` | integer | Yes | — | Column Id | | `position` | integer | No | — | 1-indexed position within the destination column. Defaults to 1 (top). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cardId": { "type": "integer", "description": "Card Id" }, "column_id": { "type": "integer", "description": "Column Id" }, "position": { "type": "integer", "description": "1-indexed position within the destination column. Defaults to 1 (top)." } }, "required": [ "PCID", "cardId", "column_id" ] } ``` *** ## basecamp\_tasks\_move\_card\_column Move a column within a card table **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cardTableId` | integer | Yes | — | Card Table Id | | `position` | integer | No | — | The position value | | `source_id` | integer | Yes | — | Source Id | | `target_id` | integer | Yes | — | Target Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cardTableId": { "type": "integer", "description": "Card Table Id" }, "position": { "type": "integer", "description": "The position value" }, "source_id": { "type": "integer", "description": "Source Id" }, "target_id": { "type": "integer", "description": "Target Id" } }, "required": [ "PCID", "cardTableId", "source_id", "target_id" ] } ``` *** ## basecamp\_tasks\_reposition\_card\_step Reposition a step within a card **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cardId` | integer | Yes | — | Card Id | | `position` | integer | Yes | — | 0-indexed position | | `source_id` | integer | Yes | — | Source Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cardId": { "type": "integer", "description": "Card Id" }, "position": { "type": "integer", "description": "0-indexed position" }, "source_id": { "type": "integer", "description": "Source Id" } }, "required": [ "PCID", "cardId", "position", "source_id" ] } ``` *** ## basecamp\_tasks\_reposition\_todo Reposition a todo within its todolist **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todoId` | integer | Yes | — | Todo Id | | `parent_id` | integer | No | — | Optional todolist ID to move the todo to a different parent | | `position` | integer | Yes | — | The position value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todoId": { "type": "integer", "description": "Todo Id" }, "parent_id": { "type": "integer", "description": "Optional todolist ID to move the todo to a different parent" }, "position": { "type": "integer", "description": "The position value" } }, "required": [ "PCID", "todoId", "position" ] } ``` *** ## basecamp\_tasks\_reposition\_todolist\_group Reposition a todolist group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `groupId` | integer | Yes | — | Group Id | | `position` | integer | Yes | — | The position value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "integer", "description": "Group Id" }, "position": { "type": "integer", "description": "The position value" } }, "required": [ "PCID", "groupId", "position" ] } ``` *** ## basecamp\_tasks\_set\_card\_column\_color Set the color of a column **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `bucketId` | integer | Yes | — | Bucket Id | | `columnId` | integer | Yes | — | Column Id | | `color` | string | Yes | — | Valid colors: white, red, orange, yellow, green, blue, aqua, purple, gray, pink, brown | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "bucketId": { "type": "integer", "description": "Bucket Id" }, "columnId": { "type": "integer", "description": "Column Id" }, "color": { "type": "string", "description": "Valid colors: white, red, orange, yellow, green, blue, aqua, purple, gray, pink, brown" } }, "required": [ "PCID", "bucketId", "columnId", "color" ] } ``` *** ## basecamp\_tasks\_set\_card\_step\_completion Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `stepId` | integer | Yes | — | Step Id | | `completion` | string | Yes | — | Set to "on" to complete the step, "" (empty) to uncomplete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stepId": { "type": "integer", "description": "Step Id" }, "completion": { "type": "string", "description": "Set to \"on\" to complete the step, \"\" (empty) to uncomplete" } }, "required": [ "PCID", "stepId", "completion" ] } ``` *** ## basecamp\_tasks\_subscribe\_to\_card\_column Subscribe to a card column (watch for changes) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `columnId` | integer | Yes | — | Column Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "columnId": { "type": "integer", "description": "Column Id" } }, "required": [ "PCID", "columnId" ] } ``` *** ## basecamp\_tasks\_toggle\_gauge Enable or disable the gauge for a project. Only project admins can toggle gauges. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `projectId` | integer | Yes | — | Project Id | | `gauge` | object | Yes | — | The gauge value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectId": { "type": "integer", "description": "Project Id" }, "gauge": { "type": "object", "description": "The gauge value", "properties": { "enabled": { "type": "boolean", "description": "The enabled value" } }, "required": [ "enabled" ] } }, "required": [ "PCID", "projectId", "gauge" ] } ``` *** ## basecamp\_tasks\_trash\_todo Trash a todo (returns 204 No Content) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todoId` | integer | Yes | — | Todo Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todoId": { "type": "integer", "description": "Todo Id" } }, "required": [ "PCID", "todoId" ] } ``` *** ## basecamp\_tasks\_uncomplete\_todo Mark a todo as incomplete **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todoId` | integer | Yes | — | Todo Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todoId": { "type": "integer", "description": "Todo Id" } }, "required": [ "PCID", "todoId" ] } ``` *** ## basecamp\_tasks\_unsubscribe\_from\_card\_column Unsubscribe from a card column (stop watching for changes) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `columnId` | integer | Yes | — | Column Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "columnId": { "type": "integer", "description": "Column Id" } }, "required": [ "PCID", "columnId" ] } ``` *** ## basecamp\_tasks\_update\_card Update an existing card **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cardId` | integer | Yes | — | Card Id | | `assignee_ids` | integer\[] | No | — | Assignee Ids | | `content` | string | No | — | The content value | | `due_on` | string | No | — | Due On | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cardId": { "type": "integer", "description": "Card Id" }, "assignee_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Assignee Ids" }, "content": { "type": "string", "description": "The content value" }, "due_on": { "type": "string", "description": "Due On" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "cardId" ] } ``` *** ## basecamp\_tasks\_update\_card\_column Update an existing column **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `columnId` | integer | Yes | — | Column Id | | `description` | string | No | — | The description value | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "columnId": { "type": "integer", "description": "Column Id" }, "description": { "type": "string", "description": "The description value" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "columnId" ] } ``` *** ## basecamp\_tasks\_update\_card\_step Update an existing step **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `stepId` | integer | Yes | — | Step Id | | `assignee_ids` | integer\[] | No | — | Assignee Ids | | `due_on` | string | No | — | Due On | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stepId": { "type": "integer", "description": "Step Id" }, "assignee_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Assignee Ids" }, "due_on": { "type": "string", "description": "Due On" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "stepId" ] } ``` *** ## basecamp\_tasks\_update\_gauge\_needle Update a gauge needle's description. Position and color are immutable. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `needleId` | integer | Yes | — | Needle Id | | `gauge_needle` | object | No | — | Gauge Needle | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "needleId": { "type": "integer", "description": "Needle Id" }, "gauge_needle": { "type": "object", "description": "Gauge Needle", "properties": { "description": { "type": "string", "description": "Rich text (HTML) description" } } } }, "required": [ "PCID", "needleId" ] } ``` *** ## basecamp\_tasks\_update\_hill\_chart\_settings Track or untrack todolists on a hill chart **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todosetId` | integer | Yes | — | Todoset Id | | `tracked` | integer\[] | No | — | The tracked value | | `untracked` | integer\[] | No | — | The untracked value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todosetId": { "type": "integer", "description": "Todoset Id" }, "tracked": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The tracked value" }, "untracked": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The untracked value" } }, "required": [ "PCID", "todosetId" ] } ``` *** ## basecamp\_tasks\_update\_schedule\_entry Update an existing schedule entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `entryId` | integer | Yes | — | Entry Id | | `all_day` | boolean | No | — | All Day | | `description` | string | No | — | The description value | | `ends_at` | string | No | — | Ends At | | `notify` | boolean | No | — | The notify value | | `participant_ids` | integer\[] | No | — | Participant Ids | | `starts_at` | string | No | — | Starts At | | `summary` | string | No | — | The summary value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entryId": { "type": "integer", "description": "Entry Id" }, "all_day": { "type": "boolean", "description": "All Day" }, "description": { "type": "string", "description": "The description value" }, "ends_at": { "type": "string", "description": "Ends At" }, "notify": { "type": "boolean", "description": "The notify value" }, "participant_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Participant Ids" }, "starts_at": { "type": "string", "description": "Starts At" }, "summary": { "type": "string", "description": "The summary value" } }, "required": [ "PCID", "entryId" ] } ``` *** ## basecamp\_tasks\_update\_schedule\_settings Update schedule settings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `scheduleId` | integer | Yes | — | Schedule Id | | `include_due_assignments` | boolean | Yes | — | Include Due Assignments | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "scheduleId": { "type": "integer", "description": "Schedule Id" }, "include_due_assignments": { "type": "boolean", "description": "Include Due Assignments" } }, "required": [ "PCID", "scheduleId", "include_due_assignments" ] } ``` *** ## basecamp\_tasks\_update\_timesheet\_entry Update a timesheet entry **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `entryId` | integer | Yes | — | Entry Id | | `date` | string | No | — | The date value | | `description` | string | No | — | The description value | | `hours` | string | No | — | The hours value | | `person_id` | integer | No | — | Person Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entryId": { "type": "integer", "description": "Entry Id" }, "date": { "type": "string", "description": "The date value" }, "description": { "type": "string", "description": "The description value" }, "hours": { "type": "string", "description": "The hours value" }, "person_id": { "type": "integer", "description": "Person Id" } }, "required": [ "PCID", "entryId" ] } ``` *** ## basecamp\_tasks\_update\_todo Update an existing todo **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `todoId` | integer | Yes | — | Todo Id | | `assignee_ids` | integer\[] | No | — | Assignee Ids | | `completion_subscriber_ids` | integer\[] | No | — | Completion Subscriber Ids | | `content` | string | No | — | The content value | | `description` | string | No | — | The description value | | `due_on` | string | No | — | Due On | | `notify` | boolean | No | — | The notify value | | `starts_on` | string | No | — | Starts On | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "todoId": { "type": "integer", "description": "Todo Id" }, "assignee_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Assignee Ids" }, "completion_subscriber_ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Completion Subscriber Ids" }, "content": { "type": "string", "description": "The content value" }, "description": { "type": "string", "description": "The description value" }, "due_on": { "type": "string", "description": "Due On" }, "notify": { "type": "boolean", "description": "The notify value" }, "starts_on": { "type": "string", "description": "Starts On" } }, "required": [ "PCID", "todoId" ] } ``` *** ## basecamp\_tasks\_update\_todolist\_or\_group Update an existing todolist or todolist group The endpoint is polymorphic - updates either a Todolist or TodolistGroup **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | The id value | | `description` | string | No | — | Description (Todolist only, ignored for groups) | | `name` | string | No | — | Name (required for both Todolist and TodolistGroup) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" }, "description": { "type": "string", "description": "Description (Todolist only, ignored for groups)" }, "name": { "type": "string", "description": "Name (required for both Todolist and TodolistGroup)" } }, "required": [ "PCID", "id" ] } ``` # benzinga Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/benzinga Benzinga — Financial news, market data, fundamentals, calendar events, and reference data **PinkConnect service:** `benzinga` | **Type:** Application (parent with child servers) | **PCID required:** Yes benzinga is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [benzinga-calendar](/api-reference/mcp-servers/application/benzinga/benzinga-calendar) | `/benzinga-calendar` | 16 | Benzinga Calendar | | [benzinga-fundamentals](/api-reference/mcp-servers/application/benzinga/benzinga-fundamentals) | `/benzinga-fundamentals` | 23 | Benzinga Fundamentals | | [benzinga-market-data](/api-reference/mcp-servers/application/benzinga/benzinga-market-data) | `/benzinga-market-data` | 7 | Benzinga Market Data | | [benzinga-news](/api-reference/mcp-servers/application/benzinga/benzinga-news) | `/benzinga-news` | 7 | Benzinga News | | [benzinga-reference](/api-reference/mcp-servers/application/benzinga/benzinga-reference) | `/benzinga-reference` | 6 | Benzinga Reference | # benzinga-calendar Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/benzinga/benzinga-calendar Benzinga Calendar **Server path:** `/benzinga-calendar` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`benzinga_calendar_get_conference_calls`](#benzinga_calendar_get_conference_calls) | Returns Conference call data | | [`benzinga_calendar_get_consensus_ratings`](#benzinga_calendar_get_consensus_ratings) | Returns analyst ratings data] | | [`benzinga_calendar_get_dividends`](#benzinga_calendar_get_dividends) | Dividends Events | | [`benzinga_calendar_get_dividends_1`](#benzinga_calendar_get_dividends_1) | Dividends Events | | [`benzinga_calendar_get_earnings`](#benzinga_calendar_get_earnings) | Returns the earnings data | | [`benzinga_calendar_get_economics`](#benzinga_calendar_get_economics) | Returns the economic calendar data | | [`benzinga_calendar_get_fda`](#benzinga_calendar_get_fda) | FDA approvals, clinical trials, and PDUFA dates | | [`benzinga_calendar_get_guidance`](#benzinga_calendar_get_guidance) | Returns guidance data | | [`benzinga_calendar_get_ipos`](#benzinga_calendar_get_ipos) | Returns ipo data | | [`benzinga_calendar_get_ma`](#benzinga_calendar_get_ma) | Returns the mergers and acquisitions data | | [`benzinga_calendar_get_offerings`](#benzinga_calendar_get_offerings) | Returns Secondary Offering data | | [`benzinga_calendar_get_ratings`](#benzinga_calendar_get_ratings) | Returns analyst ratings data | | [`benzinga_calendar_get_ratings_analysts`](#benzinga_calendar_get_ratings_analysts) | Returns the full list of analysts that are providing ratings. | | [`benzinga_calendar_get_ratings_firms`](#benzinga_calendar_get_ratings_firms) | Returns the available firms providing analyst ratings | | [`benzinga_calendar_get_removed`](#benzinga_calendar_get_removed) | Returns the removed calendar data | | [`benzinga_calendar_get_splits`](#benzinga_calendar_get_splits) | Returns the splits calendar data | *** ## benzinga\_calendar\_get\_conference\_calls Returns Conference call data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified. | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified." }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_consensus\_ratings Returns analyst ratings data] **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[tickers]` | string | No | — | One ticker symbol to query the aggregate for. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 1 ticker. | | `simplify` | boolean | No | — | To simplify the aggregate ratings to only BUY, SELL, HOLD, default will return all ratings (STRONG\_BUY, BUY, HOLD, SELL, STRONG\_SELL). | | `aggregate_type` | string | No | — | To aggregate the ratings by either number or percentage. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[tickers]": { "type": "string", "description": "One ticker symbol to query the aggregate for. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 1 ticker." }, "simplify": { "type": "boolean", "description": "To simplify the aggregate ratings to only BUY, SELL, HOLD, default will return all ratings (STRONG_BUY, BUY, HOLD, SELL, STRONG_SELL)." }, "aggregate_type": { "type": "string", "description": "To aggregate the ratings by either number or percentage.", "enum": [ "number", "percentage" ] } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_dividends Dividends Events **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified. | | `parameters[importance]` | integer | No | — | The importance level to filter by. Uses Greater Than or Equal To the importance indicated | | `parameters[date_sort]` | string | No | — | Dividend date field to sort on (newest to oldest) | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | | `parameters[dividend_yield_operation]` | string | No | — | Specifies how to filter using dividend yield. gt = Greater Than, gte = Greater Than Equal, eq = Equal, lt = Less Than, lte = Less Than Equal | | `parameters[dividend_yield]` | number | No | — | The dividend yield amount to filter by. Defaults to using Equal To the amount indicated. 1 =100%eater Than or Equal To’, ‘Equal To’, ‘Less Than or Equal To’, and ‘Less Than’ filters respectively. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified." }, "parameters[importance]": { "type": "integer", "description": "The importance level to filter by. Uses Greater Than or Equal To the importance indicated", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "parameters[date_sort]": { "type": "string", "description": "Dividend date field to sort on (newest to oldest)", "enum": [ "announced", "ex", "payable", "record" ] }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." }, "parameters[dividend_yield_operation]": { "type": "string", "description": "Specifies how to filter using dividend yield. gt = Greater Than, gte = Greater Than Equal, eq = Equal, lt = Less Than, lte = Less Than Equal", "enum": [ "gt", "gte", "eq", "lte", "lt" ] }, "parameters[dividend_yield]": { "type": "number", "description": "The dividend yield amount to filter by. Defaults to using Equal To the amount indicated. 1 =100%eater Than or Equal To’, ‘Equal To’, ‘Less Than or Equal To’, and ‘Less Than’ filters respectively." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_dividends\_1 Dividends Events **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified. | | `parameters[importance]` | integer | No | — | The importance level to filter by. Uses Greater Than or Equal To the importance indicated | | `parameters[date_sort]` | string | No | — | Dividend date field to sort on (newest to oldest) | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | | `parameters[dividend_yield_operation]` | string | No | — | Specifies how to filter using dividend yield. gt = Greater Than, gte = Greater Than Equal, eq = Equal, lt = Less Than, lte = Less Than Equal | | `parameters[dividend_yield]` | number | No | — | The dividend yield amount to filter by. Defaults to using Equal To the amount indicated. 1 =100%eater Than or Equal To’, ‘Equal To’, ‘Less Than or Equal To’, and ‘Less Than’ filters respectively. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified." }, "parameters[importance]": { "type": "integer", "description": "The importance level to filter by. Uses Greater Than or Equal To the importance indicated", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "parameters[date_sort]": { "type": "string", "description": "Dividend date field to sort on (newest to oldest)", "enum": [ "announced", "ex", "payable", "record" ] }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." }, "parameters[dividend_yield_operation]": { "type": "string", "description": "Specifies how to filter using dividend yield. gt = Greater Than, gte = Greater Than Equal, eq = Equal, lt = Less Than, lte = Less Than Equal", "enum": [ "gt", "gte", "eq", "lte", "lt" ] }, "parameters[dividend_yield]": { "type": "number", "description": "The dividend yield amount to filter by. Defaults to using Equal To the amount indicated. 1 =100%eater Than or Equal To’, ‘Equal To’, ‘Less Than or Equal To’, and ‘Less Than’ filters respectively." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_earnings Returns the earnings data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[date_sort]` | string | No | — | Field sort option for earnings calendar. Apply `:desc`, `:asc` for sort order. | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified. | | `parameters[importance]` | integer | No | — | The importance level to filter by. Uses Greater Than or Equal To the importance indicated | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[date_sort]": { "type": "string", "description": "Field sort option for earnings calendar. Apply `:desc`, `:asc` for sort order.", "enum": [ "date" ] }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified." }, "parameters[importance]": { "type": "integer", "description": "The importance level to filter by. Uses Greater Than or Equal To the importance indicated", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_economics Returns the economic calendar data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[importance]` | integer | No | — | The importance level to filter by. Uses Greater Than or Equal To the importance indicated | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | | `country` | string | No | — | 3-Digit Country Code | | `event_category` | string | No | — | One or more categories separated by a comma. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[importance]": { "type": "integer", "description": "The importance level to filter by. Uses Greater Than or Equal To the importance indicated", "enum": [ 1, 2, 3 ] }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." }, "country": { "type": "string", "description": "3-Digit Country Code" }, "event_category": { "type": "string", "description": "One or more categories separated by a comma." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_fda FDA approvals, clinical trials, and PDUFA dates **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[date_search_field]` | string | No | — | Date to filter and sort calendar by. Default is `announced`. | | `parameters[date_search_strict]` | boolean | No | — | Some date fields (such as the FDA calendar target date) include fuzzy dates such as 2021-Q1. When filtering, you may choose to allow fuzzy date matching, or strict date matching that searches for ONLY dates that have an exact match within the given date period. Default `TRUE`. | | `parameters[securities]` | string | No | — | One or more security identifiers separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities. | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[date_search_field]": { "type": "string", "description": "Date to filter and sort calendar by. Default is `announced`.", "enum": [ "announced", "target" ] }, "parameters[date_search_strict]": { "type": "boolean", "description": "Some date fields (such as the FDA calendar target date) include fuzzy dates such as 2021-Q1. When filtering, you may choose to allow fuzzy date matching, or strict date matching that searches for ONLY dates that have an exact match within the given date period. Default `TRUE`." }, "parameters[securities]": { "type": "string", "description": "One or more security identifiers separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities." }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_guidance Returns guidance data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified. | | `parameters[importance]` | integer | No | — | The importance level to filter by. Uses Greater Than or Equal To the importance indicated | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | | `parameters[is_primary]` | string | No | — | Determines if guidance returned is primary, secondary or all. Default set to Y. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified." }, "parameters[importance]": { "type": "integer", "description": "The importance level to filter by. Uses Greater Than or Equal To the importance indicated", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." }, "parameters[is_primary]": { "type": "string", "description": "Determines if guidance returned is primary, secondary or all. Default set to Y.", "enum": [ "Y", "N", "All" ] } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_ipos Returns ipo data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[ipo_type]` | string | No | — | One or more IPO types separated by a comma. Example: Ordinary Shares,SPAC | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified. | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[ipo_type]": { "type": "string", "description": "One or more IPO types separated by a comma. Example: Ordinary Shares,SPAC" }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified." }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_ma Returns the mergers and acquisitions data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified. | | `parameters[importance]` | integer | No | — | The importance level to filter by. Uses Greater Than or Equal To the importance indicated | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | | `parameters[date_sort]` | string | No | — | M\&A date field to sort on (newest to oldest for expected and completed; oldest to newest for announced) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified." }, "parameters[importance]": { "type": "integer", "description": "The importance level to filter by. Uses Greater Than or Equal To the importance indicated", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." }, "parameters[date_sort]": { "type": "string", "description": "M&A date field to sort on (newest to oldest for expected and completed; oldest to newest for announced)", "enum": [ "expected", "completed", "announced" ] } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_offerings Returns Secondary Offering data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified. | | `parameters[importance]` | integer | No | — | The importance level to filter by. Uses Greater Than or Equal To the importance indicated | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified." }, "parameters[importance]": { "type": "integer", "description": "The importance level to filter by. Uses Greater Than or Equal To the importance indicated", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_ratings Returns analyst ratings data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | Available fields: - id - date - time - ticker - exchange - name - currency - action\_pt - action\_company - rating\_current - pt\_current - rating\_prior - pt\_prior - pt\_pct\_change - url - url\_calendar - url\_news - analyst - analyst\_id - analyst\_name - ratings\_accuracy - importance - notes - updated Default fields: - id - date - time - ticker - exchange - name - currency - action\_pt - action\_company - rating\_current - pt\_current - rating\_prior - pt\_prior - url - url\_calendar - url\_news - analyst - analyst\_name - importance - notes - updated | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified. | | `parameters[importance]` | integer | No | — | The importance level to filter by. Uses Greater Than or Equal To the importance indicated | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | | `parameters[action]` | string | No | — | Filter by a specific action\_company (action for rating). Note that all of these terms are precisely defined. | | `parameters[analyst_id]` | string | No | — | One or more analyst ids (analyst\_id) separated by a comma. | | `parameters[firm_id]` | string | No | — | One or more firm ids (firm\_id) separated by a comma. | | `analyst` | string | No | — | A comma separated list of analyst (person) ID's to bring back. Omitting will bring back all available analysts. | | `firm` | string | No | — | A comma separated list of analyst firm ID's to bring back. Omitting will bring back all available firms. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "Available fields: - id - date - time - ticker - exchange - name - currency - action_pt - action_company - rating_current - pt_current - rating_prior - pt_prior - pt_pct_change - url - url_calendar - url_news - analyst - analyst_id - analyst_name - ratings_accuracy - importance - notes - updated Default fields: - id - date - time - ticker - exchange - name - currency - action_pt - action_company - rating_current - pt_current - rating_prior - pt_prior - url - url_calendar - url_news - analyst - analyst_name - importance - notes - updated" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified." }, "parameters[importance]": { "type": "integer", "description": "The importance level to filter by. Uses Greater Than or Equal To the importance indicated", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." }, "parameters[action]": { "type": "string", "description": "Filter by a specific action_company (action for rating). Note that all of these terms are precisely defined.", "enum": [ "Downgrades", "Maintains", "Reinstates", "Reiterates", "Upgrades", "Assumes", "Initiates Coverage On", "Terminates Coverage On", "Removes", "Suspends", "Firm Dissolved" ] }, "parameters[analyst_id]": { "type": "string", "description": "One or more analyst ids (analyst_id) separated by a comma." }, "parameters[firm_id]": { "type": "string", "description": "One or more firm ids (firm_id) separated by a comma." }, "analyst": { "type": "string", "description": "A comma separated list of analyst (person) ID's to bring back. Omitting will bring back all available analysts." }, "firm": { "type": "string", "description": "A comma separated list of analyst firm ID's to bring back. Omitting will bring back all available firms." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_ratings\_analysts Returns the full list of analysts that are providing ratings. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | Default fields: - id - name\_first - name\_last - name\_full - firm\_id - firm\_name - ratings\_accuracy - updated | | `analyst` | string | No | — | A comma separated list of analyst (person) ID's to bring back. Omitting will bring back all available analysts. | | `firm` | string | No | — | A comma separated list of analyst firm ID's to bring back. Omitting will bring back all available firms. | | `firm_name` | string | No | — | A comma separated list of analyst firm names to bring back. Omitting will bring back all available firms. | | `analyst_name` | string | No | — | A comma separated list of analyst names to bring back. Omitting will bring back all available analysts. | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pageSize` | integer | No | — | Number of results returned. Limit 1000. Default 50. | | `updated` | integer | No | — | Records removed after Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "Default fields: - id - name_first - name_last - name_full - firm_id - firm_name - ratings_accuracy - updated" }, "analyst": { "type": "string", "description": "A comma separated list of analyst (person) ID's to bring back. Omitting will bring back all available analysts." }, "firm": { "type": "string", "description": "A comma separated list of analyst firm ID's to bring back. Omitting will bring back all available firms." }, "firm_name": { "type": "string", "description": "A comma separated list of analyst firm names to bring back. Omitting will bring back all available firms." }, "analyst_name": { "type": "string", "description": "A comma separated list of analyst names to bring back. Omitting will bring back all available analysts." }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pageSize": { "type": "integer", "description": "Number of results returned. Limit 1000. Default 50." }, "updated": { "type": "integer", "description": "Records removed after Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_ratings\_firms Returns the available firms providing analyst ratings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | Available fields: - id - name - currency - homepage - updated Default fields: - id - name | | `firm` | string | No | — | A comma separated list of analyst firm ID's to bring back. Omitting will bring back all available firms. | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pageSize` | integer | No | — | Number of results returned. Limit 1000. Default 50. | | `updated` | integer | No | — | Records removed after Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "Available fields: - id - name - currency - homepage - updated Default fields: - id - name" }, "firm": { "type": "string", "description": "A comma separated list of analyst firm ID's to bring back. Omitting will bring back all available firms." }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pageSize": { "type": "integer", "description": "Number of results returned. Limit 1000. Default 50." }, "updated": { "type": "integer", "description": "Records removed after Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_removed Returns the removed calendar data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pageSize` | integer | No | — | Number of results returned. Limit 1000. Default 50. | | `type` | string | No | — | Calendar type | | `updated` | integer | No | — | Records removed after Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pageSize": { "type": "integer", "description": "Number of results returned. Limit 1000. Default 50." }, "type": { "type": "string", "description": "Calendar type", "enum": [ "ratings", "earnings", "guidance", "ipos", "offerings", "economics", "ma", "splits", "dividends", "conference calls" ] }, "updated": { "type": "integer", "description": "Records removed after Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_calendar\_get\_splits Returns the splits calendar data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for calendar data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[date_search_field]` | string | No | — | Date to filter and sort calendar by. Default is `announced`. | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified. | | `parameters[importance]` | integer | No | — | The importance level to filter by. Uses Greater Than or Equal To the importance indicated | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for calendar data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[date_search_field]": { "type": "string", "description": "Date to filter and sort calendar by. Default is `announced`.", "enum": [ "announced", "ex" ] }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 50 tickers. Note that for the IPOs endpoint, new tickers may not return results right away as we do not automatically link them to the underlying company's data. Thus, to obtain the most recent rows from the IPOs endpoint, send queries without this parameter specified." }, "parameters[importance]": { "type": "integer", "description": "The importance level to filter by. Uses Greater Than or Equal To the importance indicated", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID" ] } ``` # benzinga-fundamentals Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/benzinga/benzinga-fundamentals Benzinga Fundamentals **Server path:** `/benzinga-fundamentals` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`benzinga_fundamentals_get_1`](#benzinga_fundamentals_get_1) | Get valuation ratios, earning ratios, operation ratios, balance sheet | | [`benzinga_fundamentals_get_2`](#benzinga_fundamentals_get_2) | Fundamental data | | [`benzinga_fundamentals_get_alpha_beta`](#benzinga_fundamentals_get_alpha_beta) | Get an alpha-beta result for the company. | | [`benzinga_fundamentals_get_asset_classification`](#benzinga_fundamentals_get_asset_classification) | Get share class profile history with market cap and enterprise value. | | [`benzinga_fundamentals_get_balance_sheet`](#benzinga_fundamentals_get_balance_sheet) | Balance sheet | | [`benzinga_fundamentals_get_cash_flow`](#benzinga_fundamentals_get_cash_flow) | Cashflow | | [`benzinga_fundamentals_get_company`](#benzinga_fundamentals_get_company) | Get basic company information. | | [`benzinga_fundamentals_get_company_profile`](#benzinga_fundamentals_get_company_profile) | Get company meta-data. | | [`benzinga_fundamentals_get_derived`](#benzinga_fundamentals_get_derived) | Derived figures & ratios | | [`benzinga_fundamentals_get_earning_ratios`](#benzinga_fundamentals_get_earning_ratios) | Returns the earning ratios. | | [`benzinga_fundamentals_get_earning_ratios_1`](#benzinga_fundamentals_get_earning_ratios_1) | Returns the earning ratios | | [`benzinga_fundamentals_get_earning_reports`](#benzinga_fundamentals_get_earning_reports) | Get detailed earning reports for company. | | [`benzinga_fundamentals_get_financials`](#benzinga_fundamentals_get_financials) | Get the balance sheet and cash-flow statement for a company. | | [`benzinga_fundamentals_get_financials_1`](#benzinga_fundamentals_get_financials_1) | Get the balance sheet and cashflow statement for a company. Although symbols, and cik are technically optional, if no parameters are included with the response, the result will be empty | | [`benzinga_fundamentals_get_fundamentals`](#benzinga_fundamentals_get_fundamentals) | Get all of fundamentals data such as valuation ratios, earning ratios, operation ratios, balance sheet, share class, alpha beta and asset classification. | | [`benzinga_fundamentals_get_income_statement`](#benzinga_fundamentals_get_income_statement) | Income statement | | [`benzinga_fundamentals_get_operation_ratios`](#benzinga_fundamentals_get_operation_ratios) | Returns the operation ratios. | | [`benzinga_fundamentals_get_operation_ratios_1`](#benzinga_fundamentals_get_operation_ratios_1) | Returns the operation ratios | | [`benzinga_fundamentals_get_share_class`](#benzinga_fundamentals_get_share_class) | Get share class meta data for company. | | [`benzinga_fundamentals_get_share_class_profile`](#benzinga_fundamentals_get_share_class_profile) | Get share class profile history with market cap and enterprise value. | | [`benzinga_fundamentals_get_share_price_ratios`](#benzinga_fundamentals_get_share_price_ratios) | Share price ratios | | [`benzinga_fundamentals_get_valuation_ratios`](#benzinga_fundamentals_get_valuation_ratios) | Returns the valuation ratios. | | [`benzinga_fundamentals_get_valuation_ratios_1`](#benzinga_fundamentals_get_valuation_ratios_1) | Returns the valuation ratios | *** ## benzinga\_fundamentals\_get\_1 Get valuation ratios, earning ratios, operation ratios, balance sheet **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_2 Fundamental data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return. (Max. 5) | | `date` | string | No | — | Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`. | | `from` | string | No | — | Date to query from point in time. | | `to` | string | No | — | Date to query to point in time. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return. (Max. 5)" }, "date": { "type": "string", "description": "Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`." }, "from": { "type": "string", "description": "Date to query from point in time." }, "to": { "type": "string", "description": "Date to query to point in time." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_alpha\_beta Get an alpha-beta result for the company. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_asset\_classification Get share class profile history with market cap and enterprise value. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_balance\_sheet Balance sheet **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return. | | `date` | string | No | — | Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`. | | `from` | string | No | — | Date to query from point in time. | | `to` | string | No | — | Date to query to point in time. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return." }, "date": { "type": "string", "description": "Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`." }, "from": { "type": "string", "description": "Date to query from point in time." }, "to": { "type": "string", "description": "Date to query to point in time." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_cash\_flow Cashflow **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return. | | `date` | string | No | — | Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`. | | `from` | string | No | — | Date to query from point in time. | | `to` | string | No | — | Date to query to point in time. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return." }, "date": { "type": "string", "description": "Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`." }, "from": { "type": "string", "description": "Date to query from point in time." }, "to": { "type": "string", "description": "Date to query to point in time." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_company Get basic company information. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_company\_profile Get company meta-data. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_derived Derived figures & ratios **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return. | | `date` | string | No | — | Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`. | | `from` | string | No | — | Date to query from point in time. | | `to` | string | No | — | Date to query to point in time. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return." }, "date": { "type": "string", "description": "Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`." }, "from": { "type": "string", "description": "Date to query from point in time." }, "to": { "type": "string", "description": "Date to query to point in time." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_earning\_ratios Returns the earning ratios. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_earning\_ratios\_1 Returns the earning ratios **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_earning\_reports Get detailed earning reports for company. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_financials Get the balance sheet and cash-flow statement for a company. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `period` | string | No | — | Specifies the time period of the returned results | | `reportType` | string | No | — | TTM, A (as originally reported), R (restated). P (Preliminary anouncements) | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "period": { "type": "string", "description": "Specifies the time period of the returned results", "enum": [ "3M", "6M", "9M", "12M", "1Y", "ALL", "TTM" ] }, "reportType": { "type": "string", "description": "TTM, A (as originally reported), R (restated). P (Preliminary anouncements)", "enum": [ "TTM", "A", "R", "P" ] }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_financials\_1 Get the balance sheet and cashflow statement for a company. Although symbols, and cik are technically optional, if no parameters are included with the response, the result will be empty **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `period` | string | No | — | Specifies the time period of the returned results | | `reportType` | string | No | — | TTM, A (as originally reported), R (restated). P (Preliminary anouncements) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "period": { "type": "string", "description": "Specifies the time period of the returned results", "enum": [ "3M", "6M", "9M", "12M", "1Y", "ALL", "TTM" ] }, "reportType": { "type": "string", "description": "TTM, A (as originally reported), R (restated). P (Preliminary anouncements)", "enum": [ "TTM", "A", "R", "P" ] } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_fundamentals Get all of fundamentals data such as valuation ratios, earning ratios, operation ratios, balance sheet, share class, alpha beta and asset classification. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return. A max of 200 symbols per request is supported. | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return. A max of 200 symbols per request is supported." }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_income\_statement Income statement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return. | | `date` | string | No | — | Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`. | | `from` | string | No | — | Date to query from point in time. | | `to` | string | No | — | Date to query to point in time. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return." }, "date": { "type": "string", "description": "Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`." }, "from": { "type": "string", "description": "Date to query from point in time." }, "to": { "type": "string", "description": "Date to query to point in time." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_operation\_ratios Returns the operation ratios. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_operation\_ratios\_1 Returns the operation ratios **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_share\_class Get share class meta data for company. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_share\_class\_profile Get share class profile history with market cap and enterprise value. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_share\_price\_ratios Share price ratios **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return. | | `date` | string | No | — | Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`. | | `from` | string | No | — | Date to query from point in time. | | `to` | string | No | — | Date to query to point in time. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return." }, "date": { "type": "string", "description": "Returns the most recent results for dates less than or equal to the date specified in this parameter. Use `latest` to retrieve the most recent results. The default setting is `latest`." }, "from": { "type": "string", "description": "Date to query from point in time." }, "to": { "type": "string", "description": "Date to query to point in time." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_valuation\_ratios Returns the valuation ratios. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_fundamentals\_get\_valuation\_ratios\_1 Returns the valuation ratios **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more stock ticker symbol in comma separated list specifies company data to return | | `cik` | string | No | — | One or more cik identifier in comma separated list specifies company data to return | | `asOf` | string | No | — | Return results for dates greater than or equal date specified in this parameter | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more stock ticker symbol in comma separated list specifies company data to return" }, "cik": { "type": "string", "description": "One or more cik identifier in comma separated list specifies company data to return" }, "asOf": { "type": "string", "description": "Return results for dates greater than or equal date specified in this parameter" } }, "required": [ "PCID" ] } ``` # benzinga-market-data Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/benzinga/benzinga-market-data Benzinga Market Data **Server path:** `/benzinga-market-data` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`benzinga_market_data_get_bars`](#benzinga_market_data_get_bars) | Get the delayed quotes. | | [`benzinga_market_data_get_movers`](#benzinga_market_data_get_movers) | Returns market movers | | [`benzinga_market_data_get_quote_delayed`](#benzinga_market_data_get_quote_delayed) | Get the delayed quotes. | | [`benzinga_market_data_get_quote_delayed_1`](#benzinga_market_data_get_quote_delayed_1) | Get the delayed quotes. | | [`benzinga_market_data_get_shortinterest`](#benzinga_market_data_get_shortinterest) | Get short interest data | | [`benzinga_market_data_get_trending_tickers`](#benzinga_market_data_get_trending_tickers) | Get per-ticker trend metrics (time buckets) | | [`benzinga_market_data_get_trending_tickers_list`](#benzinga_market_data_get_trending_tickers_list) | Get trending tickers (aggregated list) | *** ## benzinga\_market\_data\_get\_bars Get the delayed quotes. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more comma separated symbols to specify companies to get data for. | | `from` | string | No | — | Date to query from point in time. Sorted by published date. If "YTD" Sets from to the first trading day of the current year. Some other valid values: "1MONTH", "1m", "1M" (all meaning "1 month from today"), "1d", "1D" (both meaning "1 day from today"). | | `to` | string | No | — | Date to query to point in time. Sorted by published date. | | `interval` | string | No | — | The candle intervals to use, i.e., 5 minute bars, daily bars, etc. Some valid values: 1MONTH, 1W, 1D, 1H (1 hour), 2H, 3H, 4H, 5M (5 minutes), 10M, 15M, 30M. Defaults to an appropriate value based on the period of data requested: i.e., 5 minutes bars if less than 5 days, daily bars if greater. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more comma separated symbols to specify companies to get data for." }, "from": { "type": "string", "description": "Date to query from point in time. Sorted by published date. If \"YTD\" Sets from to the first trading day of the current year. Some other valid values: \"1MONTH\", \"1m\", \"1M\" (all meaning \"1 month from today\"), \"1d\", \"1D\" (both meaning \"1 day from today\")." }, "to": { "type": "string", "description": "Date to query to point in time. Sorted by published date." }, "interval": { "type": "string", "description": "The candle intervals to use, i.e., 5 minute bars, daily bars, etc. Some valid values: 1MONTH, 1W, 1D, 1H (1 hour), 2H, 3H, 4H, 5M (5 minutes), 10M, 15M, 30M. Defaults to an appropriate value based on the period of data requested: i.e., 5 minutes bars if less than 5 days, daily bars if greater." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_market\_data\_get\_movers Returns market movers **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `maxResults` | integer | No | — | Max numbers of gainers/losers to return. Limit 1000. | | `from` | string | No | — | From session or timestamp. \* yyyy-mm-dd \* yyyy-mm-ddThh:mm:ii:ss \* 1d, -1w, -1y, YTD | | `to` | string | No | — | To session or timestamp. \* yyyy-mm-dd \* yyyy-mm-ddThh:mm:ii:ss | | `session` | string | No | — | The market session to report for. PRE\_MARKET and AFTER\_MARKET will return movers only for the one session. Multi-day movers always use official regular session closing prices. REGULAR is default. | | `screenerQuery` | string | No | — | Filters movers by screener query. A screener query is a list of conditions separated by a semicolon. Some examples \* marketcap\_gt\_1b \* close\_gt\_5 \* sector\_in\_technology,healthcare \* marketcap\_gt\_300m;marketcap\_lt\_2b | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "maxResults": { "type": "integer", "description": "Max numbers of gainers/losers to return. Limit 1000." }, "from": { "type": "string", "description": "From session or timestamp. * yyyy-mm-dd * yyyy-mm-ddThh:mm:ii:ss * 1d, -1w, -1y, YTD" }, "to": { "type": "string", "description": "To session or timestamp. * yyyy-mm-dd * yyyy-mm-ddThh:mm:ii:ss" }, "session": { "type": "string", "description": "The market session to report for. PRE_MARKET and AFTER_MARKET will return movers only for the one session. Multi-day movers always use official regular session closing prices. REGULAR is default.", "enum": [ "REGULAR", "PRE_MARKET", "AFTER_MARKET" ] }, "screenerQuery": { "type": "string", "description": "Filters movers by screener query. A screener query is a list of conditions separated by a semicolon. Some examples * marketcap_gt_1b * close_gt_5 * sector_in_technology,healthcare * marketcap_gt_300m;marketcap_lt_2b" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_market\_data\_get\_quote\_delayed Get the delayed quotes. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | No | — | One or more comma separated symbols to specify companies to get data for. | | `isin` | string | No | — | One or more comma separated isin symbols to specify companies to get data for. | | `cik` | string | No | — | One or more comma separated cik identifiers to specify companies to get data for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more comma separated symbols to specify companies to get data for." }, "isin": { "type": "string", "description": "One or more comma separated isin symbols to specify companies to get data for." }, "cik": { "type": "string", "description": "One or more comma separated cik identifiers to specify companies to get data for." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_market\_data\_get\_quote\_delayed\_1 Get the delayed quotes. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | Yes | — | One or more comma separated symbols to specify companies to get data for. | | `isin` | string | No | — | One or more comma separated isin symbols to specify companies to get data for. | | `cik` | string | No | — | One or more comma separated cik identifiers to specify companies to get data for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more comma separated symbols to specify companies to get data for." }, "isin": { "type": "string", "description": "One or more comma separated isin symbols to specify companies to get data for." }, "cik": { "type": "string", "description": "One or more comma separated cik identifiers to specify companies to get data for." } }, "required": [ "PCID", "symbols" ] } ``` *** ## benzinga\_market\_data\_get\_shortinterest Get short interest data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | Yes | — | One or more comma-separated ticker symbols (e.g., TSLA,AAPL) | | `finraReport` | boolean | No | — | If true, includes additional FINRA-related short interest data. | | `page` | integer | No | — | Page number for paginated results (starts from 0). | | `pageSize` | integer | No | — | Number of results per page. | | `from` | string | No | — | The start date for querying short interest data (format: YYYY-MM-DD). | | `to` | string | No | — | The end date for querying short interest data (format: YYYY-MM-DD). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "One or more comma-separated ticker symbols (e.g., TSLA,AAPL)" }, "finraReport": { "type": "boolean", "description": "If true, includes additional FINRA-related short interest data." }, "page": { "type": "integer", "description": "Page number for paginated results (starts from 0)." }, "pageSize": { "type": "integer", "description": "Number of results per page." }, "from": { "type": "string", "description": "The start date for querying short interest data (format: YYYY-MM-DD)." }, "to": { "type": "string", "description": "The end date for querying short interest data (format: YYYY-MM-DD)." } }, "required": [ "PCID", "symbols" ] } ``` *** ## benzinga\_market\_data\_get\_trending\_tickers Get per-ticker trend metrics (time buckets) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `interval` | string | No | — | Time-bucket interval for metrics. | | `tickers` | string | Yes | — | Comma-separated list of tickers. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "interval": { "type": "string", "description": "Time-bucket interval for metrics.", "enum": [ "10m", "1h", "1d" ] }, "tickers": { "type": "string", "description": "Comma-separated list of tickers." } }, "required": [ "PCID", "tickers" ] } ``` *** ## benzinga\_market\_data\_get\_trending\_tickers\_list Get trending tickers (aggregated list) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `timeframe` | string | No | — | Aggregation window for trends. | | `date_from` | string | No | — | Start date (inclusive) in ISO 8601 format YYYY-MM-DD. | | `date_to` | string | No | — | End date (inclusive) in ISO 8601 format YYYY-MM-DD. | | `time_from` | string | No | — | Start time (24-hour) in HH:MM. | | `time_to` | string | No | — | End time (24-hour) in HH:MM. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "timeframe": { "type": "string", "description": "Aggregation window for trends.", "enum": [ "10m", "1h", "1d" ] }, "date_from": { "type": "string", "description": "Start date (inclusive) in ISO 8601 format YYYY-MM-DD." }, "date_to": { "type": "string", "description": "End date (inclusive) in ISO 8601 format YYYY-MM-DD." }, "time_from": { "type": "string", "description": "Start time (24-hour) in HH:MM." }, "time_to": { "type": "string", "description": "End time (24-hour) in HH:MM." } }, "required": [ "PCID" ] } ``` # benzinga-news Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/benzinga/benzinga-news Benzinga News **Server path:** `/benzinga-news` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`benzinga_news_get_analyst_insights`](#benzinga_news_get_analyst_insights) | Get analyst insights for a given ticker symbol. | | [`benzinga_news_get_bulls_bears_say`](#benzinga_news_get_bulls_bears_say) | Get the latest bull and bear cases for a given ticker symbol. | | [`benzinga_news_get_earnings_call_transcripts`](#benzinga_news_get_earnings_call_transcripts) | Get earnings call transcripts for a given ticker symbol. | | [`benzinga_news_get_news`](#benzinga_news_get_news) | Get the news items | | [`benzinga_news_get_removed`](#benzinga_news_get_removed) | Returns the removed news data | | [`benzinga_news_get_signal_option_activity`](#benzinga_news_get_signal_option_activity) | Returns option activity signals | | [`benzinga_news_get_wiims`](#benzinga_news_get_wiims) | Returns WIIMs data | *** ## benzinga\_news\_get\_analyst\_insights Get analyst insights for a given ticker symbol. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number for pagination. | | `pageSize` | integer | No | — | Number of items per page. | | `symbols` | string | No | — | Stock ticker symbols separated by commas to query for analyst insights. | | `analyst` | string | No | — | One or more analyst ids separated by a comma. | | `rating_id` | string | No | — | One or more rating ids separated by a comma. | | `search_keys_type` | string | No | — | If you wanna query by firm Id or firm name, use this parameter and pass the key. Currently supported are \[firm\_id, firm] | | `search_keys` | string | No | — | If you have selected search\_keys\_type, pass the appropriate identifier here. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number for pagination." }, "pageSize": { "type": "integer", "description": "Number of items per page." }, "symbols": { "type": "string", "description": "Stock ticker symbols separated by commas to query for analyst insights." }, "analyst": { "type": "string", "description": "One or more analyst ids separated by a comma." }, "rating_id": { "type": "string", "description": "One or more rating ids separated by a comma." }, "search_keys_type": { "type": "string", "description": "If you wanna query by firm Id or firm name, use this parameter and pass the key. Currently supported are [firm_id, firm]", "enum": [ "firm_id", "firm" ] }, "search_keys": { "type": "string", "description": "If you have selected search_keys_type, pass the appropriate identifier here." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_news\_get\_bulls\_bears\_say Get the latest bull and bear cases for a given ticker symbol. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | Yes | — | Stock ticker symbol to query for bull/bear cases. | | `page` | integer | No | — | Page offset number. | | `pagesize` | integer | No | — | Number of results to be returned. Limit 200 | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "Stock ticker symbol to query for bull/bear cases." }, "page": { "type": "integer", "description": "Page offset number." }, "pagesize": { "type": "integer", "description": "Number of results to be returned. Limit 200" }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID", "symbols" ] } ``` *** ## benzinga\_news\_get\_earnings\_call\_transcripts Get earnings call transcripts for a given ticker symbol. ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## benzinga\_news\_get\_news Get the news items **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pageSize` | integer | No | — | Number of results returned. | | `displayOutput` | string | No | — | Specify headline only (headline), headline + teaser (abstract), or headline + full body (full) text | | `date` | string | No | — | The date to query for news. Shorthand for date\_from and date\_to if they are the same | | `dateFrom` | string | No | — | Date to query from point in time. Sorted by published date | | `dateTo` | string | No | — | Date to query to point in time. Sorted by published date | | `updatedSince` | integer | No | — | The last updated Unix timestamp (UTC) to pull and sort by | | `publishedSince` | integer | No | — | The last published Unix timestamp (UTC) to pull and sort by | | `sort` | string | No | — | Allows control of results sorting. Default is created, DESC. Sort Fields \* id \* created \* updated Sort Order Direction \* asc (ascending) \* desc (descending) | | `isin` | string | No | — | One or more ISINs separated by a comma. Maximum 50. | | `cusip` | string | No | — | One or more CUSIPs separated by a comma. Maximum 50. License agreement required. | | `tickers` | string | No | — | One or more ticker symbols separated by a comma. Maximum 50. | | `channels` | string | No | — | One or more channel names or IDs separated by a comma | | `topics` | string | No | — | One or more words/phrases separated by a comma; searches Title, Tags, and Body in order of priority. | | `authors` | string | No | — | One or more authors separated by a comma | | `content_types` | string | No | — | One or more content types separated by a comma | | `format` | string | No | — | Specify the desired format for the api response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pageSize": { "type": "integer", "description": "Number of results returned." }, "displayOutput": { "type": "string", "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full) text", "enum": [ "full", "abstract", "headline" ] }, "date": { "type": "string", "description": "The date to query for news. Shorthand for date_from and date_to if they are the same" }, "dateFrom": { "type": "string", "description": "Date to query from point in time. Sorted by published date" }, "dateTo": { "type": "string", "description": "Date to query to point in time. Sorted by published date" }, "updatedSince": { "type": "integer", "description": "The last updated Unix timestamp (UTC) to pull and sort by" }, "publishedSince": { "type": "integer", "description": "The last published Unix timestamp (UTC) to pull and sort by" }, "sort": { "type": "string", "description": "Allows control of results sorting. Default is created, DESC. Sort Fields * id * created * updated Sort Order Direction * asc (ascending) * desc (descending)", "enum": [ "id:asc", "id:desc", "created:asc", "created:desc", "updated:asc", "updated:desc" ] }, "isin": { "type": "string", "description": "One or more ISINs separated by a comma. Maximum 50." }, "cusip": { "type": "string", "description": "One or more CUSIPs separated by a comma. Maximum 50. License agreement required." }, "tickers": { "type": "string", "description": "One or more ticker symbols separated by a comma. Maximum 50." }, "channels": { "type": "string", "description": "One or more channel names or IDs separated by a comma" }, "topics": { "type": "string", "description": "One or more words/phrases separated by a comma; searches Title, Tags, and Body in order of priority." }, "authors": { "type": "string", "description": "One or more authors separated by a comma" }, "content_types": { "type": "string", "description": "One or more content types separated by a comma" }, "format": { "type": "string", "description": "Specify the desired format for the api response.", "enum": [ "text" ] } }, "required": [ "PCID" ] } ``` *** ## benzinga\_news\_get\_removed Returns the removed news data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. | | `pageSize` | integer | No | — | Number of results returned. | | `updatedSince` | integer | No | — | Filters the results to only include items that have been updated since the specified timestamp. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date." }, "pageSize": { "type": "integer", "description": "Number of results returned." }, "updatedSince": { "type": "integer", "description": "Filters the results to only include items that have been updated since the specified timestamp." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_news\_get\_signal\_option\_activity Returns option activity signals **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page offset. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date]` | string | No | — | Date to query for data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[tickers]` | string | No | — | One or more ticker symbols separated by a comma. | | `parameters[id]` | string | No | — | One or more ids separated by a comma. | | `parameters[updated]` | integer | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page offset." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date]": { "type": "string", "description": "Date to query for data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[tickers]": { "type": "string", "description": "One or more ticker symbols separated by a comma." }, "parameters[id]": { "type": "string", "description": "One or more ids separated by a comma." }, "parameters[updated]": { "type": "integer", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_news\_get\_wiims Returns WIIMs data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `country` | string | No | — | Country code for the region of coverage. | | `page` | integer | No | — | Page offset. | | `pagesize` | integer | No | — | Number of results returned. Limit 500 | | `search_keys` | string | No | — | One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities. | | `search_keys_type` | string | No | — | The type of identifier being searched. Supported types are currently a security symbol. | | `updated_since` | number | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "country": { "type": "string", "description": "Country code for the region of coverage." }, "page": { "type": "integer", "description": "Page offset." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 500" }, "search_keys": { "type": "string", "description": "One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities." }, "search_keys_type": { "type": "string", "description": "The type of identifier being searched. Supported types are currently a security symbol.", "enum": [ "symbol" ] }, "updated_since": { "type": "number", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates." } }, "required": [ "PCID" ] } ``` # benzinga-reference Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/benzinga/benzinga-reference Benzinga Reference **Server path:** `/benzinga-reference` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`benzinga_reference_get_consensus_ratings_1`](#benzinga_reference_get_consensus_ratings_1) | Returns analyst ratings data] | | [`benzinga_reference_get_gov_usa_congress_trades`](#benzinga_reference_get_gov_usa_congress_trades) | Returns government trades data | | [`benzinga_reference_get_logos`](#benzinga_reference_get_logos) | Logos for market securities | | [`benzinga_reference_get_logos_search`](#benzinga_reference_get_logos_search) | Search logos for market securities/companies | | [`benzinga_reference_get_logos_sync`](#benzinga_reference_get_logos_sync) | Bulk sync logos. | | [`benzinga_reference_get_sec_insider_transactions_filings`](#benzinga_reference_get_sec_insider_transactions_filings) | Returns insider transactions data (SEC Form 4) | *** ## benzinga\_reference\_get\_consensus\_ratings\_1 Returns analyst ratings data] **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `parameters[date_from]` | string | No | — | Date to query from point in time. | | `parameters[date_to]` | string | No | — | Date to query to point in time. | | `parameters[tickers]` | string | No | — | One ticker symbol to query the aggregate for. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters\[securities]" instead). Ignored by the Economics endpoint. Maximum 1 ticker. | | `simplify` | boolean | No | — | To simplify the aggregate ratings to only BUY, SELL, HOLD, default will return all ratings (STRONG\_BUY, BUY, HOLD, SELL, STRONG\_SELL). | | `aggregate_type` | string | No | — | To aggregate the ratings by either number or percentage. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "parameters[date_from]": { "type": "string", "description": "Date to query from point in time." }, "parameters[date_to]": { "type": "string", "description": "Date to query to point in time." }, "parameters[tickers]": { "type": "string", "description": "One ticker symbol to query the aggregate for. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 1 ticker." }, "simplify": { "type": "boolean", "description": "To simplify the aggregate ratings to only BUY, SELL, HOLD, default will return all ratings (STRONG_BUY, BUY, HOLD, SELL, STRONG_SELL)." }, "aggregate_type": { "type": "string", "description": "To aggregate the ratings by either number or percentage.", "enum": [ "number", "percentage" ] } }, "required": [ "PCID" ] } ``` *** ## benzinga\_reference\_get\_gov\_usa\_congress\_trades Returns government trades data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `chamber` | string | No | — | Specific chamber of congress, either House or Senate. Defaults to all of congress. | | `date` | string | No | — | Date to query for data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `date_from` | string | No | — | Date to query from point in time. | | `date_to` | string | No | — | Date to query to point in time. | | `fields` | string\[] | No | — | A comma (,) separated list of returned fields. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `page` | integer | No | — | Page offset. | | `search_keys` | string | No | — | One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities. | | `updated_since` | number | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "chamber": { "type": "string", "description": "Specific chamber of congress, either House or Senate. Defaults to all of congress." }, "date": { "type": "string", "description": "Date to query for data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "date_from": { "type": "string", "description": "Date to query from point in time." }, "date_to": { "type": "string", "description": "Date to query to point in time." }, "fields": { "type": "array", "items": { "type": "string", "format": "array" }, "description": "A comma (,) separated list of returned fields." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "page": { "type": "integer", "description": "Page offset." }, "search_keys": { "type": "string", "description": "One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities." }, "updated_since": { "type": "number", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates." } }, "required": [ "PCID" ] } ``` *** ## benzinga\_reference\_get\_logos Logos for market securities **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `symbols` | string | Yes | — | A list of ticker symbols separated by a comma (,). Limit 50 tickers per request. | | `filters` | string | No | — | A list of client-specific filters to be applied. Filters are separated by a comma (,). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "symbols": { "type": "string", "description": "A list of ticker symbols separated by a comma (,). Limit 50 tickers per request." }, "filters": { "type": "string", "description": "A list of client-specific filters to be applied. Filters are separated by a comma (,)." } }, "required": [ "PCID", "symbols" ] } ``` *** ## benzinga\_reference\_get\_logos\_search Search logos for market securities/companies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `search_keys` | string\[] | Yes | — | A comma (,) separated list of search identifiers. Identifiers are based on the `search_type` field. Limit 100 per request. Example: F,AAPL Logos can also be queried with format \:\ i.e. NYSE:ARI | | `search_keys_type` | string | No | — | The type of identifier being searched. Supported types are currently a security symbol and CIK. | | `fields` | string\[] | Yes | — | A comma (,) separated list of returned fields. Example: mark\_light,background\_light Would return ONLY the mark\_light, background\_light values from the API. | | `composite_auto` | boolean | No | — | If no image exists, generate a fill image based on the company name and background color. | | `composite_radius` | integer | No | — | Apply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle. | | `scale` | string | No | — | Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to `contain`. Scale will be applied to: logo\_light, logo\_dark, mark\_light, mark\_dark, mark\_composite\_light, mark\_composite\_dark Example: 300x600 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "search_keys": { "type": "array", "items": { "type": "string", "format": "array" }, "description": "A comma (,) separated list of search identifiers. Identifiers are based on the `search_type` field. Limit 100 per request. Example: F,AAPL Logos can also be queried with format : i.e. NYSE:ARI" }, "search_keys_type": { "type": "string", "description": "The type of identifier being searched. Supported types are currently a security symbol and CIK.", "enum": [ "symbol", "cik", "cusip", "isin" ] }, "fields": { "type": "array", "items": { "type": "string", "format": "array", "enum": [ "logo_light", "logo_dark", "logo_vector_light", "logo_vector_dark", "mark_light", "mark_dark", "mark_vector_light", "mark_vector_dark", "mark_composite_light", "mark_composite_dark" ] }, "description": "A comma (,) separated list of returned fields. Example: mark_light,background_light Would return ONLY the mark_light, background_light values from the API." }, "composite_auto": { "type": "boolean", "description": "If no image exists, generate a fill image based on the company name and background color." }, "composite_radius": { "type": "integer", "description": "Apply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle." }, "scale": { "type": "string", "description": "Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to `contain`. Scale will be applied to: logo_light, logo_dark, mark_light, mark_dark, mark_composite_light, mark_composite_dark Example: 300x600" } }, "required": [ "PCID", "search_keys", "fields" ] } ``` *** ## benzinga\_reference\_get\_logos\_sync Bulk sync logos. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `updated_since` | integer | No | — | Last updated unix timestamp, UTC | | `fields` | string\[] | Yes | — | A comma (,) separated list of returned fields. Example: mark\_light,background\_light Would return ONLY the mark\_light, background\_light values from the API. | | `composite_auto` | boolean | No | — | If no image exists, generate a fill image based on the company name and background color. | | `composite_radius` | integer | No | — | Apply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle. | | `scale` | string | No | — | Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to `contain`. Scale will be applied to: logo\_light, logo\_dark, mark\_light, mark\_dark, mark\_composite\_light, mark\_composite\_dark Example: 300x600 | | `page` | integer | No | — | Page offset. | | `pagesize` | integer | No | — | Number of results returned. Default 100 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "updated_since": { "type": "integer", "description": "Last updated unix timestamp, UTC" }, "fields": { "type": "array", "items": { "type": "string", "format": "array", "enum": [ "logo_light", "logo_dark", "logo_vector_light", "logo_vector_dark", "mark_light", "mark_dark", "mark_vector_light", "mark_vector_dark", "mark_composite_light", "mark_composite_dark" ] }, "description": "A comma (,) separated list of returned fields. Example: mark_light,background_light Would return ONLY the mark_light, background_light values from the API." }, "composite_auto": { "type": "boolean", "description": "If no image exists, generate a fill image based on the company name and background color." }, "composite_radius": { "type": "integer", "description": "Apply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle." }, "scale": { "type": "string", "description": "Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to `contain`. Scale will be applied to: logo_light, logo_dark, mark_light, mark_dark, mark_composite_light, mark_composite_dark Example: 300x600" }, "page": { "type": "integer", "description": "Page offset." }, "pagesize": { "type": "integer", "description": "Number of results returned. Default 100" } }, "required": [ "PCID", "fields" ] } ``` *** ## benzinga\_reference\_get\_sec\_insider\_transactions\_filings Returns insider transactions data (SEC Form 4) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `date` | string | No | — | Date to query for data. Shorthand for date\_from and date\_to if they are the same. Defaults for latest. | | `date_from` | string | No | — | Date to query from point in time. | | `date_to` | string | No | — | Date to query to point in time. | | `fields` | string\[] | No | — | A comma (,) separated list of returned fields. | | `pagesize` | integer | No | — | Number of results returned. Limit 1000 | | `page` | integer | No | — | Page offset. | | `search_keys` | string | No | — | One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities. | | `search_keys_type` | string | No | — | The type of identifier being searched. Supported types are currently a security symbol, accession number and filing id. | | `updated_since` | number | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "date": { "type": "string", "description": "Date to query for data. Shorthand for date_from and date_to if they are the same. Defaults for latest." }, "date_from": { "type": "string", "description": "Date to query from point in time." }, "date_to": { "type": "string", "description": "Date to query to point in time." }, "fields": { "type": "array", "items": { "type": "string", "format": "array" }, "description": "A comma (,) separated list of returned fields." }, "pagesize": { "type": "integer", "description": "Number of results returned. Limit 1000" }, "page": { "type": "integer", "description": "Page offset." }, "search_keys": { "type": "string", "description": "One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities." }, "search_keys_type": { "type": "string", "description": "The type of identifier being searched. Supported types are currently a security symbol, accession number and filing id.", "enum": [ "symbol", "accession_number", "id" ] }, "updated_since": { "type": "number", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates." } }, "required": [ "PCID" ] } ``` # best-buy Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/best-buy Best Buy Product Catalog **Server path:** `/best-buy` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`best-buy_get_also_bought_products`](#best-buy_get_also_bought_products) | Get also-bought product recommendations | | [`best-buy_get_also_viewed_products`](#best-buy_get_also_viewed_products) | Get also-viewed product recommendations | | [`best-buy_get_most_viewed_products`](#best-buy_get_most_viewed_products) | Get most-viewed products by category | | [`best-buy_get_product`](#best-buy_get_product) | Get product by SKU | | [`best-buy_get_product_store_availability`](#best-buy_get_product_store_availability) | Get product store availability | | [`best-buy_get_product_warranties`](#best-buy_get_product_warranties) | Get product warranties | | [`best-buy_get_trending_products`](#best-buy_get_trending_products) | Get trending products by category | | [`best-buy_get_viewed_ultimately_bought_products`](#best-buy_get_viewed_ultimately_bought_products) | Get viewed-ultimately-bought recommendations | | [`best-buy_list_categories`](#best-buy_list_categories) | List product categories | | [`best-buy_list_stores`](#best-buy_list_stores) | List Best Buy stores | | [`best-buy_search_products`](#best-buy_search_products) | Search Best Buy products using keyword search or attribute filters. The Best Buy API uses a special search syntax embedded in the URL path. Use keyword search to find products by name, or attribute filters for precise queries. Examples: keyword search "laptop", attribute filter "name=ipad\*\&salePrice\<500", category filter "categoryPath.id=abcat0502000". Operators: = (equals), != (not equals), > \< >= \<= (comparison), in (list). Combine with & (AND) or \| (OR). Use \* as wildcard. | | [`best-buy_search_stores`](#best-buy_search_stores) | Search Best Buy store locations by attribute filters or find nearby stores by ZIP code and radius. For nearby stores, use the area parameter with a ZIP code and mile radius (e.g., area "55423,10" finds stores within 10 miles of ZIP 55423). For attribute search, use filter with Best Buy query syntax (e.g., "region=MN", "city=Minneapolis", "storeType=Big Box"). | *** ## best-buy\_get\_also\_bought\_products Get also-bought product recommendations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sku` | integer | Yes | — | The product SKU number to get recommendations for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sku": { "type": "integer", "description": "The product SKU number to get recommendations for" } }, "required": [ "PCID", "sku" ] } ``` *** ## best-buy\_get\_also\_viewed\_products Get also-viewed product recommendations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sku` | integer | Yes | — | The product SKU number to get recommendations for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sku": { "type": "integer", "description": "The product SKU number to get recommendations for" } }, "required": [ "PCID", "sku" ] } ``` *** ## best-buy\_get\_most\_viewed\_products Get most-viewed products by category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryId` | string | Yes | — | The category ID to get most-viewed products for (e.g., 'abcat0502000' for Desktops & All-in-Ones). Use the listCategories endpoint to find category IDs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryId": { "type": "string", "description": "The category ID to get most-viewed products for (e.g., 'abcat0502000' for Desktops & All-in-Ones). Use the listCategories endpoint to find category IDs." } }, "required": [ "PCID", "categoryId" ] } ``` *** ## best-buy\_get\_product Get product by SKU **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sku` | integer | Yes | — | The Best Buy product SKU number (e.g., 8880044) | | `show` | string | No | — | Comma-separated list of product attributes to return. Use 'all' for all attributes. Example: 'sku,name,salePrice,regularPrice,onSale,description' | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sku": { "type": "integer", "description": "The Best Buy product SKU number (e.g., 8880044)" }, "show": { "type": "string", "description": "Comma-separated list of product attributes to return. Use 'all' for all attributes. Example: 'sku,name,salePrice,regularPrice,onSale,description'" } }, "required": [ "PCID", "sku" ] } ``` *** ## best-buy\_get\_product\_store\_availability Get product store availability **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sku` | integer | Yes | — | The product SKU number | | `postalCode` | string | No | — | 5-digit ZIP/postal code to find nearby stores with availability | | `storeId` | string | No | — | Specific store ID to check availability at | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sku": { "type": "integer", "description": "The product SKU number" }, "postalCode": { "type": "string", "description": "5-digit ZIP/postal code to find nearby stores with availability" }, "storeId": { "type": "string", "description": "Specific store ID to check availability at" } }, "required": [ "PCID", "sku" ] } ``` *** ## best-buy\_get\_product\_warranties Get product warranties **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sku` | integer | Yes | — | The product SKU number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sku": { "type": "integer", "description": "The product SKU number" } }, "required": [ "PCID", "sku" ] } ``` *** ## best-buy\_get\_trending\_products Get trending products by category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryId` | string | Yes | — | The category ID to get trending products for (e.g., 'abcat0502000' for Desktops & All-in-Ones). Use the listCategories endpoint to find category IDs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryId": { "type": "string", "description": "The category ID to get trending products for (e.g., 'abcat0502000' for Desktops & All-in-Ones). Use the listCategories endpoint to find category IDs." } }, "required": [ "PCID", "categoryId" ] } ``` *** ## best-buy\_get\_viewed\_ultimately\_bought\_products Get viewed-ultimately-bought recommendations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sku` | integer | Yes | — | The product SKU number to get recommendations for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sku": { "type": "integer", "description": "The product SKU number to get recommendations for" } }, "required": [ "PCID", "sku" ] } ``` *** ## best-buy\_list\_categories List product categories **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `show` | string | No | — | Comma-separated list of attributes to return. Example: 'id,name,url' | | `pageSize` | integer | No | — | Number of results per page (max 100, default 10) | | `page` | integer | No | — | Page number to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "show": { "type": "string", "description": "Comma-separated list of attributes to return. Example: 'id,name,url'" }, "pageSize": { "type": "integer", "description": "Number of results per page (max 100, default 10)" }, "page": { "type": "integer", "description": "Page number to retrieve" } }, "required": [ "PCID" ] } ``` *** ## best-buy\_list\_stores List Best Buy stores **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `show` | string | No | — | Comma-separated list of attributes to return. Example: 'storeId,name,city,region,postalCode,phone' | | `pageSize` | integer | No | — | Number of results per page (max 100, default 10) | | `page` | integer | No | — | Page number to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "show": { "type": "string", "description": "Comma-separated list of attributes to return. Example: 'storeId,name,city,region,postalCode,phone'" }, "pageSize": { "type": "integer", "description": "Number of results per page (max 100, default 10)" }, "page": { "type": "integer", "description": "Page number to retrieve" } }, "required": [ "PCID" ] } ``` *** ## best-buy\_search\_products Search Best Buy products using keyword search or attribute filters. The Best Buy API uses a special search syntax embedded in the URL path. Use keyword search to find products by name, or attribute filters for precise queries. Examples: keyword search "laptop", attribute filter "name=ipad\*\&salePrice\<500", category filter "categoryPath.id=abcat0502000". Operators: = (equals), != (not equals), > \< >= \<= (comparison), in (list). Combine with & (AND) or | (OR). Use \* as wildcard. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `keyword` | string | No | — | Keyword to search for across product name, description, and other text fields. Example: "laptop", "iphone 15". Uses the search= parameter. | | `filter` | string | No | — | Attribute-based filter expression using Best Buy query syntax. Example: "name=ipad\*\&salePrice\<500", "categoryPath.id=abcat0502000\&onSale=true", "manufacturer=Apple\&salePrice\<=1000". Do not URL-encode operators or spaces. Exception: if a filter value itself contains a literal ampersand (rare), pre-encode it as %26 so it is not treated as the AND combinator. | | `show` | string | No | — | Comma-separated list of product attributes to return. Use 'all' for all attributes. Example: 'sku,name,salePrice,regularPrice,onSale,manufacturer,image' | | `sort` | string | No | — | Sort results by attribute. Use 'attribute.asc' or 'attribute.dsc'. Example: 'salePrice.asc', 'customerReviewAverage.dsc' | | `pageSize` | integer | No | — | Number of results per page (max 100, default 10) | | `page` | integer | No | — | Page number to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "keyword": { "type": "string", "description": "Keyword to search for across product name, description, and other text fields. Example: \"laptop\", \"iphone 15\". Uses the search= parameter." }, "filter": { "type": "string", "description": "Attribute-based filter expression using Best Buy query syntax. Example: \"name=ipad*&salePrice<500\", \"categoryPath.id=abcat0502000&onSale=true\", \"manufacturer=Apple&salePrice<=1000\". Do not URL-encode operators or spaces. Exception: if a filter value itself contains a literal ampersand (rare), pre-encode it as %26 so it is not treated as the AND combinator." }, "show": { "type": "string", "description": "Comma-separated list of product attributes to return. Use 'all' for all attributes. Example: 'sku,name,salePrice,regularPrice,onSale,manufacturer,image'" }, "sort": { "type": "string", "description": "Sort results by attribute. Use 'attribute.asc' or 'attribute.dsc'. Example: 'salePrice.asc', 'customerReviewAverage.dsc'" }, "pageSize": { "type": "integer", "description": "Number of results per page (max 100, default 10)" }, "page": { "type": "integer", "description": "Page number to retrieve" } }, "required": [ "PCID" ] } ``` *** ## best-buy\_search\_stores Search Best Buy store locations by attribute filters or find nearby stores by ZIP code and radius. For nearby stores, use the area parameter with a ZIP code and mile radius (e.g., area "55423,10" finds stores within 10 miles of ZIP 55423). For attribute search, use filter with Best Buy query syntax (e.g., "region=MN", "city=Minneapolis", "storeType=Big Box"). **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `area` | string | No | — | Find stores near a location. Format: "postalCode,radiusInMiles". Example: "55423,10" finds stores within 10 miles of ZIP 55423. Can also use lat/lng: "44.882942,-93.2775,10". | | `filter` | string | No | — | Attribute-based filter expression. Example: "region=MN", "city=Minneapolis\&storeType=Big Box", "postalCode=55423". Do not URL-encode operators or spaces. Exception: if a filter value itself contains a literal ampersand (rare), pre-encode it as %26 so it is not treated as the AND combinator. | | `show` | string | No | — | Comma-separated list of store attributes to return. Example: 'storeId,name,address,city,region,postalCode,phone,hours,distance' | | `pageSize` | integer | No | — | Number of results per page (max 100, default 10) | | `page` | integer | No | — | Page number to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "area": { "type": "string", "description": "Find stores near a location. Format: \"postalCode,radiusInMiles\". Example: \"55423,10\" finds stores within 10 miles of ZIP 55423. Can also use lat/lng: \"44.882942,-93.2775,10\"." }, "filter": { "type": "string", "description": "Attribute-based filter expression. Example: \"region=MN\", \"city=Minneapolis&storeType=Big Box\", \"postalCode=55423\". Do not URL-encode operators or spaces. Exception: if a filter value itself contains a literal ampersand (rare), pre-encode it as %26 so it is not treated as the AND combinator." }, "show": { "type": "string", "description": "Comma-separated list of store attributes to return. Example: 'storeId,name,address,city,region,postalCode,phone,hours,distance'" }, "pageSize": { "type": "integer", "description": "Number of results per page (max 100, default 10)" }, "page": { "type": "integer", "description": "Page number to retrieve" } }, "required": [ "PCID" ] } ``` # Better Stack Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/better-stack Better Stack official MCP server. Uptime monitoring, incidents, on-call schedules, and status pages. Tools are discovered at runtime using an existing connection. **Server path:** `/better-stack` | **Type:** Application (Remote MCP) | **PCID required:** Yes Tools are discovered at runtime from the upstream MCP server at `https://mcp.betterstack.com`. Authenticate via `apikey`. Use a `better-stack` PinkConnect connection. # bigid Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bigid BigID - data discovery, catalog, security posture, privacy (DSAR), and data source management **Server path:** `/bigid` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bigid_bulk_update_security_cases`](#bigid_bulk_update_security_cases) | Bulk update security case statuses | | [`bigid_create_data_source`](#bigid_create_data_source) | Create a new data source connection | | [`bigid_create_scan_profile`](#bigid_create_scan_profile) | Create a new scan profile | | [`bigid_export_data_sources`](#bigid_export_data_sources) | Export configured data sources as a JSON file | | [`bigid_get_catalog_object_attributes`](#bigid_get_catalog_object_attributes) | Retrieve attributes for an unstructured data object | | [`bigid_get_catalog_object_columns`](#bigid_get_catalog_object_columns) | Retrieve column metadata for a structured table | | [`bigid_get_cluster_columns`](#bigid_get_cluster_columns) | Get columns belonging to a specific cluster | | [`bigid_get_data_source_template`](#bigid_get_data_source_template) | Get the configuration template for a specific connector type | | [`bigid_get_dsar_attributes`](#bigid_get_dsar_attributes) | Get available attributes for a DSAR profile | | [`bigid_get_dsar_report`](#bigid_get_dsar_report) | Retrieve the short report for a completed DSAR request | | [`bigid_get_dsar_status`](#bigid_get_dsar_status) | Check the status of a DSAR request | | [`bigid_get_scan_profile`](#bigid_get_scan_profile) | Retrieve details of a specific scan profile | | [`bigid_get_scan_status`](#bigid_get_scan_status) | Check the current status of a specific scan | | [`bigid_initiate_dsar`](#bigid_initiate_dsar) | Initiate a Data Subject Access Request | | [`bigid_list_catalog_objects`](#bigid_list_catalog_objects) | List data catalog objects with optional filtering | | [`bigid_list_clusters`](#bigid_list_clusters) | List data clusters with optional filtering | | [`bigid_list_data_source_templates`](#bigid_list_data_source_templates) | List available data source connector types | | [`bigid_list_data_sources`](#bigid_list_data_sources) | Retrieve a list of data source connections | | [`bigid_list_dsar_profiles`](#bigid_list_dsar_profiles) | List available DSAR profiles | | [`bigid_list_scans`](#bigid_list_scans) | Get a high-level overview of scan executions | | [`bigid_list_security_cases`](#bigid_list_security_cases) | Retrieve security issues and actionable insights | | [`bigid_list_system_users`](#bigid_list_system_users) | List system users (also used as connection test endpoint) | | [`bigid_test_data_source_connection`](#bigid_test_data_source_connection) | Test a data source connection to verify credentials and network access | | [`bigid_update_security_case_status`](#bigid_update_security_case_status) | Update the status of a single security case | *** ## bigid\_bulk\_update\_security\_cases Bulk update security case statuses **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `additionalProperties` | object | Yes | — | Additional Properties | | `subType` | string | Yes | — | Must be "updateCases" | | `type` | string | Yes | — | Must be "CasesDB" | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "additionalProperties": { "type": "object", "description": "Additional Properties", "properties": { "field": { "type": "string", "description": "Field to update (e.g., caseStatus)" }, "newValue": { "type": "string", "description": "New value for the field" }, "casesFilters": { "type": "array", "items": { "type": "object" }, "description": "Cases Filters" } } }, "subType": { "type": "string", "description": "Must be \"updateCases\"" }, "type": { "type": "string", "description": "Must be \"CasesDB\"" } }, "required": [ "PCID", "additionalProperties", "subType", "type" ] } ``` *** ## bigid\_create\_data\_source Create a new data source connection **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ds_connection` | object | Yes | — | Data source connection configuration | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ds_connection": { "type": "object", "description": "Data source connection configuration", "properties": { "name": { "type": "string", "description": "Name for the data source" }, "type": { "type": "string", "description": "Data source connector type (e.g., rdb-mysql, s3)" } } } }, "required": [ "PCID", "ds_connection" ] } ``` *** ## bigid\_create\_scan\_profile Create a new scan profile **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dataSourceList` | string\[] | Yes | — | List of data source IDs to include in the scan | | `description` | string | No | — | Description of the scan profile | | `isSingleRunScan` | boolean | No | — | Whether this is a one-time scan | | `name` | string | Yes | — | Name for the scan profile | | `scanTemplateId` | string | No | — | ID of the scan template to use | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dataSourceList": { "type": "array", "items": { "type": "string" }, "description": "List of data source IDs to include in the scan" }, "description": { "type": "string", "description": "Description of the scan profile" }, "isSingleRunScan": { "type": "boolean", "description": "Whether this is a one-time scan" }, "name": { "type": "string", "description": "Name for the scan profile" }, "scanTemplateId": { "type": "string", "description": "ID of the scan template to use" } }, "required": [ "PCID", "dataSourceList", "name" ] } ``` *** ## bigid\_export\_data\_sources Export configured data sources as a JSON file **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ids` | string | No | — | Comma-separated list of data source IDs to export (omit for all) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ids": { "type": "string", "description": "Comma-separated list of data source IDs to export (omit for all)" } }, "required": [ "PCID" ] } ``` *** ## bigid\_get\_catalog\_object\_attributes Retrieve attributes for an unstructured data object **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object_name` | string | Yes | — | Full path to the unstructured file or object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object_name": { "type": "string", "description": "Full path to the unstructured file or object" } }, "required": [ "PCID", "object_name" ] } ``` *** ## bigid\_get\_catalog\_object\_columns Retrieve column metadata for a structured table **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object_name` | string | Yes | — | Full object path (format: DataSourceName.schemaName.tableName) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object_name": { "type": "string", "description": "Full object path (format: DataSourceName.schemaName.tableName)" } }, "required": [ "PCID", "object_name" ] } ``` *** ## bigid\_get\_cluster\_columns Get columns belonging to a specific cluster **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `clusterId` | string | Yes | — | Cluster ID to retrieve columns for | | `limit` | integer | No | — | Maximum results to return | | `skip` | integer | No | — | Number of results to skip for pagination | | `filter` | string | No | — | Filter by column metadata | | `searchText` | string | No | — | Search column names or attributes | | `sort` | string | No | — | Sort field | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clusterId": { "type": "string", "description": "Cluster ID to retrieve columns for" }, "limit": { "type": "integer", "description": "Maximum results to return" }, "skip": { "type": "integer", "description": "Number of results to skip for pagination" }, "filter": { "type": "string", "description": "Filter by column metadata" }, "searchText": { "type": "string", "description": "Search column names or attributes" }, "sort": { "type": "string", "description": "Sort field" } }, "required": [ "PCID", "clusterId" ] } ``` *** ## bigid\_get\_data\_source\_template Get the configuration template for a specific connector type **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `connectorType` | string | Yes | — | Connector type identifier (e.g., rdb-mysql, s3, kinesis) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "connectorType": { "type": "string", "description": "Connector type identifier (e.g., rdb-mysql, s3, kinesis)" } }, "required": [ "PCID", "connectorType" ] } ``` *** ## bigid\_get\_dsar\_attributes Get available attributes for a DSAR profile **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `profileId` | string | Yes | — | DSAR profile ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "profileId": { "type": "string", "description": "DSAR profile ID" } }, "required": [ "PCID", "profileId" ] } ``` *** ## bigid\_get\_dsar\_report Retrieve the short report for a completed DSAR request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `requestId` | string | Yes | — | DSAR request ID | | `format` | string | No | — | Report output format (json or csv) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "requestId": { "type": "string", "description": "DSAR request ID" }, "format": { "type": "string", "description": "Report output format (json or csv)", "enum": [ "json", "csv" ] } }, "required": [ "PCID", "requestId" ] } ``` *** ## bigid\_get\_dsar\_status Check the status of a DSAR request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `requestId` | string | Yes | — | DSAR request ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "requestId": { "type": "string", "description": "DSAR request ID" } }, "required": [ "PCID", "requestId" ] } ``` *** ## bigid\_get\_scan\_profile Retrieve details of a specific scan profile **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `profileId` | string | Yes | — | Unique scan profile identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "profileId": { "type": "string", "description": "Unique scan profile identifier" } }, "required": [ "PCID", "profileId" ] } ``` *** ## bigid\_get\_scan\_status Check the current status of a specific scan **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `scanId` | string | Yes | — | Scan execution ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "scanId": { "type": "string", "description": "Scan execution ID" } }, "required": [ "PCID", "scanId" ] } ``` *** ## bigid\_initiate\_dsar Initiate a Data Subject Access Request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `profileId` | string | Yes | — | DSAR profile ID to use | | `userDetails` | object | Yes | — | Details of the data subject | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "profileId": { "type": "string", "description": "DSAR profile ID to use" }, "userDetails": { "type": "object", "description": "Details of the data subject", "properties": { "attributes": { "type": "object", "description": "Key-value pairs of subject attributes" }, "userId": { "type": "string", "description": "Unique identifier for the data subject" }, "displayName": { "type": "string", "description": "Display name of the data subject" } } } }, "required": [ "PCID", "profileId", "userDetails" ] } ``` *** ## bigid\_list\_catalog\_objects List data catalog objects with optional filtering **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filter` | string | No | — | Filter expression (e.g., has\_duplicates="true" or duplicate\_id="\{id}") | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter": { "type": "string", "description": "Filter expression (e.g., has_duplicates=\"true\" or duplicate_id=\"{id}\")" } }, "required": [ "PCID" ] } ``` *** ## bigid\_list\_clusters List data clusters with optional filtering **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filter` | string | No | — | Filter expression (e.g., filter by cluster size) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter": { "type": "string", "description": "Filter expression (e.g., filter by cluster size)" } }, "required": [ "PCID" ] } ``` *** ## bigid\_list\_data\_source\_templates List available data source connector types ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bigid\_list\_data\_sources Retrieve a list of data source connections **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `skip` | integer | No | — | Number of records to skip for pagination | | `limit` | integer | No | — | Maximum number of data sources to return | | `requireTotalCount` | boolean | No | — | Whether to include total count in response | | `sort` | string | No | — | Sort results by specified field | | `filter` | string | No | — | Filter results based on field values | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skip": { "type": "integer", "description": "Number of records to skip for pagination" }, "limit": { "type": "integer", "description": "Maximum number of data sources to return" }, "requireTotalCount": { "type": "boolean", "description": "Whether to include total count in response" }, "sort": { "type": "string", "description": "Sort results by specified field" }, "filter": { "type": "string", "description": "Filter results based on field values" } }, "required": [ "PCID" ] } ``` *** ## bigid\_list\_dsar\_profiles List available DSAR profiles ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bigid\_list\_scans Get a high-level overview of scan executions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Maximum number of scans to return | | `sort` | string | No | — | Sort field (default descending by updated\_at) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Maximum number of scans to return" }, "sort": { "type": "string", "description": "Sort field (default descending by updated_at)" } }, "required": [ "PCID" ] } ``` *** ## bigid\_list\_security\_cases Retrieve security issues and actionable insights **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `skip` | integer | No | — | Number of records to skip for pagination | | `limit` | integer | No | — | Maximum number of records to return | | `filter` | string | No | — | BigID Query Language filter to narrow results | | `fields` | string | No | — | Comma-separated list of fields to return | | `sort` | string | No | — | Sort field with optional ASC/DESC | | `requireTotalCount` | boolean | No | — | Whether to include totalCount in response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skip": { "type": "integer", "description": "Number of records to skip for pagination" }, "limit": { "type": "integer", "description": "Maximum number of records to return" }, "filter": { "type": "string", "description": "BigID Query Language filter to narrow results" }, "fields": { "type": "string", "description": "Comma-separated list of fields to return" }, "sort": { "type": "string", "description": "Sort field with optional ASC/DESC" }, "requireTotalCount": { "type": "boolean", "description": "Whether to include totalCount in response" } }, "required": [ "PCID" ] } ``` *** ## bigid\_list\_system\_users List system users (also used as connection test endpoint) ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bigid\_test\_data\_source\_connection Test a data source connection to verify credentials and network access **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ds_connection` | object | Yes | — | Data source connection credentials to test | | `isNewPassword` | boolean | No | — | Whether the password is new | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ds_connection": { "type": "object", "description": "Data source connection credentials to test" }, "isNewPassword": { "type": "boolean", "description": "Whether the password is new" } }, "required": [ "PCID", "ds_connection" ] } ``` *** ## bigid\_update\_security\_case\_status Update the status of a single security case **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `caseId` | string | Yes | — | The case ID to update | | `auditReason` | string | No | — | Reason for the status change (for audit trail) | | `caseStatus` | string | Yes | — | New status value (e.g., resolved, open, dismissed) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "caseId": { "type": "string", "description": "The case ID to update" }, "auditReason": { "type": "string", "description": "Reason for the status change (for audit trail)" }, "caseStatus": { "type": "string", "description": "New status value (e.g., resolved, open, dismissed)" } }, "required": [ "PCID", "caseId", "caseStatus" ] } ``` # bitbucket Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bitbucket Bitbucket Cloud **PinkConnect service:** `bitbucket` | **Type:** Application (parent with child servers) | **PCID required:** Yes bitbucket is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [bitbucket-pipelines](/api-reference/mcp-servers/application/bitbucket/bitbucket-pipelines) | `/bitbucket-pipelines` | 17 | Pipelines and deployments | | [bitbucket-pullrequests](/api-reference/mcp-servers/application/bitbucket/bitbucket-pullrequests) | `/bitbucket-pullrequests` | 19 | Pull requests and reviews | | [bitbucket-repos](/api-reference/mcp-servers/application/bitbucket/bitbucket-repos) | `/bitbucket-repos` | 32 | Repositories, branches, tags, commits | | [bitbucket-workspaces](/api-reference/mcp-servers/application/bitbucket/bitbucket-workspaces) | `/bitbucket-workspaces` | 20 | Workspaces, projects, issues | # bitbucket-pipelines Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bitbucket/bitbucket-pipelines Pipelines and deployments **Server path:** `/bitbucket-pipelines` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bitbucket_pipelines_create_environment`](#bitbucket_pipelines_create_environment) | Create an environment | | [`bitbucket_pipelines_create_pipeline`](#bitbucket_pipelines_create_pipeline) | Run a pipeline | | [`bitbucket_pipelines_create_pipeline_variable`](#bitbucket_pipelines_create_pipeline_variable) | Create a variable for a repository | | [`bitbucket_pipelines_delete_environment`](#bitbucket_pipelines_delete_environment) | Delete an environment | | [`bitbucket_pipelines_get_deployment`](#bitbucket_pipelines_get_deployment) | Get a deployment | | [`bitbucket_pipelines_get_environment`](#bitbucket_pipelines_get_environment) | Get an environment | | [`bitbucket_pipelines_get_pipeline`](#bitbucket_pipelines_get_pipeline) | Get a pipeline | | [`bitbucket_pipelines_get_pipeline_config`](#bitbucket_pipelines_get_pipeline_config) | Get configuration | | [`bitbucket_pipelines_get_pipeline_step`](#bitbucket_pipelines_get_pipeline_step) | Get a step of a pipeline | | [`bitbucket_pipelines_get_pipeline_step_log`](#bitbucket_pipelines_get_pipeline_step_log) | Get log file for a step | | [`bitbucket_pipelines_list_deployments`](#bitbucket_pipelines_list_deployments) | List deployments | | [`bitbucket_pipelines_list_environments`](#bitbucket_pipelines_list_environments) | List environments | | [`bitbucket_pipelines_list_pipeline_steps`](#bitbucket_pipelines_list_pipeline_steps) | List steps for a pipeline | | [`bitbucket_pipelines_list_pipeline_variables`](#bitbucket_pipelines_list_pipeline_variables) | List variables for a repository | | [`bitbucket_pipelines_list_pipelines`](#bitbucket_pipelines_list_pipelines) | List pipelines | | [`bitbucket_pipelines_stop_pipeline`](#bitbucket_pipelines_stop_pipeline) | Stop a pipeline | | [`bitbucket_pipelines_update_pipeline_config`](#bitbucket_pipelines_update_pipeline_config) | Update configuration | *** ## bitbucket\_pipelines\_create\_environment Create an environment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `name` | string | No | — | The name of the environment. | | `type` | string | Yes | — | The type value | | `uuid` | string | No | — | The UUID identifying the environment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "name": { "type": "string", "description": "The name of the environment." }, "type": { "type": "string", "description": "The type value" }, "uuid": { "type": "string", "description": "The UUID identifying the environment." } }, "required": [ "PCID", "workspace", "repo_slug", "type" ] } ``` *** ## bitbucket\_pipelines\_create\_pipeline Run a pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `build_number` | integer | No | — | The build number of the pipeline. | | `build_seconds_used` | integer | No | — | The number of build seconds used by this pipeline. | | `completed_on` | string | No | — | The timestamp when the Pipeline was completed. This is not set if the pipeline is still in progress. | | `configuration_sources` | object\[] | No | — | An ordered list of sources of the pipeline configuration | | `created_on` | string | No | — | The timestamp when the pipeline was created. | | `creator` | object | No | — | The creator value | | `links` | object | No | — | The links value | | `repository` | object | No | — | The repository value | | `state` | object | No | — | The state value | | `target` | object | No | — | The target value | | `trigger` | object | No | — | The trigger value | | `type` | string | Yes | — | The type value | | `uuid` | string | No | — | The UUID identifying the pipeline. | | `variables` | any\[] | No | — | The variables for the pipeline. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "build_number": { "type": "integer", "description": "The build number of the pipeline." }, "build_seconds_used": { "type": "integer", "description": "The number of build seconds used by this pipeline." }, "completed_on": { "type": "string", "description": "The timestamp when the Pipeline was completed. This is not set if the pipeline is still in progress." }, "configuration_sources": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "description": "Identifier of the configuration source" }, "uri": { "type": "string", "format": "uri", "description": "Link to the configuration source view or its immediate content" } }, "required": [ "source", "uri" ] }, "description": "An ordered list of sources of the pipeline configuration" }, "created_on": { "type": "string", "description": "The timestamp when the pipeline was created." }, "creator": { "description": "The creator value" }, "links": { "description": "The links value" }, "repository": { "description": "The repository value" }, "state": { "description": "The state value" }, "target": { "description": "The target value" }, "trigger": { "description": "The trigger value" }, "type": { "type": "string", "description": "The type value" }, "uuid": { "type": "string", "description": "The UUID identifying the pipeline." }, "variables": { "type": "array", "description": "The variables for the pipeline." } }, "required": [ "PCID", "workspace", "repo_slug", "type" ] } ``` *** ## bitbucket\_pipelines\_create\_pipeline\_variable Create a variable for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `key` | string | No | — | The unique name of the variable. | | `secured` | boolean | No | — | If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API. | | `type` | string | Yes | — | The type value | | `uuid` | string | No | — | The UUID identifying the variable. | | `value` | string | No | — | The value of the variable. If the variable is secured, this will be empty. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "key": { "type": "string", "description": "The unique name of the variable." }, "secured": { "type": "boolean", "description": "If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API." }, "type": { "type": "string", "description": "The type value" }, "uuid": { "type": "string", "description": "The UUID identifying the variable." }, "value": { "type": "string", "description": "The value of the variable. If the variable is secured, this will be empty." } }, "required": [ "PCID", "workspace", "repo_slug", "type" ] } ``` *** ## bitbucket\_pipelines\_delete\_environment Delete an environment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `environment_uuid` | string | Yes | — | The environment UUID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "environment_uuid": { "type": "string", "description": "The environment UUID." } }, "required": [ "PCID", "workspace", "repo_slug", "environment_uuid" ] } ``` *** ## bitbucket\_pipelines\_get\_deployment Get a deployment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `deployment_uuid` | string | Yes | — | The deployment UUID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "deployment_uuid": { "type": "string", "description": "The deployment UUID." } }, "required": [ "PCID", "workspace", "repo_slug", "deployment_uuid" ] } ``` *** ## bitbucket\_pipelines\_get\_environment Get an environment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `environment_uuid` | string | Yes | — | The environment UUID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "environment_uuid": { "type": "string", "description": "The environment UUID." } }, "required": [ "PCID", "workspace", "repo_slug", "environment_uuid" ] } ``` *** ## bitbucket\_pipelines\_get\_pipeline Get a pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `pipeline_uuid` | string | Yes | — | The pipeline UUID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "pipeline_uuid": { "type": "string", "description": "The pipeline UUID." } }, "required": [ "PCID", "workspace", "repo_slug", "pipeline_uuid" ] } ``` *** ## bitbucket\_pipelines\_get\_pipeline\_config Get configuration **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | The account. | | `repo_slug` | string | Yes | — | The repository. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "The account." }, "repo_slug": { "type": "string", "description": "The repository." } }, "required": [ "PCID", "workspace", "repo_slug" ] } ``` *** ## bitbucket\_pipelines\_get\_pipeline\_step Get a step of a pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `pipeline_uuid` | string | Yes | — | The UUID of the pipeline. | | `step_uuid` | string | Yes | — | The UUID of the step. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "pipeline_uuid": { "type": "string", "description": "The UUID of the pipeline." }, "step_uuid": { "type": "string", "description": "The UUID of the step." } }, "required": [ "PCID", "workspace", "repo_slug", "pipeline_uuid", "step_uuid" ] } ``` *** ## bitbucket\_pipelines\_get\_pipeline\_step\_log Get log file for a step **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `pipeline_uuid` | string | Yes | — | The UUID of the pipeline. | | `step_uuid` | string | Yes | — | The UUID of the step. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "pipeline_uuid": { "type": "string", "description": "The UUID of the pipeline." }, "step_uuid": { "type": "string", "description": "The UUID of the step." } }, "required": [ "PCID", "workspace", "repo_slug", "pipeline_uuid", "step_uuid" ] } ``` *** ## bitbucket\_pipelines\_list\_deployments List deployments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." } }, "required": [ "PCID", "workspace", "repo_slug" ] } ``` *** ## bitbucket\_pipelines\_list\_environments List environments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." } }, "required": [ "PCID", "workspace", "repo_slug" ] } ``` *** ## bitbucket\_pipelines\_list\_pipeline\_steps List steps for a pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `pipeline_uuid` | string | Yes | — | The UUID of the pipeline. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "pipeline_uuid": { "type": "string", "description": "The UUID of the pipeline." } }, "required": [ "PCID", "workspace", "repo_slug", "pipeline_uuid" ] } ``` *** ## bitbucket\_pipelines\_list\_pipeline\_variables List variables for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." } }, "required": [ "PCID", "workspace", "repo_slug" ] } ``` *** ## bitbucket\_pipelines\_list\_pipelines List pipelines **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `creator.uuid` | string | No | — | The UUID of the creator of the pipeline to filter by. | | `target.ref_type` | string | No | — | The type of the reference to filter by. | | `target.ref_name` | string | No | — | The reference name to filter by. | | `target.branch` | string | No | — | The name of the branch to filter by. | | `target.commit.hash` | string | No | — | The revision to filter by. | | `target.selector.pattern` | string | No | — | The pipeline pattern to filter by. | | `target.selector.type` | string | No | — | The type of pipeline to filter by. | | `created_on` | string | No | — | The creation date to filter by. | | `trigger_type` | string | No | — | The trigger type to filter by. | | `status` | string | No | — | The pipeline status to filter by. | | `sort` | string | No | — | The attribute name to sort on. | | `page` | integer | No | — | The page number of elements to retrieve. | | `pagelen` | integer | No | — | The maximum number of results to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "creator.uuid": { "type": "string", "description": "The UUID of the creator of the pipeline to filter by." }, "target.ref_type": { "type": "string", "description": "The type of the reference to filter by.", "enum": [ "BRANCH", "TAG", "ANNOTATED_TAG" ] }, "target.ref_name": { "type": "string", "description": "The reference name to filter by." }, "target.branch": { "type": "string", "description": "The name of the branch to filter by." }, "target.commit.hash": { "type": "string", "description": "The revision to filter by." }, "target.selector.pattern": { "type": "string", "description": "The pipeline pattern to filter by." }, "target.selector.type": { "type": "string", "description": "The type of pipeline to filter by.", "enum": [ "BRANCH", "TAG", "CUSTOM", "PULLREQUESTS", "DEFAULT" ] }, "created_on": { "type": "string", "description": "The creation date to filter by." }, "trigger_type": { "type": "string", "description": "The trigger type to filter by.", "enum": [ "PUSH", "MANUAL", "SCHEDULED", "PARENT_STEP" ] }, "status": { "type": "string", "description": "The pipeline status to filter by.", "enum": [ "PARSING", "PENDING", "PAUSED", "HALTED", "BUILDING", "ERROR", "PASSED", "FAILED", "STOPPED", "UNKNOWN" ] }, "sort": { "type": "string", "description": "The attribute name to sort on.", "enum": [ "creator.uuid", "created_on", "run_creation_date" ] }, "page": { "type": "integer", "description": "The page number of elements to retrieve." }, "pagelen": { "type": "integer", "description": "The maximum number of results to return." } }, "required": [ "PCID", "workspace", "repo_slug" ] } ``` *** ## bitbucket\_pipelines\_stop\_pipeline Stop a pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `pipeline_uuid` | string | Yes | — | The UUID of the pipeline. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "pipeline_uuid": { "type": "string", "description": "The UUID of the pipeline." } }, "required": [ "PCID", "workspace", "repo_slug", "pipeline_uuid" ] } ``` *** ## bitbucket\_pipelines\_update\_pipeline\_config Update configuration **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. | | `repo_slug` | string | Yes | — | The repository. | | `enabled` | boolean | No | — | Whether Pipelines is enabled for the repository. | | `repository` | object | No | — | The repository value | | `type` | string | Yes | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, "repo_slug": { "type": "string", "description": "The repository." }, "enabled": { "type": "boolean", "description": "Whether Pipelines is enabled for the repository." }, "repository": { "description": "The repository value" }, "type": { "type": "string", "description": "The type value" } }, "required": [ "PCID", "workspace", "repo_slug", "type" ] } ``` # bitbucket-pullrequests Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bitbucket/bitbucket-pullrequests Pull requests and reviews **Server path:** `/bitbucket-pullrequests` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bitbucket_pullrequests_approve_pull_request`](#bitbucket_pullrequests_approve_pull_request) | Approve a pull request | | [`bitbucket_pullrequests_create_pull_request`](#bitbucket_pullrequests_create_pull_request) | Create a pull request | | [`bitbucket_pullrequests_create_pull_request_comment`](#bitbucket_pullrequests_create_pull_request_comment) | Create a comment on a pull request | | [`bitbucket_pullrequests_decline_pull_request`](#bitbucket_pullrequests_decline_pull_request) | Decline a pull request | | [`bitbucket_pullrequests_delete_pull_request_comment`](#bitbucket_pullrequests_delete_pull_request_comment) | Delete a comment on a pull request | | [`bitbucket_pullrequests_get_pull_request`](#bitbucket_pullrequests_get_pull_request) | Get a pull request | | [`bitbucket_pullrequests_get_pull_request_comment`](#bitbucket_pullrequests_get_pull_request_comment) | Get a comment on a pull request | | [`bitbucket_pullrequests_get_pull_request_diff`](#bitbucket_pullrequests_get_pull_request_diff) | List changes in a pull request | | [`bitbucket_pullrequests_get_pull_request_diffstat`](#bitbucket_pullrequests_get_pull_request_diffstat) | Get the diff stat for a pull request | | [`bitbucket_pullrequests_list_default_reviewers`](#bitbucket_pullrequests_list_default_reviewers) | List default reviewers | | [`bitbucket_pullrequests_list_pull_request_activity`](#bitbucket_pullrequests_list_pull_request_activity) | List a pull request activity log | | [`bitbucket_pullrequests_list_pull_request_comments`](#bitbucket_pullrequests_list_pull_request_comments) | List comments on a pull request | | [`bitbucket_pullrequests_list_pull_request_commits`](#bitbucket_pullrequests_list_pull_request_commits) | List commits on a pull request | | [`bitbucket_pullrequests_list_pull_request_statuses`](#bitbucket_pullrequests_list_pull_request_statuses) | List commit statuses for a pull request | | [`bitbucket_pullrequests_list_pull_requests`](#bitbucket_pullrequests_list_pull_requests) | List pull requests | | [`bitbucket_pullrequests_merge_pull_request`](#bitbucket_pullrequests_merge_pull_request) | Merge a pull request | | [`bitbucket_pullrequests_unapprove_pull_request`](#bitbucket_pullrequests_unapprove_pull_request) | Unapprove a pull request | | [`bitbucket_pullrequests_update_pull_request`](#bitbucket_pullrequests_update_pull_request) | Update a pull request | | [`bitbucket_pullrequests_update_pull_request_comment`](#bitbucket_pullrequests_update_pull_request_comment) | Update a comment on a pull request | *** ## bitbucket\_pullrequests\_approve\_pull\_request Approve a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_create\_pull\_request Create a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `author` | object | No | — | The author value | | `close_source_branch` | boolean | No | — | A boolean flag indicating if merging the pull request closes the source branch. | | `closed_by` | object | No | — | Closed By | | `comment_count` | integer | No | — | The number of comments for a specific pull request. | | `created_on` | string | No | — | The ISO8601 timestamp the request was created. | | `destination` | object | No | — | The destination value | | `draft` | boolean | No | — | A boolean flag indicating whether the pull request is a draft. | | `id` | integer | No | — | The pull request's unique ID. Note that pull request IDs are only unique within their associated repository. | | `links` | object | No | — | The links value | | `merge_commit` | object | No | — | Merge Commit | | `mergeable` | boolean | No | — | A boolean flag indicating whether the pull request passes all merge checks | | `participants` | any\[] | No | — | The list of users that are collaborating on this pull request. Collaborators are user that: \* are added to the pull request as a reviewer (part of the reviewers list) \* are not explicit reviewers, but have commented on the pull request \* are not explicit reviewers, but have approved the pull request Each user is wrapped in an object that indicates the user's role and whether they have approved the pull request. For performance reasons, the API only returns this list when an API requests a pull request by id. | | `queued` | boolean | No | — | A boolean flag indicating whether the pull request is queued | | `reason` | string | No | — | Explains why a pull request was declined. This field is only applicable to pull requests in rejected state. | | `rendered` | object | No | — | User provided pull request text, interpreted in a markup language and rendered in HTML | | `reviewers` | any\[] | No | — | The list of users that were added as reviewers on this pull request when it was created. For performance reasons, the API only includes this list on a pull request's `self` URL. | | `source` | object | No | — | The source value | | `state` | string | No | — | The pull request's current status. | | `summary` | object | No | — | The summary value | | `task_count` | integer | No | — | The number of open tasks for a specific pull request. | | `title` | string | No | — | Title of the pull request. | | `type` | string | No | — | The type value | | `updated_on` | string | No | — | The ISO8601 timestamp the request was last updated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "author": { "description": "The author value" }, "close_source_branch": { "type": "boolean", "description": "A boolean flag indicating if merging the pull request closes the source branch." }, "closed_by": { "description": "Closed By" }, "comment_count": { "type": "integer", "description": "The number of comments for a specific pull request." }, "created_on": { "type": "string", "description": "The ISO8601 timestamp the request was created." }, "destination": { "type": "object", "description": "The destination value", "properties": { "repository": { "description": "The repository value" }, "branch": { "type": "object", "description": "The branch value" }, "commit": { "type": "object", "description": "The commit value" } } }, "draft": { "type": "boolean", "description": "A boolean flag indicating whether the pull request is a draft." }, "id": { "type": "integer", "description": "The pull request's unique ID. Note that pull request IDs are only unique within their associated repository." }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "approve": { "type": "object", "description": "A link to a resource related to this object." }, "diff": { "type": "object", "description": "A link to a resource related to this object." }, "diffstat": { "type": "object", "description": "A link to a resource related to this object." }, "comments": { "type": "object", "description": "A link to a resource related to this object." }, "activity": { "type": "object", "description": "A link to a resource related to this object." }, "merge": { "type": "object", "description": "A link to a resource related to this object." }, "decline": { "type": "object", "description": "A link to a resource related to this object." } } }, "merge_commit": { "type": "object", "description": "Merge Commit", "properties": { "hash": { "type": "string", "description": "The hash value" } } }, "mergeable": { "type": "boolean", "description": "A boolean flag indicating whether the pull request passes all merge checks" }, "participants": { "type": "array", "description": "The list of users that are collaborating on this pull request. Collaborators are user that: * are added to the pull request as a reviewer (part of the reviewers list) * are not explicit reviewers, but have commented on the pull request * are not explicit reviewers, but have approved the pull request Each user is wrapped in an object that indicates the user's role and whether they have approved the pull request. For performance reasons, the API only returns this list when an API requests a pull request by id." }, "queued": { "type": "boolean", "description": "A boolean flag indicating whether the pull request is queued" }, "reason": { "type": "string", "description": "Explains why a pull request was declined. This field is only applicable to pull requests in rejected state." }, "rendered": { "type": "object", "description": "User provided pull request text, interpreted in a markup language and rendered in HTML", "properties": { "title": { "type": "object", "description": "The title value" }, "description": { "type": "object", "description": "The description value" }, "reason": { "type": "object", "description": "The reason value" } } }, "reviewers": { "type": "array", "description": "The list of users that were added as reviewers on this pull request when it was created. For performance reasons, the API only includes this list on a pull request's `self` URL." }, "source": { "type": "object", "description": "The source value", "properties": { "repository": { "description": "The repository value" }, "branch": { "type": "object", "description": "The branch value" }, "commit": { "type": "object", "description": "The commit value" } } }, "state": { "type": "string", "description": "The pull request's current status.", "enum": [ "OPEN", "DRAFT", "QUEUED", "MERGED", "DECLINED", "SUPERSEDED" ] }, "summary": { "type": "object", "description": "The summary value", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "type": "string", "description": "The type of markup language the raw content is to be interpreted in.", "enum": [ "markdown", "creole", "plaintext" ] }, "html": { "type": "string", "description": "The user's content rendered as HTML." } } }, "task_count": { "type": "integer", "description": "The number of open tasks for a specific pull request." }, "title": { "type": "string", "description": "Title of the pull request." }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "The ISO8601 timestamp the request was last updated." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_create\_pull\_request\_comment Create a comment on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `content` | object | No | — | The content value | | `created_on` | string | No | — | Created On | | `deleted` | boolean | No | — | The deleted value | | `id` | integer | No | — | The id value | | `inline` | object | No | — | The inline value | | `links` | object | No | — | The links value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/comment | | `pending` | boolean | No | — | The pending value | | `pullrequest` | object | No | — | The pullrequest value | | `resolution` | object | No | — | The resolution object for a Comment. | | `type` | string | Yes | — | The type value | | `updated_on` | string | No | — | Updated On | | `user` | object | No | — | The user value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "content": { "type": "object", "description": "The content value", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "type": "string", "description": "The type of markup language the raw content is to be interpreted in.", "enum": [ "markdown", "creole", "plaintext" ] }, "html": { "type": "string", "description": "The user's content rendered as HTML." } } }, "created_on": { "type": "string", "description": "Created On" }, "deleted": { "type": "boolean", "description": "The deleted value" }, "id": { "type": "integer", "description": "The id value" }, "inline": { "type": "object", "description": "The inline value", "properties": { "from": { "type": "integer", "description": "The comment's anchor line in the old version of the file. If the comment is a multi-line comment, this is the ending line number in the old version of the file." }, "to": { "type": "integer", "description": "The comment's anchor line in the new version of the file. If the comment is a multi-line comment, this is the ending line number in the new version of the file." }, "start_from": { "type": "integer", "description": "The starting line number in the old version of the file, if the comment is a multi-line comment. This is null otherwise." }, "start_to": { "type": "integer", "description": "The starting line number in the new version of the file, if the comment is a multi-line comment. This is null otherwise." }, "path": { "type": "string", "description": "The path of the file this comment is anchored to." } }, "required": [ "path" ] }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "code": { "type": "object", "description": "A link to a resource related to this object." } } }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/comment" }, "pending": { "type": "boolean", "description": "The pending value" }, "pullrequest": { "description": "The pullrequest value" }, "resolution": { "type": "object", "description": "The resolution object for a Comment.", "properties": { "type": { "type": "string", "description": "The type value" }, "user": { "description": "The user value" }, "created_on": { "type": "string", "description": "The ISO8601 timestamp the resolution was created." } }, "required": [ "type" ] }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "user": { "description": "The user value" } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace", "type" ] } ``` *** ## bitbucket\_pullrequests\_decline\_pull\_request Decline a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_delete\_pull\_request\_comment Delete a comment on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `comment_id` | integer | Yes | — | The id of the comment. | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment_id": { "type": "integer", "description": "The id of the comment." }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "comment_id", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_get\_pull\_request Get a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_get\_pull\_request\_comment Get a comment on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `comment_id` | integer | Yes | — | The id of the comment. | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment_id": { "type": "integer", "description": "The id of the comment." }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "comment_id", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_get\_pull\_request\_diff List changes in a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_get\_pull\_request\_diffstat Get the diff stat for a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_default\_reviewers List default reviewers **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_pull\_request\_activity List a pull request activity log **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_pull\_request\_comments List comments on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_pull\_request\_commits List commits on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_pull\_request\_statuses List commit statuses for a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. Defaults to `created_on`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). Defaults to `created_on`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_pull\_requests List pull requests **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `state` | string | No | — | Only return pull requests that are in this state. This parameter can be repeated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "state": { "type": "string", "description": "Only return pull requests that are in this state. This parameter can be repeated.", "enum": [ "OPEN", "MERGED", "DECLINED", "SUPERSEDED" ] } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_merge\_pull\_request Merge a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `async` | boolean | No | — | Default value is false. When set to true, runs merge asynchronously and immediately returns a 202 with polling link to the task-status API in the Location header. When set to false, runs merge and waits for it to complete, returning 200 when it succeeds. If the duration of the merge exceeds a timeout threshold, the API returns a 202 with polling link to the task-status API in the Location header. | | `close_source_branch` | boolean | No | — | Whether the source branch should be deleted. If this is not provided, we fallback to the value used when the pull request was created, which defaults to False | | `merge_strategy` | string | No | — | The merge strategy that will be used to merge the pull request. | | `message` | string | No | — | The commit message that will be used on the resulting commit. Note that the size of the message is limited to 128 KiB. | | `type` | string | No | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "async": { "type": "boolean", "description": "Default value is false. When set to true, runs merge asynchronously and immediately returns a 202 with polling link to the task-status API in the Location header. When set to false, runs merge and waits for it to complete, returning 200 when it succeeds. If the duration of the merge exceeds a timeout threshold, the API returns a 202 with polling link to the task-status API in the Location header." }, "close_source_branch": { "type": "boolean", "description": "Whether the source branch should be deleted. If this is not provided, we fallback to the value used when the pull request was created, which defaults to False" }, "merge_strategy": { "type": "string", "description": "The merge strategy that will be used to merge the pull request.", "enum": [ "merge_commit", "squash", "fast_forward", "squash_fast_forward", "rebase_fast_forward", "rebase_merge" ] }, "message": { "type": "string", "description": "The commit message that will be used on the resulting commit. Note that the size of the message is limited to 128 KiB." }, "type": { "type": "string", "description": "The type value" } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_unapprove\_pull\_request Unapprove a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_update\_pull\_request Update a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `author` | object | No | — | The author value | | `close_source_branch` | boolean | No | — | A boolean flag indicating if merging the pull request closes the source branch. | | `closed_by` | object | No | — | Closed By | | `comment_count` | integer | No | — | The number of comments for a specific pull request. | | `created_on` | string | No | — | The ISO8601 timestamp the request was created. | | `destination` | object | No | — | The destination value | | `draft` | boolean | No | — | A boolean flag indicating whether the pull request is a draft. | | `id` | integer | No | — | The pull request's unique ID. Note that pull request IDs are only unique within their associated repository. | | `links` | object | No | — | The links value | | `merge_commit` | object | No | — | Merge Commit | | `mergeable` | boolean | No | — | A boolean flag indicating whether the pull request passes all merge checks | | `participants` | any\[] | No | — | The list of users that are collaborating on this pull request. Collaborators are user that: \* are added to the pull request as a reviewer (part of the reviewers list) \* are not explicit reviewers, but have commented on the pull request \* are not explicit reviewers, but have approved the pull request Each user is wrapped in an object that indicates the user's role and whether they have approved the pull request. For performance reasons, the API only returns this list when an API requests a pull request by id. | | `queued` | boolean | No | — | A boolean flag indicating whether the pull request is queued | | `reason` | string | No | — | Explains why a pull request was declined. This field is only applicable to pull requests in rejected state. | | `rendered` | object | No | — | User provided pull request text, interpreted in a markup language and rendered in HTML | | `reviewers` | any\[] | No | — | The list of users that were added as reviewers on this pull request when it was created. For performance reasons, the API only includes this list on a pull request's `self` URL. | | `source` | object | No | — | The source value | | `state` | string | No | — | The pull request's current status. | | `summary` | object | No | — | The summary value | | `task_count` | integer | No | — | The number of open tasks for a specific pull request. | | `title` | string | No | — | Title of the pull request. | | `type` | string | No | — | The type value | | `updated_on` | string | No | — | The ISO8601 timestamp the request was last updated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "author": { "description": "The author value" }, "close_source_branch": { "type": "boolean", "description": "A boolean flag indicating if merging the pull request closes the source branch." }, "closed_by": { "description": "Closed By" }, "comment_count": { "type": "integer", "description": "The number of comments for a specific pull request." }, "created_on": { "type": "string", "description": "The ISO8601 timestamp the request was created." }, "destination": { "type": "object", "description": "The destination value", "properties": { "repository": { "description": "The repository value" }, "branch": { "type": "object", "description": "The branch value" }, "commit": { "type": "object", "description": "The commit value" } } }, "draft": { "type": "boolean", "description": "A boolean flag indicating whether the pull request is a draft." }, "id": { "type": "integer", "description": "The pull request's unique ID. Note that pull request IDs are only unique within their associated repository." }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "approve": { "type": "object", "description": "A link to a resource related to this object." }, "diff": { "type": "object", "description": "A link to a resource related to this object." }, "diffstat": { "type": "object", "description": "A link to a resource related to this object." }, "comments": { "type": "object", "description": "A link to a resource related to this object." }, "activity": { "type": "object", "description": "A link to a resource related to this object." }, "merge": { "type": "object", "description": "A link to a resource related to this object." }, "decline": { "type": "object", "description": "A link to a resource related to this object." } } }, "merge_commit": { "type": "object", "description": "Merge Commit", "properties": { "hash": { "type": "string", "description": "The hash value" } } }, "mergeable": { "type": "boolean", "description": "A boolean flag indicating whether the pull request passes all merge checks" }, "participants": { "type": "array", "description": "The list of users that are collaborating on this pull request. Collaborators are user that: * are added to the pull request as a reviewer (part of the reviewers list) * are not explicit reviewers, but have commented on the pull request * are not explicit reviewers, but have approved the pull request Each user is wrapped in an object that indicates the user's role and whether they have approved the pull request. For performance reasons, the API only returns this list when an API requests a pull request by id." }, "queued": { "type": "boolean", "description": "A boolean flag indicating whether the pull request is queued" }, "reason": { "type": "string", "description": "Explains why a pull request was declined. This field is only applicable to pull requests in rejected state." }, "rendered": { "type": "object", "description": "User provided pull request text, interpreted in a markup language and rendered in HTML", "properties": { "title": { "type": "object", "description": "The title value" }, "description": { "type": "object", "description": "The description value" }, "reason": { "type": "object", "description": "The reason value" } } }, "reviewers": { "type": "array", "description": "The list of users that were added as reviewers on this pull request when it was created. For performance reasons, the API only includes this list on a pull request's `self` URL." }, "source": { "type": "object", "description": "The source value", "properties": { "repository": { "description": "The repository value" }, "branch": { "type": "object", "description": "The branch value" }, "commit": { "type": "object", "description": "The commit value" } } }, "state": { "type": "string", "description": "The pull request's current status.", "enum": [ "OPEN", "DRAFT", "QUEUED", "MERGED", "DECLINED", "SUPERSEDED" ] }, "summary": { "type": "object", "description": "The summary value", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "type": "string", "description": "The type of markup language the raw content is to be interpreted in.", "enum": [ "markdown", "creole", "plaintext" ] }, "html": { "type": "string", "description": "The user's content rendered as HTML." } } }, "task_count": { "type": "integer", "description": "The number of open tasks for a specific pull request." }, "title": { "type": "string", "description": "Title of the pull request." }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "The ISO8601 timestamp the request was last updated." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_update\_pull\_request\_comment Update a comment on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `comment_id` | integer | Yes | — | The id of the comment. | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `content` | object | No | — | The content value | | `created_on` | string | No | — | Created On | | `deleted` | boolean | No | — | The deleted value | | `id` | integer | No | — | The id value | | `inline` | object | No | — | The inline value | | `links` | object | No | — | The links value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/comment | | `pending` | boolean | No | — | The pending value | | `pullrequest` | object | No | — | The pullrequest value | | `resolution` | object | No | — | The resolution object for a Comment. | | `type` | string | Yes | — | The type value | | `updated_on` | string | No | — | Updated On | | `user` | object | No | — | The user value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment_id": { "type": "integer", "description": "The id of the comment." }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "content": { "type": "object", "description": "The content value", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "type": "string", "description": "The type of markup language the raw content is to be interpreted in.", "enum": [ "markdown", "creole", "plaintext" ] }, "html": { "type": "string", "description": "The user's content rendered as HTML." } } }, "created_on": { "type": "string", "description": "Created On" }, "deleted": { "type": "boolean", "description": "The deleted value" }, "id": { "type": "integer", "description": "The id value" }, "inline": { "type": "object", "description": "The inline value", "properties": { "from": { "type": "integer", "description": "The comment's anchor line in the old version of the file. If the comment is a multi-line comment, this is the ending line number in the old version of the file." }, "to": { "type": "integer", "description": "The comment's anchor line in the new version of the file. If the comment is a multi-line comment, this is the ending line number in the new version of the file." }, "start_from": { "type": "integer", "description": "The starting line number in the old version of the file, if the comment is a multi-line comment. This is null otherwise." }, "start_to": { "type": "integer", "description": "The starting line number in the new version of the file, if the comment is a multi-line comment. This is null otherwise." }, "path": { "type": "string", "description": "The path of the file this comment is anchored to." } }, "required": [ "path" ] }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "code": { "type": "object", "description": "A link to a resource related to this object." } } }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/comment" }, "pending": { "type": "boolean", "description": "The pending value" }, "pullrequest": { "description": "The pullrequest value" }, "resolution": { "type": "object", "description": "The resolution object for a Comment.", "properties": { "type": { "type": "string", "description": "The type value" }, "user": { "description": "The user value" }, "created_on": { "type": "string", "description": "The ISO8601 timestamp the resolution was created." } }, "required": [ "type" ] }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "user": { "description": "The user value" } }, "required": [ "PCID", "comment_id", "pull_request_id", "repo_slug", "workspace", "type" ] } ``` # bitbucket-repos Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bitbucket/bitbucket-repos Repositories, branches, tags, commits **Server path:** `/bitbucket-repos` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bitbucket_repos_create_branch`](#bitbucket_repos_create_branch) | Create a branch | | [`bitbucket_repos_create_repository`](#bitbucket_repos_create_repository) | Create a repository | | [`bitbucket_repos_create_tag`](#bitbucket_repos_create_tag) | Create a tag | | [`bitbucket_repos_create_webhook`](#bitbucket_repos_create_webhook) | Create a webhook for a repository | | [`bitbucket_repos_delete_branch`](#bitbucket_repos_delete_branch) | Delete a branch | | [`bitbucket_repos_delete_repository`](#bitbucket_repos_delete_repository) | Delete a repository | | [`bitbucket_repos_delete_tag`](#bitbucket_repos_delete_tag) | Delete a tag | | [`bitbucket_repos_delete_webhook`](#bitbucket_repos_delete_webhook) | Delete a webhook for a repository | | [`bitbucket_repos_fork_repository`](#bitbucket_repos_fork_repository) | Fork a repository | | [`bitbucket_repos_get_branch`](#bitbucket_repos_get_branch) | Get a branch | | [`bitbucket_repos_get_branching_model`](#bitbucket_repos_get_branching_model) | Get the branching model for a repository | | [`bitbucket_repos_get_branching_model_settings`](#bitbucket_repos_get_branching_model_settings) | Get the branching model config for a repository | | [`bitbucket_repos_get_commit`](#bitbucket_repos_get_commit) | Get a commit | | [`bitbucket_repos_get_diff`](#bitbucket_repos_get_diff) | Compare two commits | | [`bitbucket_repos_get_diffstat`](#bitbucket_repos_get_diffstat) | Compare two commit diff stats | | [`bitbucket_repos_get_file_content`](#bitbucket_repos_get_file_content) | Get file or directory contents | | [`bitbucket_repos_get_file_history`](#bitbucket_repos_get_file_history) | List commits that modified a file | | [`bitbucket_repos_get_repository`](#bitbucket_repos_get_repository) | Get a repository | | [`bitbucket_repos_get_tag`](#bitbucket_repos_get_tag) | Get a tag | | [`bitbucket_repos_get_webhook`](#bitbucket_repos_get_webhook) | Get a webhook for a repository | | [`bitbucket_repos_list_branches`](#bitbucket_repos_list_branches) | List open branches | | [`bitbucket_repos_list_commit_comments`](#bitbucket_repos_list_commit_comments) | List a commit's comments | | [`bitbucket_repos_list_commit_statuses`](#bitbucket_repos_list_commit_statuses) | List commit statuses for a commit | | [`bitbucket_repos_list_commits`](#bitbucket_repos_list_commits) | List commits | | [`bitbucket_repos_list_refs`](#bitbucket_repos_list_refs) | List branches and tags | | [`bitbucket_repos_list_repositories`](#bitbucket_repos_list_repositories) | List repositories in a workspace | | [`bitbucket_repos_list_repository_forks`](#bitbucket_repos_list_repository_forks) | List repository forks | | [`bitbucket_repos_list_repository_watchers`](#bitbucket_repos_list_repository_watchers) | List repositories watchers | | [`bitbucket_repos_list_tags`](#bitbucket_repos_list_tags) | List tags | | [`bitbucket_repos_list_webhooks`](#bitbucket_repos_list_webhooks) | List webhooks for a repository | | [`bitbucket_repos_update_repository`](#bitbucket_repos_update_repository) | Update a repository | | [`bitbucket_repos_update_webhook`](#bitbucket_repos_update_webhook) | Update a webhook for a repository | *** ## bitbucket\_repos\_create\_branch Create a branch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `default_merge_strategy` | string | No | — | The default merge strategy for pull requests targeting this branch. | | `links` | object | No | — | The links value | | `merge_strategies` | string\[] | No | — | Available merge strategies for pull requests targeting this branch. | | `name` | string | No | — | The name of the ref. | | `target` | object | No | — | The target value | | `type` | string | Yes | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "default_merge_strategy": { "type": "string", "description": "The default merge strategy for pull requests targeting this branch." }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." } } }, "merge_strategies": { "type": "array", "items": { "type": "string", "enum": [ "merge_commit", "squash", "fast_forward", "squash_fast_forward", "rebase_fast_forward", "rebase_merge" ] }, "description": "Available merge strategies for pull requests targeting this branch." }, "name": { "type": "string", "description": "The name of the ref." }, "target": { "description": "The target value" }, "type": { "type": "string", "description": "The type value" } }, "required": [ "PCID", "repo_slug", "workspace", "type" ] } ``` *** ## bitbucket\_repos\_create\_repository Create a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `created_on` | string | No | — | Created On | | `description` | string | No | — | The description value | | `fork_policy` | string | No | — | Controls the rules for forking this repository. \* **allow\_forks**: unrestricted forking \* **no\_public\_forks**: restrict forking to private forks (forks cannot be made public later) \* **no\_forks**: deny all forking | | `full_name` | string | No | — | The concatenation of the repository owner's username and the slugified name, e.g. "evzijst/interruptingcow". This is the same string used in Bitbucket URLs. | | `has_issues` | boolean | No | — | The issue tracker for this repository is enabled. Issue Tracker features are not supported for repositories in workspaces administered through admin.atlassian.com. | | `has_wiki` | boolean | No | — | The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com. | | `is_private` | boolean | No | — | Is Private | | `language` | string | No | — | The language value | | `links` | object | No | — | The links value | | `mainbranch` | object | No | — | The mainbranch value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/repository | | `project` | object | No | — | The project value | | `scm` | string | No | — | The scm value | | `size` | integer | No | — | The size value | | `type` | string | No | — | The type value | | `updated_on` | string | No | — | Updated On | | `uuid` | string | No | — | The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "created_on": { "type": "string", "description": "Created On" }, "description": { "type": "string", "description": "The description value" }, "fork_policy": { "type": "string", "description": "Controls the rules for forking this repository. * **allow_forks**: unrestricted forking * **no_public_forks**: restrict forking to private forks (forks cannot be made public later) * **no_forks**: deny all forking", "enum": [ "allow_forks", "no_public_forks", "no_forks" ] }, "full_name": { "type": "string", "description": "The concatenation of the repository owner's username and the slugified name, e.g. \"evzijst/interruptingcow\". This is the same string used in Bitbucket URLs." }, "has_issues": { "type": "boolean", "description": "The issue tracker for this repository is enabled. Issue Tracker features are not supported for repositories in workspaces administered through admin.atlassian.com." }, "has_wiki": { "type": "boolean", "description": "The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com." }, "is_private": { "type": "boolean", "description": "Is Private" }, "language": { "type": "string", "description": "The language value" }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "avatar": { "type": "object", "description": "A link to a resource related to this object." }, "pullrequests": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "forks": { "type": "object", "description": "A link to a resource related to this object." }, "watchers": { "type": "object", "description": "A link to a resource related to this object." }, "downloads": { "type": "object", "description": "A link to a resource related to this object." }, "clone": { "type": "array", "items": { "type": "object" }, "description": "The clone value" }, "hooks": { "type": "object", "description": "A link to a resource related to this object." } } }, "mainbranch": { "description": "The mainbranch value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "description": "The owner value" }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/repository" }, "project": { "description": "The project value" }, "scm": { "type": "string", "description": "The scm value", "enum": [ "git" ] }, "size": { "type": "integer", "description": "The size value" }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "uuid": { "type": "string", "description": "The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_create\_tag Create a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `date` | string | No | — | The date that the tag was created, if available | | `links` | object | No | — | The links value | | `message` | string | No | — | The message associated with the tag, if available. | | `name` | string | No | — | The name of the ref. | | `tagger` | object | No | — | The tagger value | | `target` | object | No | — | The target value | | `type` | string | Yes | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "date": { "type": "string", "description": "The date that the tag was created, if available" }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." } } }, "message": { "type": "string", "description": "The message associated with the tag, if available." }, "name": { "type": "string", "description": "The name of the ref." }, "tagger": { "description": "The tagger value" }, "target": { "description": "The target value" }, "type": { "type": "string", "description": "The type value" } }, "required": [ "PCID", "repo_slug", "workspace", "type" ] } ``` *** ## bitbucket\_repos\_create\_webhook Create a webhook for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `active` | boolean | No | — | The active value | | `created_at` | string | No | — | Created At | | `description` | string | No | — | A user-defined description of the webhook. | | `events` | string\[] | No | — | The events this webhook is subscribed to. | | `secret` | string | No | — | The secret to associate with the hook. The secret is never returned via the API. As such, this field is only used during updates. The secret can be set to `null` or "" to remove the secret (or create a hook with no secret). Leaving out the secret field during updates will leave the secret unchanged. Leaving out the secret during creation will create a hook with no secret. | | `secret_set` | boolean | No | — | Indicates whether or not the hook has an associated secret. It is not possible to see the hook's secret. This field is ignored during updates. | | `subject` | object | No | — | Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`. | | `subject_type` | string | No | — | The type of entity. Set to either `repository` or `workspace` based on where the subscription is defined. | | `type` | string | Yes | — | The type value | | `url` | string | No | — | The URL events get delivered to. | | `uuid` | string | No | — | The webhook's id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "active": { "type": "boolean", "description": "The active value" }, "created_at": { "type": "string", "description": "Created At" }, "description": { "type": "string", "description": "A user-defined description of the webhook." }, "events": { "type": "array", "items": { "type": "string", "enum": [ "issue:comment_created", "issue:created", "issue:updated", "pipeline:span_created", "project:updated", "pullrequest:approved", "pullrequest:changes_request_created", "pullrequest:changes_request_removed", "pullrequest:comment_created", "pullrequest:comment_deleted", "pullrequest:comment_reopened", "pullrequest:comment_resolved", "pullrequest:comment_updated", "pullrequest:created", "pullrequest:fulfilled", "pullrequest:push", "pullrequest:rejected", "pullrequest:unapproved", "pullrequest:updated", "repo:commit_comment_created", "repo:commit_status_created", "repo:commit_status_updated", "repo:created", "repo:deleted", "repo:fork", "repo:imported", "repo:push", "repo:transfer", "repo:updated" ] }, "description": "The events this webhook is subscribed to." }, "secret": { "type": "string", "description": "The secret to associate with the hook. The secret is never returned via the API. As such, this field is only used during updates. The secret can be set to `null` or \"\" to remove the secret (or create a hook with no secret). Leaving out the secret field during updates will leave the secret unchanged. Leaving out the secret during creation will create a hook with no secret." }, "secret_set": { "type": "boolean", "description": "Indicates whether or not the hook has an associated secret. It is not possible to see the hook's secret. This field is ignored during updates." }, "subject": { "type": "object", "description": "Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.", "properties": { "type": { "type": "string", "description": "The type value" } }, "required": [ "type" ] }, "subject_type": { "type": "string", "description": "The type of entity. Set to either `repository` or `workspace` based on where the subscription is defined.", "enum": [ "repository", "workspace" ] }, "type": { "type": "string", "description": "The type value" }, "url": { "type": "string", "description": "The URL events get delivered to." }, "uuid": { "type": "string", "description": "The webhook's id" } }, "required": [ "PCID", "repo_slug", "workspace", "type" ] } ``` *** ## bitbucket\_repos\_delete\_branch Delete a branch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | The name of the branch. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the branch." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "name", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_delete\_repository Delete a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `redirect_to` | string | No | — | If a repository has been moved to a new location, use this parameter to show users a friendly message in the Bitbucket UI that the repository has moved to a new location. However, a GET to this endpoint will still return a 404. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "redirect_to": { "type": "string", "description": "If a repository has been moved to a new location, use this parameter to show users a friendly message in the Bitbucket UI that the repository has moved to a new location. However, a GET to this endpoint will still return a 404." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_delete\_tag Delete a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | The name of the tag. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the tag." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "name", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_delete\_webhook Delete a webhook for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `uid` | string | Yes | — | Installed webhook's ID | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "uid": { "type": "string", "description": "Installed webhook's ID" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "uid", "workspace" ] } ``` *** ## bitbucket\_repos\_fork\_repository Fork a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `created_on` | string | No | — | Created On | | `description` | string | No | — | The description value | | `fork_policy` | string | No | — | Controls the rules for forking this repository. \* **allow\_forks**: unrestricted forking \* **no\_public\_forks**: restrict forking to private forks (forks cannot be made public later) \* **no\_forks**: deny all forking | | `full_name` | string | No | — | The concatenation of the repository owner's username and the slugified name, e.g. "evzijst/interruptingcow". This is the same string used in Bitbucket URLs. | | `has_issues` | boolean | No | — | The issue tracker for this repository is enabled. Issue Tracker features are not supported for repositories in workspaces administered through admin.atlassian.com. | | `has_wiki` | boolean | No | — | The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com. | | `is_private` | boolean | No | — | Is Private | | `language` | string | No | — | The language value | | `links` | object | No | — | The links value | | `mainbranch` | object | No | — | The mainbranch value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/repository | | `project` | object | No | — | The project value | | `scm` | string | No | — | The scm value | | `size` | integer | No | — | The size value | | `type` | string | No | — | The type value | | `updated_on` | string | No | — | Updated On | | `uuid` | string | No | — | The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "created_on": { "type": "string", "description": "Created On" }, "description": { "type": "string", "description": "The description value" }, "fork_policy": { "type": "string", "description": "Controls the rules for forking this repository. * **allow_forks**: unrestricted forking * **no_public_forks**: restrict forking to private forks (forks cannot be made public later) * **no_forks**: deny all forking", "enum": [ "allow_forks", "no_public_forks", "no_forks" ] }, "full_name": { "type": "string", "description": "The concatenation of the repository owner's username and the slugified name, e.g. \"evzijst/interruptingcow\". This is the same string used in Bitbucket URLs." }, "has_issues": { "type": "boolean", "description": "The issue tracker for this repository is enabled. Issue Tracker features are not supported for repositories in workspaces administered through admin.atlassian.com." }, "has_wiki": { "type": "boolean", "description": "The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com." }, "is_private": { "type": "boolean", "description": "Is Private" }, "language": { "type": "string", "description": "The language value" }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "avatar": { "type": "object", "description": "A link to a resource related to this object." }, "pullrequests": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "forks": { "type": "object", "description": "A link to a resource related to this object." }, "watchers": { "type": "object", "description": "A link to a resource related to this object." }, "downloads": { "type": "object", "description": "A link to a resource related to this object." }, "clone": { "type": "array", "items": { "type": "object" }, "description": "The clone value" }, "hooks": { "type": "object", "description": "A link to a resource related to this object." } } }, "mainbranch": { "description": "The mainbranch value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "description": "The owner value" }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/repository" }, "project": { "description": "The project value" }, "scm": { "type": "string", "description": "The scm value", "enum": [ "git" ] }, "size": { "type": "integer", "description": "The size value" }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "uuid": { "type": "string", "description": "The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_branch Get a branch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | The name of the branch. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the branch." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "name", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_branching\_model Get the branching model for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_branching\_model\_settings Get the branching model config for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_commit Get a commit **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `commit` | string | Yes | — | The commit's SHA1. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commit": { "type": "string", "description": "The commit's SHA1." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "commit", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_diff Compare two commits **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `spec` | string | Yes | — | A commit SHA (e.g. `3a8b42`) or a commit range using double dot notation (e.g. `3a8b42..9ff173`). | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `context` | integer | No | — | Generate diffs with \ lines of context instead of the usual three. | | `path` | string | No | — | Limit the diff to a particular file (this parameter can be repeated for multiple paths). | | `ignore_whitespace` | boolean | No | — | Generate diffs that ignore whitespace. | | `binary` | boolean | No | — | Generate diffs that include binary files, true if omitted. | | `renames` | boolean | No | — | Whether to perform rename detection, true if omitted. | | `merge` | boolean | No | — | This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time. If true, the source commit is merged into the destination commit, and then a diff from the destination to the merge result is returned. If false, a simple 'two dot' diff between the source and destination is returned. True if omitted. | | `topic` | boolean | No | — | If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned. If omitted, defaults to true, ie. a 2 way 'three-dot' diff is returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "spec": { "type": "string", "description": "A commit SHA (e.g. `3a8b42`) or a commit range using double dot notation (e.g. `3a8b42..9ff173`)." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "context": { "type": "integer", "description": "Generate diffs with lines of context instead of the usual three." }, "path": { "type": "string", "description": "Limit the diff to a particular file (this parameter can be repeated for multiple paths)." }, "ignore_whitespace": { "type": "boolean", "description": "Generate diffs that ignore whitespace." }, "binary": { "type": "boolean", "description": "Generate diffs that include binary files, true if omitted." }, "renames": { "type": "boolean", "description": "Whether to perform rename detection, true if omitted." }, "merge": { "type": "boolean", "description": "This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time. If true, the source commit is merged into the destination commit, and then a diff from the destination to the merge result is returned. If false, a simple 'two dot' diff between the source and destination is returned. True if omitted." }, "topic": { "type": "boolean", "description": "If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned. If omitted, defaults to true, ie. a 2 way 'three-dot' diff is returned." } }, "required": [ "PCID", "repo_slug", "spec", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_diffstat Compare two commit diff stats **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ignore_whitespace` | boolean | No | — | Generate diffs that ignore whitespace | | `merge` | boolean | No | — | This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time. If true, the source commit is merged into the destination commit, and then a diffstat from the destination to the merge result is returned. If false, a simple 'two dot' diffstat between the source and destination is returned. True if omitted. | | `path` | string | No | — | Limit the diffstat to a particular file (this parameter can be repeated for multiple paths). | | `renames` | boolean | No | — | Whether to perform rename detection, true if omitted. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `spec` | string | Yes | — | A commit SHA (e.g. `3a8b42`) or a commit range using double dot notation (e.g. `3a8b42..9ff173`). | | `topic` | boolean | No | — | If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ignore_whitespace": { "type": "boolean", "description": "Generate diffs that ignore whitespace" }, "merge": { "type": "boolean", "description": "This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time. If true, the source commit is merged into the destination commit, and then a diffstat from the destination to the merge result is returned. If false, a simple 'two dot' diffstat between the source and destination is returned. True if omitted." }, "path": { "type": "string", "description": "Limit the diffstat to a particular file (this parameter can be repeated for multiple paths)." }, "renames": { "type": "boolean", "description": "Whether to perform rename detection, true if omitted." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "spec": { "type": "string", "description": "A commit SHA (e.g. `3a8b42`) or a commit range using double dot notation (e.g. `3a8b42..9ff173`)." }, "topic": { "type": "boolean", "description": "If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "spec", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_file\_content Get file or directory contents **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `commit` | string | Yes | — | The commit's SHA1. | | `path` | string | Yes | — | Path to the file. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `format` | string | No | — | If 'meta' is provided, returns the (json) meta data for the contents of the file. If 'rendered' is provided, returns the contents of a non-binary file in HTML-formatted rendered markup. The 'rendered' option only supports these filetypes: `.md`, `.markdown`, `.mkd`, `.mkdn`, `.mdown`, `.text`, `.rst`, and `.textile`. Since Git does not generally track what text encoding scheme is used, this endpoint attempts to detect the most appropriate character encoding. While usually correct, determining the character encoding can be ambiguous which in exceptional cases can lead to misinterpretation of the characters. As such, the raw element in the response object should not be treated as equivalent to the file's actual contents. | | `q` | string | No | — | Optional filter expression as per filtering and sorting. | | `sort` | string | No | — | Optional sorting parameter as per filtering and sorting. | | `max_depth` | integer | No | — | If provided, returns the contents of the repository and its subdirectories recursively until the specified max\_depth of nested directories. When omitted, this defaults to 1. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commit": { "type": "string", "description": "The commit's SHA1." }, "path": { "type": "string", "description": "Path to the file." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "format": { "type": "string", "description": "If 'meta' is provided, returns the (json) meta data for the contents of the file. If 'rendered' is provided, returns the contents of a non-binary file in HTML-formatted rendered markup. The 'rendered' option only supports these filetypes: `.md`, `.markdown`, `.mkd`, `.mkdn`, `.mdown`, `.text`, `.rst`, and `.textile`. Since Git does not generally track what text encoding scheme is used, this endpoint attempts to detect the most appropriate character encoding. While usually correct, determining the character encoding can be ambiguous which in exceptional cases can lead to misinterpretation of the characters. As such, the raw element in the response object should not be treated as equivalent to the file's actual contents.", "enum": [ "meta", "rendered" ] }, "q": { "type": "string", "description": "Optional filter expression as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Optional sorting parameter as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)." }, "max_depth": { "type": "integer", "description": "If provided, returns the contents of the repository and its subdirectories recursively until the specified max_depth of nested directories. When omitted, this defaults to 1." } }, "required": [ "PCID", "commit", "path", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_file\_history List commits that modified a file **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `commit` | string | Yes | — | The commit's SHA1. | | `path` | string | Yes | — | Path to the file. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `renames` | string | No | — | When `true`, Bitbucket will follow the history of the file across renames (this is the default behavior). This can be turned off by specifying `false`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Name of a response property sort the result by as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commit": { "type": "string", "description": "The commit's SHA1." }, "path": { "type": "string", "description": "Path to the file." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "renames": { "type": "string", "description": "When `true`, Bitbucket will follow the history of the file across renames (this is the default behavior). This can be turned off by specifying `false`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Name of a response property sort the result by as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)." } }, "required": [ "PCID", "commit", "path", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_repository Get a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_tag Get a tag **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | The name of the tag. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the tag." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "name", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_webhook Get a webhook for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `uid` | string | Yes | — | Installed webhook's ID | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "uid": { "type": "string", "description": "Installed webhook's ID" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "uid", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_branches List open branches **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. The `name` field is handled specially for branches in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return \['branch1', 'branch2', 'branch10'] instead of \['branch1', 'branch10', 'branch2']. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name` field is handled specially for branches in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return ['branch1', 'branch2', 'branch10'] instead of ['branch1', 'branch10', 'branch2']." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_commit\_comments List a commit's comments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `commit` | string | Yes | — | The commit's SHA1. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commit": { "type": "string", "description": "The commit's SHA1." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." } }, "required": [ "PCID", "commit", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_commit\_statuses List commit statuses for a commit **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `commit` | string | Yes | — | The commit's SHA1. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `refname` | string | No | — | If specified, only return commit status objects that were either created without a refname, or were created with the specified refname | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. Defaults to `created_on`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commit": { "type": "string", "description": "The commit's SHA1." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "refname": { "type": "string", "description": "If specified, only return commit status objects that were either created without a refname, or were created with the specified refname" }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). Defaults to `created_on`." } }, "required": [ "PCID", "commit", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_commits List commits **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_refs List branches and tags **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. The `name` field is handled specially for refs in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return \['1.1', '1.2', '1.10'] instead of \['1.1', '1.10', '1.2']. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name` field is handled specially for refs in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return ['1.1', '1.2', '1.10'] instead of ['1.1', '1.10', '1.2']." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_repositories List repositories in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `role` | string | No | — | Filters the result based on the authenticated user's role on each repository. \* **member**: returns repositories to which the user has explicit read access \* **contributor**: returns repositories to which the user has explicit write access \* **admin**: returns repositories to which the user has explicit administrator access \* **owner**: returns all repositories owned by the current user | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "role": { "type": "string", "description": "Filters the result based on the authenticated user's role on each repository. * **member**: returns repositories to which the user has explicit read access * **contributor**: returns repositories to which the user has explicit write access * **admin**: returns repositories to which the user has explicit administrator access * **owner**: returns all repositories owned by the current user", "enum": [ "admin", "contributor", "member", "owner" ] }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." } }, "required": [ "PCID", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_repository\_forks List repository forks **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `role` | string | No | — | Filters the result based on the authenticated user's role on each repository. \* **member**: returns repositories to which the user has explicit read access \* **contributor**: returns repositories to which the user has explicit write access \* **admin**: returns repositories to which the user has explicit administrator access \* **owner**: returns all repositories owned by the current user | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "role": { "type": "string", "description": "Filters the result based on the authenticated user's role on each repository. * **member**: returns repositories to which the user has explicit read access * **contributor**: returns repositories to which the user has explicit write access * **admin**: returns repositories to which the user has explicit administrator access * **owner**: returns all repositories owned by the current user", "enum": [ "admin", "contributor", "member", "owner" ] }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_repository\_watchers List repositories watchers **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_tags List tags **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. The `name` field is handled specially for tags in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return \['1.1', '1.2', '1.10'] instead of \['1.1', '1.10', '1.2']. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name` field is handled specially for tags in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return ['1.1', '1.2', '1.10'] instead of ['1.1', '1.10', '1.2']." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_webhooks List webhooks for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_update\_repository Update a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `created_on` | string | No | — | Created On | | `description` | string | No | — | The description value | | `fork_policy` | string | No | — | Controls the rules for forking this repository. \* **allow\_forks**: unrestricted forking \* **no\_public\_forks**: restrict forking to private forks (forks cannot be made public later) \* **no\_forks**: deny all forking | | `full_name` | string | No | — | The concatenation of the repository owner's username and the slugified name, e.g. "evzijst/interruptingcow". This is the same string used in Bitbucket URLs. | | `has_issues` | boolean | No | — | The issue tracker for this repository is enabled. Issue Tracker features are not supported for repositories in workspaces administered through admin.atlassian.com. | | `has_wiki` | boolean | No | — | The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com. | | `is_private` | boolean | No | — | Is Private | | `language` | string | No | — | The language value | | `links` | object | No | — | The links value | | `mainbranch` | object | No | — | The mainbranch value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/repository | | `project` | object | No | — | The project value | | `scm` | string | No | — | The scm value | | `size` | integer | No | — | The size value | | `type` | string | No | — | The type value | | `updated_on` | string | No | — | Updated On | | `uuid` | string | No | — | The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "created_on": { "type": "string", "description": "Created On" }, "description": { "type": "string", "description": "The description value" }, "fork_policy": { "type": "string", "description": "Controls the rules for forking this repository. * **allow_forks**: unrestricted forking * **no_public_forks**: restrict forking to private forks (forks cannot be made public later) * **no_forks**: deny all forking", "enum": [ "allow_forks", "no_public_forks", "no_forks" ] }, "full_name": { "type": "string", "description": "The concatenation of the repository owner's username and the slugified name, e.g. \"evzijst/interruptingcow\". This is the same string used in Bitbucket URLs." }, "has_issues": { "type": "boolean", "description": "The issue tracker for this repository is enabled. Issue Tracker features are not supported for repositories in workspaces administered through admin.atlassian.com." }, "has_wiki": { "type": "boolean", "description": "The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com." }, "is_private": { "type": "boolean", "description": "Is Private" }, "language": { "type": "string", "description": "The language value" }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "avatar": { "type": "object", "description": "A link to a resource related to this object." }, "pullrequests": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "forks": { "type": "object", "description": "A link to a resource related to this object." }, "watchers": { "type": "object", "description": "A link to a resource related to this object." }, "downloads": { "type": "object", "description": "A link to a resource related to this object." }, "clone": { "type": "array", "items": { "type": "object" }, "description": "The clone value" }, "hooks": { "type": "object", "description": "A link to a resource related to this object." } } }, "mainbranch": { "description": "The mainbranch value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "description": "The owner value" }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/repository" }, "project": { "description": "The project value" }, "scm": { "type": "string", "description": "The scm value", "enum": [ "git" ] }, "size": { "type": "integer", "description": "The size value" }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "uuid": { "type": "string", "description": "The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_update\_webhook Update a webhook for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `uid` | string | Yes | — | Installed webhook's ID | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `active` | boolean | No | — | The active value | | `created_at` | string | No | — | Created At | | `description` | string | No | — | A user-defined description of the webhook. | | `events` | string\[] | No | — | The events this webhook is subscribed to. | | `secret` | string | No | — | The secret to associate with the hook. The secret is never returned via the API. As such, this field is only used during updates. The secret can be set to `null` or "" to remove the secret (or create a hook with no secret). Leaving out the secret field during updates will leave the secret unchanged. Leaving out the secret during creation will create a hook with no secret. | | `secret_set` | boolean | No | — | Indicates whether or not the hook has an associated secret. It is not possible to see the hook's secret. This field is ignored during updates. | | `subject` | object | No | — | Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`. | | `subject_type` | string | No | — | The type of entity. Set to either `repository` or `workspace` based on where the subscription is defined. | | `type` | string | Yes | — | The type value | | `url` | string | No | — | The URL events get delivered to. | | `uuid` | string | No | — | The webhook's id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "uid": { "type": "string", "description": "Installed webhook's ID" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "active": { "type": "boolean", "description": "The active value" }, "created_at": { "type": "string", "description": "Created At" }, "description": { "type": "string", "description": "A user-defined description of the webhook." }, "events": { "type": "array", "items": { "type": "string", "enum": [ "issue:comment_created", "issue:created", "issue:updated", "pipeline:span_created", "project:updated", "pullrequest:approved", "pullrequest:changes_request_created", "pullrequest:changes_request_removed", "pullrequest:comment_created", "pullrequest:comment_deleted", "pullrequest:comment_reopened", "pullrequest:comment_resolved", "pullrequest:comment_updated", "pullrequest:created", "pullrequest:fulfilled", "pullrequest:push", "pullrequest:rejected", "pullrequest:unapproved", "pullrequest:updated", "repo:commit_comment_created", "repo:commit_status_created", "repo:commit_status_updated", "repo:created", "repo:deleted", "repo:fork", "repo:imported", "repo:push", "repo:transfer", "repo:updated" ] }, "description": "The events this webhook is subscribed to." }, "secret": { "type": "string", "description": "The secret to associate with the hook. The secret is never returned via the API. As such, this field is only used during updates. The secret can be set to `null` or \"\" to remove the secret (or create a hook with no secret). Leaving out the secret field during updates will leave the secret unchanged. Leaving out the secret during creation will create a hook with no secret." }, "secret_set": { "type": "boolean", "description": "Indicates whether or not the hook has an associated secret. It is not possible to see the hook's secret. This field is ignored during updates." }, "subject": { "type": "object", "description": "Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.", "properties": { "type": { "type": "string", "description": "The type value" } }, "required": [ "type" ] }, "subject_type": { "type": "string", "description": "The type of entity. Set to either `repository` or `workspace` based on where the subscription is defined.", "enum": [ "repository", "workspace" ] }, "type": { "type": "string", "description": "The type value" }, "url": { "type": "string", "description": "The URL events get delivered to." }, "uuid": { "type": "string", "description": "The webhook's id" } }, "required": [ "PCID", "repo_slug", "uid", "workspace", "type" ] } ``` # bitbucket-workspaces Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bitbucket/bitbucket-workspaces Workspaces, projects, issues **Server path:** `/bitbucket-workspaces` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bitbucket_workspaces_create_issue`](#bitbucket_workspaces_create_issue) | Create an issue | | [`bitbucket_workspaces_create_issue_comment`](#bitbucket_workspaces_create_issue_comment) | Create a comment on an issue | | [`bitbucket_workspaces_create_project`](#bitbucket_workspaces_create_project) | Create a project in a workspace | | [`bitbucket_workspaces_delete_issue`](#bitbucket_workspaces_delete_issue) | Delete an issue | | [`bitbucket_workspaces_delete_project`](#bitbucket_workspaces_delete_project) | Delete a project for a workspace | | [`bitbucket_workspaces_get_current_user`](#bitbucket_workspaces_get_current_user) | Get current user | | [`bitbucket_workspaces_get_issue`](#bitbucket_workspaces_get_issue) | Get an issue | | [`bitbucket_workspaces_get_project`](#bitbucket_workspaces_get_project) | Get a project for a workspace | | [`bitbucket_workspaces_get_workspace`](#bitbucket_workspaces_get_workspace) | Get a workspace | | [`bitbucket_workspaces_list_issue_comments`](#bitbucket_workspaces_list_issue_comments) | List comments on an issue | | [`bitbucket_workspaces_list_issues`](#bitbucket_workspaces_list_issues) | List issues | | [`bitbucket_workspaces_list_projects`](#bitbucket_workspaces_list_projects) | List projects in a workspace | | [`bitbucket_workspaces_list_repository_permissions`](#bitbucket_workspaces_list_repository_permissions) | List all repository permissions for a workspace | | [`bitbucket_workspaces_list_user_workspace_permissions`](#bitbucket_workspaces_list_user_workspace_permissions) | List workspaces for the current user | | [`bitbucket_workspaces_list_workspace_members`](#bitbucket_workspaces_list_workspace_members) | List users in a workspace | | [`bitbucket_workspaces_list_workspace_permissions`](#bitbucket_workspaces_list_workspace_permissions) | List user permissions in a workspace | | [`bitbucket_workspaces_list_workspaces`](#bitbucket_workspaces_list_workspaces) | List workspaces for user | | [`bitbucket_workspaces_search_code`](#bitbucket_workspaces_search_code) | Search for code in a workspace | | [`bitbucket_workspaces_update_issue`](#bitbucket_workspaces_update_issue) | Update an issue | | [`bitbucket_workspaces_update_project`](#bitbucket_workspaces_update_project) | Update a project for a workspace | *** ## bitbucket\_workspaces\_create\_issue Create an issue **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `assignee` | object | No | — | The assignee value | | `component` | object | No | — | The component value | | `content` | object | No | — | The content value | | `created_on` | string | No | — | Created On | | `edited_on` | string | No | — | Edited On | | `id` | integer | No | — | The id value | | `kind` | string | No | — | The kind value | | `links` | object | No | — | The links value | | `milestone` | object | No | — | The milestone value | | `priority` | string | No | — | The priority value | | `reporter` | object | No | — | The reporter value | | `repository` | object | No | — | The repository value | | `state` | string | No | — | The state value | | `title` | string | No | — | The title value | | `type` | string | Yes | — | The type value | | `updated_on` | string | No | — | Updated On | | `version` | object | No | — | The version value | | `votes` | integer | No | — | The votes value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "assignee": { "description": "The assignee value" }, "component": { "description": "The component value" }, "content": { "type": "object", "description": "The content value", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "type": "string", "description": "The type of markup language the raw content is to be interpreted in.", "enum": [ "markdown", "creole", "plaintext" ] }, "html": { "type": "string", "description": "The user's content rendered as HTML." } } }, "created_on": { "type": "string", "description": "Created On" }, "edited_on": { "type": "string", "description": "Edited On" }, "id": { "type": "integer", "description": "The id value" }, "kind": { "type": "string", "description": "The kind value", "enum": [ "bug", "enhancement", "proposal", "task" ] }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "comments": { "type": "object", "description": "A link to a resource related to this object." }, "attachments": { "type": "object", "description": "A link to a resource related to this object." }, "watch": { "type": "object", "description": "A link to a resource related to this object." }, "vote": { "type": "object", "description": "A link to a resource related to this object." } } }, "milestone": { "description": "The milestone value" }, "priority": { "type": "string", "description": "The priority value", "enum": [ "trivial", "minor", "major", "critical", "blocker" ] }, "reporter": { "description": "The reporter value" }, "repository": { "description": "The repository value" }, "state": { "type": "string", "description": "The state value", "enum": [ "submitted", "new", "open", "resolved", "on hold", "invalid", "duplicate", "wontfix", "closed" ] }, "title": { "type": "string", "description": "The title value" }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "version": { "description": "The version value" }, "votes": { "type": "integer", "description": "The votes value" } }, "required": [ "PCID", "repo_slug", "workspace", "type" ] } ``` *** ## bitbucket\_workspaces\_create\_issue\_comment Create a comment on an issue **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `issue_id` | string | Yes | — | The issue id | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `content` | object | No | — | The content value | | `created_on` | string | No | — | Created On | | `deleted` | boolean | No | — | The deleted value | | `id` | integer | No | — | The id value | | `inline` | object | No | — | The inline value | | `issue` | object | No | — | The issue value | | `links` | object | No | — | The links value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/comment | | `type` | string | Yes | — | The type value | | `updated_on` | string | No | — | Updated On | | `user` | object | No | — | The user value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "issue_id": { "type": "string", "description": "The issue id" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "content": { "type": "object", "description": "The content value", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "type": "string", "description": "The type of markup language the raw content is to be interpreted in.", "enum": [ "markdown", "creole", "plaintext" ] }, "html": { "type": "string", "description": "The user's content rendered as HTML." } } }, "created_on": { "type": "string", "description": "Created On" }, "deleted": { "type": "boolean", "description": "The deleted value" }, "id": { "type": "integer", "description": "The id value" }, "inline": { "type": "object", "description": "The inline value", "properties": { "from": { "type": "integer", "description": "The comment's anchor line in the old version of the file. If the comment is a multi-line comment, this is the ending line number in the old version of the file." }, "to": { "type": "integer", "description": "The comment's anchor line in the new version of the file. If the comment is a multi-line comment, this is the ending line number in the new version of the file." }, "start_from": { "type": "integer", "description": "The starting line number in the old version of the file, if the comment is a multi-line comment. This is null otherwise." }, "start_to": { "type": "integer", "description": "The starting line number in the new version of the file, if the comment is a multi-line comment. This is null otherwise." }, "path": { "type": "string", "description": "The path of the file this comment is anchored to." } }, "required": [ "path" ] }, "issue": { "description": "The issue value" }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "code": { "type": "object", "description": "A link to a resource related to this object." } } }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/comment" }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "user": { "description": "The user value" } }, "required": [ "PCID", "issue_id", "repo_slug", "workspace", "type" ] } ``` *** ## bitbucket\_workspaces\_create\_project Create a project in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `created_on` | string | No | — | Created On | | `description` | string | No | — | The description value | | `has_publicly_visible_repos` | boolean | No | — | Indicates whether the project contains publicly visible repositories. Note that private projects cannot contain public repositories. | | `is_private` | boolean | No | — | Indicates whether the project is publicly accessible, or whether it is private to the team and consequently only visible to team members. Note that private projects cannot contain public repositories. | | `key` | string | No | — | The project's key. | | `links` | object | No | — | The links value | | `name` | string | No | — | The name of the project. | | `owner` | object | No | — | The owner value | | `type` | string | Yes | — | The type value | | `updated_on` | string | No | — | Updated On | | `uuid` | string | No | — | The project's immutable id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "created_on": { "type": "string", "description": "Created On" }, "description": { "type": "string", "description": "The description value" }, "has_publicly_visible_repos": { "type": "boolean", "description": "Indicates whether the project contains publicly visible repositories. Note that private projects cannot contain public repositories." }, "is_private": { "type": "boolean", "description": "Indicates whether the project is publicly accessible, or whether it is private to the team and consequently only visible to team members. Note that private projects cannot contain public repositories." }, "key": { "type": "string", "description": "The project's key." }, "links": { "type": "object", "description": "The links value", "properties": { "html": { "type": "object", "description": "A link to a resource related to this object." }, "avatar": { "type": "object", "description": "A link to a resource related to this object." } } }, "name": { "type": "string", "description": "The name of the project." }, "owner": { "description": "The owner value" }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "uuid": { "type": "string", "description": "The project's immutable id." } }, "required": [ "PCID", "workspace", "type" ] } ``` *** ## bitbucket\_workspaces\_delete\_issue Delete an issue **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `issue_id` | string | Yes | — | The issue id | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "issue_id": { "type": "string", "description": "The issue id" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "issue_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_workspaces\_delete\_project Delete a project for a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_key` | string | Yes | — | The project in question. This is the actual `key` assigned to the project. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_key": { "type": "string", "description": "The project in question. This is the actual `key` assigned to the project." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "project_key", "workspace" ] } ``` *** ## bitbucket\_workspaces\_get\_current\_user Get current user ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bitbucket\_workspaces\_get\_issue Get an issue **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `issue_id` | string | Yes | — | The issue id | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "issue_id": { "type": "string", "description": "The issue id" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "issue_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_workspaces\_get\_project Get a project for a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_key` | string | Yes | — | The project in question. This is the actual `key` assigned to the project. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_key": { "type": "string", "description": "The project in question. This is the actual `key` assigned to the project." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "project_key", "workspace" ] } ``` *** ## bitbucket\_workspaces\_get\_workspace Get a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "workspace" ] } ``` *** ## bitbucket\_workspaces\_list\_issue\_comments List comments on an issue **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `issue_id` | string | Yes | — | The issue id | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "issue_id": { "type": "string", "description": "The issue id" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." } }, "required": [ "PCID", "issue_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_workspaces\_list\_issues List issues **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_workspaces\_list\_projects List projects in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "workspace" ] } ``` *** ## bitbucket\_workspaces\_list\_repository\_permissions List all repository permissions for a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Name of a response property sort the result by as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Name of a response property sort the result by as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)." } }, "required": [ "PCID", "workspace" ] } ``` *** ## bitbucket\_workspaces\_list\_user\_workspace\_permissions List workspaces for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `q` | string | No | — | Query string to narrow down the response. See filtering and sorting for details. | | `sort` | string | No | — | Name of a response property to sort results. See filtering and sorting for details. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "q": { "type": "string", "description": "Query string to narrow down the response. See [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details." }, "sort": { "type": "string", "description": "Name of a response property to sort results. See [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results) for details." } }, "required": [ "PCID" ] } ``` *** ## bitbucket\_workspaces\_list\_workspace\_members List users in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "workspace" ] } ``` *** ## bitbucket\_workspaces\_list\_workspace\_permissions List user permissions in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." } }, "required": [ "PCID", "workspace" ] } ``` *** ## bitbucket\_workspaces\_list\_workspaces List workspaces for user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `role` | string | No | — | Filters the workspaces based on the authenticated user's role on each workspace. \* **member**: returns a list of all the workspaces which the caller is a member of at least one workspace group or repository \* **collaborator**: returns a list of workspaces which the caller has write access to at least one repository in the workspace \* **owner**: returns a list of workspaces which the caller has administrator access | | `q` | string | No | — | Query string to narrow down the response. See filtering and sorting for details. | | `sort` | string | No | — | Name of a response property to sort results. See filtering and sorting for details. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "role": { "type": "string", "description": "Filters the workspaces based on the authenticated user's role on each workspace. * **member**: returns a list of all the workspaces which the caller is a member of at least one workspace group or repository * **collaborator**: returns a list of workspaces which the caller has write access to at least one repository in the workspace * **owner**: returns a list of workspaces which the caller has administrator access", "enum": [ "owner", "collaborator", "member" ] }, "q": { "type": "string", "description": "Query string to narrow down the response. See [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details." }, "sort": { "type": "string", "description": "Name of a response property to sort results. See [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results) for details." } }, "required": [ "PCID" ] } ``` *** ## bitbucket\_workspaces\_search\_code Search for code in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `workspace` | string | Yes | — | The workspace to search in; either the slug or the UUID in curly braces | | `search_query` | string | Yes | — | The search query | | `page` | integer | No | — | Which page of the search results to retrieve | | `pagelen` | integer | No | — | How many search results to retrieve per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "The workspace to search in; either the slug or the UUID in curly braces" }, "search_query": { "type": "string", "description": "The search query" }, "page": { "type": "integer", "description": "Which page of the search results to retrieve" }, "pagelen": { "type": "integer", "description": "How many search results to retrieve per page" } }, "required": [ "PCID", "workspace", "search_query" ] } ``` *** ## bitbucket\_workspaces\_update\_issue Update an issue **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `issue_id` | string | Yes | — | The issue id | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "issue_id": { "type": "string", "description": "The issue id" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "issue_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_workspaces\_update\_project Update a project for a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `project_key` | string | Yes | — | The project in question. This is the actual `key` assigned to the project. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `created_on` | string | No | — | Created On | | `description` | string | No | — | The description value | | `has_publicly_visible_repos` | boolean | No | — | Indicates whether the project contains publicly visible repositories. Note that private projects cannot contain public repositories. | | `is_private` | boolean | No | — | Indicates whether the project is publicly accessible, or whether it is private to the team and consequently only visible to team members. Note that private projects cannot contain public repositories. | | `key` | string | No | — | The project's key. | | `links` | object | No | — | The links value | | `name` | string | No | — | The name of the project. | | `owner` | object | No | — | The owner value | | `type` | string | Yes | — | The type value | | `updated_on` | string | No | — | Updated On | | `uuid` | string | No | — | The project's immutable id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_key": { "type": "string", "description": "The project in question. This is the actual `key` assigned to the project." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "created_on": { "type": "string", "description": "Created On" }, "description": { "type": "string", "description": "The description value" }, "has_publicly_visible_repos": { "type": "boolean", "description": "Indicates whether the project contains publicly visible repositories. Note that private projects cannot contain public repositories." }, "is_private": { "type": "boolean", "description": "Indicates whether the project is publicly accessible, or whether it is private to the team and consequently only visible to team members. Note that private projects cannot contain public repositories." }, "key": { "type": "string", "description": "The project's key." }, "links": { "type": "object", "description": "The links value", "properties": { "html": { "type": "object", "description": "A link to a resource related to this object." }, "avatar": { "type": "object", "description": "A link to a resource related to this object." } } }, "name": { "type": "string", "description": "The name of the project." }, "owner": { "description": "The owner value" }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "uuid": { "type": "string", "description": "The project's immutable id." } }, "required": [ "PCID", "project_key", "workspace", "type" ] } ``` # Bitly Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bitly Bitly official MCP server. Link creation, customization, analytics, QR codes, and link management. Tools are discovered at runtime using an existing connection. **Server path:** `/bitly` | **Type:** Application (Remote MCP) | **PCID required:** Yes Tools are discovered at runtime from the upstream MCP server at `https://api-ssl.bitly.com/v4/mcp`. Authenticate via `apikey`. Use a `bitly` PinkConnect connection. # bitwarden Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bitwarden Bitwarden Organization API **Server path:** `/bitwarden` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bitwarden_create_group`](#bitwarden_create_group) | Create a group | | [`bitwarden_create_member`](#bitwarden_create_member) | Invite a member | | [`bitwarden_delete_collection`](#bitwarden_delete_collection) | Delete a collection | | [`bitwarden_delete_group`](#bitwarden_delete_group) | Delete a group | | [`bitwarden_delete_member`](#bitwarden_delete_member) | Remove a member | | [`bitwarden_get_collection`](#bitwarden_get_collection) | Retrieve a collection | | [`bitwarden_get_group`](#bitwarden_get_group) | Retrieve a group | | [`bitwarden_get_group_member_ids`](#bitwarden_get_group_member_ids) | Get group member IDs | | [`bitwarden_get_member`](#bitwarden_get_member) | Retrieve a member | | [`bitwarden_get_member_group_ids`](#bitwarden_get_member_group_ids) | Get member group IDs | | [`bitwarden_get_policy`](#bitwarden_get_policy) | Retrieve a policy | | [`bitwarden_import_organization`](#bitwarden_import_organization) | Import members and groups | | [`bitwarden_list_collections`](#bitwarden_list_collections) | List all collections | | [`bitwarden_list_events`](#bitwarden_list_events) | List events | | [`bitwarden_list_groups`](#bitwarden_list_groups) | List all groups | | [`bitwarden_list_members`](#bitwarden_list_members) | List all members | | [`bitwarden_list_policies`](#bitwarden_list_policies) | List all policies | | [`bitwarden_reinvite_member`](#bitwarden_reinvite_member) | Re-invite a member | | [`bitwarden_restore_member`](#bitwarden_restore_member) | Restore a revoked member | | [`bitwarden_revoke_member`](#bitwarden_revoke_member) | Revoke member access | | [`bitwarden_update_collection`](#bitwarden_update_collection) | Update a collection | | [`bitwarden_update_group`](#bitwarden_update_group) | Update a group | | [`bitwarden_update_group_member_ids`](#bitwarden_update_group_member_ids) | Update group members | | [`bitwarden_update_member`](#bitwarden_update_member) | Update a member | | [`bitwarden_update_member_group_ids`](#bitwarden_update_member_group_ids) | Update member groups | | [`bitwarden_update_policy`](#bitwarden_update_policy) | Update a policy | *** ## bitwarden\_create\_group Create a group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `collections` | object\[] | No | — | Collection associations with permissions. | | `externalId` | string | No | — | External identifier for directory sync. | | `name` | string | Yes | — | The name of the group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "collections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The associated object identifier (UUID)." }, "readOnly": { "type": "boolean", "description": "Whether this association grants read-only access." }, "hidePasswords": { "type": "boolean", "description": "Whether passwords are hidden for this association." }, "manage": { "type": "boolean", "description": "Whether this association grants management permissions." } }, "required": [ "id", "readOnly" ] }, "description": "Collection associations with permissions." }, "externalId": { "type": "string", "description": "External identifier for directory sync." }, "name": { "type": "string", "description": "The name of the group." } }, "required": [ "PCID", "name" ] } ``` *** ## bitwarden\_create\_member Invite a member **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `collections` | object\[] | No | — | Collection associations with permissions. | | `email` | string | Yes | — | Email address for the member invitation. | | `externalId` | string | No | — | External identifier for directory sync. | | `groups` | string\[] | No | — | Group IDs to assign the member to. | | `permissions` | object | No | — | Custom permissions for a member with type=Custom (4). | | `type` | integer | Yes | — | Member type/role. 0=Owner, 1=Admin, 2=User, 3=Manager, 4=Custom. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "collections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The associated object identifier (UUID)." }, "readOnly": { "type": "boolean", "description": "Whether this association grants read-only access." }, "hidePasswords": { "type": "boolean", "description": "Whether passwords are hidden for this association." }, "manage": { "type": "boolean", "description": "Whether this association grants management permissions." } }, "required": [ "id", "readOnly" ] }, "description": "Collection associations with permissions." }, "email": { "type": "string", "description": "Email address for the member invitation." }, "externalId": { "type": "string", "description": "External identifier for directory sync." }, "groups": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Group IDs to assign the member to." }, "permissions": { "type": "object", "description": "Custom permissions for a member with type=Custom (4).", "properties": { "accessEventLogs": { "type": "boolean", "description": "Can access event logs." }, "accessImportExport": { "type": "boolean", "description": "Can access import/export." }, "accessReports": { "type": "boolean", "description": "Can access reports." }, "createNewCollections": { "type": "boolean", "description": "Can create new collections." }, "editAnyCollection": { "type": "boolean", "description": "Can edit any collection." }, "deleteAnyCollection": { "type": "boolean", "description": "Can delete any collection." }, "manageGroups": { "type": "boolean", "description": "Can manage groups." }, "managePolicies": { "type": "boolean", "description": "Can manage policies." }, "manageSso": { "type": "boolean", "description": "Can manage SSO." }, "manageUsers": { "type": "boolean", "description": "Can manage users." }, "manageResetPassword": { "type": "boolean", "description": "Can manage password reset." }, "manageScim": { "type": "boolean", "description": "Can manage SCIM provisioning." } } }, "type": { "type": "integer", "description": "Member type/role. 0=Owner, 1=Admin, 2=User, 3=Manager, 4=Custom." } }, "required": [ "PCID", "email", "type" ] } ``` *** ## bitwarden\_delete\_collection Delete a collection **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The collection identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The collection identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_delete\_group Delete a group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The group identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The group identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_delete\_member Remove a member **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The member identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The member identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_get\_collection Retrieve a collection **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The collection identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The collection identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_get\_group Retrieve a group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The group identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The group identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_get\_group\_member\_ids Get group member IDs **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The group identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The group identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_get\_member Retrieve a member **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The member identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The member identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_get\_member\_group\_ids Get member group IDs **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The member identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The member identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_get\_policy Retrieve a policy **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `type` | integer | Yes | — | The policy type (integer). 0=TwoFactorAuthentication, 1=MasterPassword, 2=PasswordGenerator, 3=SingleOrg, 4=RequireSso, 5=PersonalOwnership, 6=DisableSend, 7=SendOptions, 8=ResetPassword, 9=MaximumVaultTimeout, 10=DisablePersonalVaultExport, 11=ActivateAutofill, 12=AutomaticAppLogIn, 13=FreeFamiliesSponsorshipPolicy. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "type": { "type": "integer", "description": "The policy type (integer). 0=TwoFactorAuthentication, 1=MasterPassword, 2=PasswordGenerator, 3=SingleOrg, 4=RequireSso, 5=PersonalOwnership, 6=DisableSend, 7=SendOptions, 8=ResetPassword, 9=MaximumVaultTimeout, 10=DisablePersonalVaultExport, 11=ActivateAutofill, 12=AutomaticAppLogIn, 13=FreeFamiliesSponsorshipPolicy." } }, "required": [ "PCID", "type" ] } ``` *** ## bitwarden\_import\_organization Import members and groups **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `groups` | object\[] | No | — | Groups to import. | | `largeImport` | boolean | No | — | Set to true when importing more than 2000 users or groups. | | `members` | object\[] | No | — | Members to import. | | `overwriteExisting` | boolean | Yes | — | Whether to overwrite existing entries or append. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Group name." }, "externalId": { "type": "string", "description": "External identifier for the group." }, "memberExternalIds": { "type": "array", "items": { "type": "string" }, "description": "External IDs of members belonging to this group." } }, "required": [ "name", "externalId" ] }, "description": "Groups to import." }, "largeImport": { "type": "boolean", "description": "Set to true when importing more than 2000 users or groups." }, "members": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Member email address." }, "externalId": { "type": "string", "description": "External identifier for the member." }, "deleted": { "type": "boolean", "description": "If true, the member will be removed during import." } }, "required": [ "externalId" ] }, "description": "Members to import." }, "overwriteExisting": { "type": "boolean", "description": "Whether to overwrite existing entries or append." } }, "required": [ "PCID", "overwriteExisting" ] } ``` *** ## bitwarden\_list\_collections List all collections ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bitwarden\_list\_events List events **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `start` | string | No | — | Start date for the event filter (ISO 8601 format). Defaults to 30 days ago. | | `end` | string | No | — | End date for the event filter (ISO 8601 format). Defaults to now. Date range must be less than 367 days. | | `actingUserId` | string | No | — | Filter events by the user who performed the action (UUID). | | `itemId` | string | No | — | Filter events by related vault item (UUID). | | `continuationToken` | string | No | — | Pagination cursor from a previous response to fetch the next page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "start": { "type": "string", "description": "Start date for the event filter (ISO 8601 format). Defaults to 30 days ago." }, "end": { "type": "string", "description": "End date for the event filter (ISO 8601 format). Defaults to now. Date range must be less than 367 days." }, "actingUserId": { "type": "string", "description": "Filter events by the user who performed the action (UUID)." }, "itemId": { "type": "string", "description": "Filter events by related vault item (UUID)." }, "continuationToken": { "type": "string", "description": "Pagination cursor from a previous response to fetch the next page." } }, "required": [ "PCID" ] } ``` *** ## bitwarden\_list\_groups List all groups ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bitwarden\_list\_members List all members ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bitwarden\_list\_policies List all policies ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bitwarden\_reinvite\_member Re-invite a member **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The member identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The member identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_restore\_member Restore a revoked member **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The member identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The member identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_revoke\_member Revoke member access **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The member identifier (UUID). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The member identifier (UUID)." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_update\_collection Update a collection **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The collection identifier (UUID). | | `externalId` | string | No | — | External identifier for directory sync. | | `groups` | object\[] | No | — | Group associations with permissions. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The collection identifier (UUID)." }, "externalId": { "type": "string", "description": "External identifier for directory sync." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The associated object identifier (UUID)." }, "readOnly": { "type": "boolean", "description": "Whether this association grants read-only access." }, "hidePasswords": { "type": "boolean", "description": "Whether passwords are hidden for this association." }, "manage": { "type": "boolean", "description": "Whether this association grants management permissions." } }, "required": [ "id", "readOnly" ] }, "description": "Group associations with permissions." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_update\_group Update a group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The group identifier (UUID). | | `collections` | object\[] | No | — | Collection associations with permissions. | | `externalId` | string | No | — | External identifier for directory sync. | | `name` | string | Yes | — | The name of the group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The group identifier (UUID)." }, "collections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The associated object identifier (UUID)." }, "readOnly": { "type": "boolean", "description": "Whether this association grants read-only access." }, "hidePasswords": { "type": "boolean", "description": "Whether passwords are hidden for this association." }, "manage": { "type": "boolean", "description": "Whether this association grants management permissions." } }, "required": [ "id", "readOnly" ] }, "description": "Collection associations with permissions." }, "externalId": { "type": "string", "description": "External identifier for directory sync." }, "name": { "type": "string", "description": "The name of the group." } }, "required": [ "PCID", "id", "name" ] } ``` *** ## bitwarden\_update\_group\_member\_ids Update group members **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The group identifier (UUID). | | `memberIds` | string\[] | Yes | — | List of member IDs to assign to the group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The group identifier (UUID)." }, "memberIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of member IDs to assign to the group." } }, "required": [ "PCID", "id", "memberIds" ] } ``` *** ## bitwarden\_update\_member Update a member **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The member identifier (UUID). | | `collections` | object\[] | No | — | Collection associations with permissions. | | `externalId` | string | No | — | External identifier for directory sync. | | `groups` | string\[] | No | — | Group IDs to assign the member to. | | `permissions` | object | No | — | Custom permissions for a member with type=Custom (4). | | `type` | integer | No | — | Member type/role. 0=Owner, 1=Admin, 2=User, 3=Manager, 4=Custom. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The member identifier (UUID)." }, "collections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The associated object identifier (UUID)." }, "readOnly": { "type": "boolean", "description": "Whether this association grants read-only access." }, "hidePasswords": { "type": "boolean", "description": "Whether passwords are hidden for this association." }, "manage": { "type": "boolean", "description": "Whether this association grants management permissions." } }, "required": [ "id", "readOnly" ] }, "description": "Collection associations with permissions." }, "externalId": { "type": "string", "description": "External identifier for directory sync." }, "groups": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Group IDs to assign the member to." }, "permissions": { "type": "object", "description": "Custom permissions for a member with type=Custom (4).", "properties": { "accessEventLogs": { "type": "boolean", "description": "Can access event logs." }, "accessImportExport": { "type": "boolean", "description": "Can access import/export." }, "accessReports": { "type": "boolean", "description": "Can access reports." }, "createNewCollections": { "type": "boolean", "description": "Can create new collections." }, "editAnyCollection": { "type": "boolean", "description": "Can edit any collection." }, "deleteAnyCollection": { "type": "boolean", "description": "Can delete any collection." }, "manageGroups": { "type": "boolean", "description": "Can manage groups." }, "managePolicies": { "type": "boolean", "description": "Can manage policies." }, "manageSso": { "type": "boolean", "description": "Can manage SSO." }, "manageUsers": { "type": "boolean", "description": "Can manage users." }, "manageResetPassword": { "type": "boolean", "description": "Can manage password reset." }, "manageScim": { "type": "boolean", "description": "Can manage SCIM provisioning." } } }, "type": { "type": "integer", "description": "Member type/role. 0=Owner, 1=Admin, 2=User, 3=Manager, 4=Custom." } }, "required": [ "PCID", "id" ] } ``` *** ## bitwarden\_update\_member\_group\_ids Update member groups **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The member identifier (UUID). | | `groupIds` | string\[] | Yes | — | List of group IDs to assign to the member. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The member identifier (UUID)." }, "groupIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of group IDs to assign to the member." } }, "required": [ "PCID", "id", "groupIds" ] } ``` *** ## bitwarden\_update\_policy Update a policy **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `type` | integer | Yes | — | The policy type (integer). | | `data` | object | No | — | Policy-specific configuration data. | | `enabled` | boolean | Yes | — | Whether to enable or disable the policy. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "type": { "type": "integer", "description": "The policy type (integer)." }, "data": { "type": "object", "description": "Policy-specific configuration data." }, "enabled": { "type": "boolean", "description": "Whether to enable or disable the policy." } }, "required": [ "PCID", "type", "enabled" ] } ``` # black-kite Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/black-kite Black Kite Cyber Risk **Server path:** `/black-kite` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`black_kite_add_company`](#black_kite_add_company) | Add company to monitoring | | [`black_kite_delete_company`](#black_kite_delete_company) | Remove company from monitoring | | [`black_kite_get_company`](#black_kite_get_company) | Get company details | | [`black_kite_get_company_risk_score`](#black_kite_get_company_risk_score) | Get company risk score | | [`black_kite_get_company_technical_risk_score`](#black_kite_get_company_technical_risk_score) | Get technical risk score history | | [`black_kite_get_scorecard`](#black_kite_get_scorecard) | Get company scorecard | | [`black_kite_get_status`](#black_kite_get_status) | Get API status | | [`black_kite_get_tag`](#black_kite_get_tag) | Get tag details | | [`black_kite_list_companies`](#black_kite_list_companies) | List monitored companies | | [`black_kite_list_company_findings`](#black_kite_list_company_findings) | List company findings | | [`black_kite_list_company_focus_tags`](#black_kite_list_company_focus_tags) | List company FocusTags | | [`black_kite_list_ecosystems`](#black_kite_list_ecosystems) | List ecosystems | | [`black_kite_search_companies`](#black_kite_search_companies) | Search for companies | | [`black_kite_update_company`](#black_kite_update_company) | Update company properties | *** ## black\_kite\_add\_company Add company to monitoring **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `domain` | string | Yes | — | Primary domain of the company to monitor (e.g., example.com) | | `name` | string | No | — | Company name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "domain": { "type": "string", "description": "Primary domain of the company to monitor (e.g., example.com)" }, "name": { "type": "string", "description": "Company name" } }, "required": [ "PCID", "domain" ] } ``` *** ## black\_kite\_delete\_company Remove company from monitoring **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyId` | string | Yes | — | The unique identifier of the company | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The unique identifier of the company" } }, "required": [ "PCID", "companyId" ] } ``` *** ## black\_kite\_get\_company Get company details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyId` | string | Yes | — | The unique identifier of the company | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The unique identifier of the company" } }, "required": [ "PCID", "companyId" ] } ``` *** ## black\_kite\_get\_company\_risk\_score Get company risk score **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyId` | string | Yes | — | The unique identifier of the company | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The unique identifier of the company" } }, "required": [ "PCID", "companyId" ] } ``` *** ## black\_kite\_get\_company\_technical\_risk\_score Get technical risk score history **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyId` | string | Yes | — | The unique identifier of the company | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The unique identifier of the company" } }, "required": [ "PCID", "companyId" ] } ``` *** ## black\_kite\_get\_scorecard Get company scorecard **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyId` | string | Yes | — | The unique identifier of the company | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The unique identifier of the company" } }, "required": [ "PCID", "companyId" ] } ``` *** ## black\_kite\_get\_status Get API status ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## black\_kite\_get\_tag Get tag details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `tagId` | string | Yes | — | The unique identifier of the tag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tagId": { "type": "string", "description": "The unique identifier of the tag" } }, "required": [ "PCID", "tagId" ] } ``` *** ## black\_kite\_list\_companies List monitored companies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `page` | integer | No | — | Page number for pagination | | `pageSize` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## black\_kite\_list\_company\_findings List company findings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyId` | string | Yes | — | The unique identifier of the company | | `status` | string | No | — | Filter by finding status | | `severity` | string | No | — | Filter by finding severity | | `page` | integer | No | — | Page number for pagination | | `pageSize` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The unique identifier of the company" }, "status": { "type": "string", "description": "Filter by finding status", "enum": [ "Active", "Resolved", "Accepted" ] }, "severity": { "type": "string", "description": "Filter by finding severity", "enum": [ "Low", "Medium", "High", "Critical" ] }, "page": { "type": "integer", "description": "Page number for pagination" }, "pageSize": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "companyId" ] } ``` *** ## black\_kite\_list\_company\_focus\_tags List company FocusTags **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyId` | string | Yes | — | The unique identifier of the company | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The unique identifier of the company" } }, "required": [ "PCID", "companyId" ] } ``` *** ## black\_kite\_list\_ecosystems List ecosystems ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## black\_kite\_search\_companies Search for companies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `productGroupIds` | string\[] | No | — | Filter by product group IDs | | `query` | string | Yes | — | Search query — company name or domain | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "productGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Filter by product group IDs" }, "query": { "type": "string", "description": "Search query — company name or domain" } }, "required": [ "PCID", "query" ] } ``` *** ## black\_kite\_update\_company Update company properties **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyId` | string | Yes | — | The unique identifier of the company | | `name` | string | Yes | — | Updated company name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The unique identifier of the company" }, "name": { "type": "string", "description": "Updated company name" } }, "required": [ "PCID", "companyId", "name" ] } ``` # blackboard Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/blackboard Blackboard Learn LMS **PinkConnect service:** `blackboard` | **Type:** Application (parent with child servers) | **PCID required:** Yes blackboard is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [blackboard-communication](/api-reference/mcp-servers/application/blackboard/blackboard-communication) | `/blackboard-communication` | 15 | Blackboard Communication - announcements, discussions, and calendar | | [blackboard-content](/api-reference/mcp-servers/application/blackboard/blackboard-content) | `/blackboard-content` | 28 | Blackboard Content - course content, file attachments, resources, review, and adaptive release | | [blackboard-courses](/api-reference/mcp-servers/application/blackboard/blackboard-courses) | `/blackboard-courses` | 27 | Blackboard Courses - manage courses, categories, and course announcements | | [blackboard-grades](/api-reference/mcp-servers/application/blackboard/blackboard-grades) | `/blackboard-grades` | 36 | Blackboard Grades - course grades, attempts, notations, gradebook categories, and grading periods | | [blackboard-groups](/api-reference/mcp-servers/application/blackboard/blackboard-groups) | `/blackboard-groups` | 28 | Blackboard Groups - course groups, group users, memberships, and messages | | [blackboard-institutional](/api-reference/mcp-servers/application/blackboard/blackboard-institutional) | `/blackboard-institutional` | 42 | Blackboard Institutional - hierarchy, attendance, terms, and SIS logs | | [blackboard-system](/api-reference/mcp-servers/application/blackboard/blackboard-system) | `/blackboard-system` | 21 | Blackboard System - LTI, proctoring, uploads, system info, and assessments | | [blackboard-users](/api-reference/mcp-servers/application/blackboard/blackboard-users) | `/blackboard-users` | 26 | Blackboard Users - user management, roles, sessions, OAuth, and data sources | # blackboard-communication Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/blackboard/blackboard-communication Blackboard Communication - announcements, discussions, and calendar **Server path:** `/blackboard-communication` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`blackboard_communication_delete_learn_api_public_announcements_by_announcementid`](#blackboard_communication_delete_learn_api_public_announcements_by_announcementid) | Delete Announcement | | [`blackboard_communication_delete_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid`](#blackboard_communication_delete_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid) | Delete Calendar Item | | [`blackboard_communication_get_learn_api_public_announcements`](#blackboard_communication_get_learn_api_public_announcements) | Get Announcements | | [`blackboard_communication_get_learn_api_public_announcements_by_announcementid`](#blackboard_communication_get_learn_api_public_announcements_by_announcementid) | Get Announcement | | [`blackboard_communication_get_learn_api_public_calendars`](#blackboard_communication_get_learn_api_public_calendars) | Get Calendars | | [`blackboard_communication_get_learn_api_public_calendars_items`](#blackboard_communication_get_learn_api_public_calendars_items) | Get Calendar Items | | [`blackboard_communication_get_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid`](#blackboard_communication_get_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid) | Get Calendar Item | | [`blackboard_communication_get_learn_api_public_courses_by_courseid_discussions`](#blackboard_communication_get_learn_api_public_courses_by_courseid_discussions) | Get Discussions | | [`blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid`](#blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid) | Get Discussion | | [`blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid_messages`](#blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid_messages) | Get Discussion Messages | | [`blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid_messages_by_messageid_replies`](#blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid_messages_by_messageid_replies) | Get Message Replies | | [`blackboard_communication_patch_learn_api_public_announcements_by_announcementid`](#blackboard_communication_patch_learn_api_public_announcements_by_announcementid) | Update Announcement | | [`blackboard_communication_patch_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid`](#blackboard_communication_patch_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid) | Update Calendar Item | | [`blackboard_communication_post_learn_api_public_announcements`](#blackboard_communication_post_learn_api_public_announcements) | Create Announcement | | [`blackboard_communication_post_learn_api_public_calendars_items`](#blackboard_communication_post_learn_api_public_calendars_items) | Create Calendar Item | *** ## blackboard\_communication\_delete\_learn\_api\_public\_announcements\_by\_announcementid Delete Announcement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `announcementId` | string | Yes | — | Announcement Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "announcementId": { "type": "string", "description": "Announcement Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "announcementId" ] } ``` *** ## blackboard\_communication\_delete\_learn\_api\_public\_calendars\_items\_by\_calendaritemtype\_by\_calendaritemid Delete Calendar Item **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `calendarItemType` | string | Yes | — | Calendar Item Type | | `calendarItemId` | string | Yes | — | Calendar Item Id | | `deleteSeries` | boolean | No | — | delete the series calendar items or just one calendar item. true - delete the series, false - delete one calendar item. Defaults to false. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "calendarItemType": { "type": "string", "description": "Calendar Item Type", "enum": [ "Course", "GradebookColumn", "Institution", "OfficeHours", "Personal" ] }, "calendarItemId": { "type": "string", "description": "Calendar Item Id" }, "deleteSeries": { "type": "boolean", "description": "delete the series calendar items or just one calendar item. true - delete the series, false - delete one calendar item. Defaults to false." } }, "required": [ "PCID", "calendarItemType", "calendarItemId" ] } ``` *** ## blackboard\_communication\_get\_learn\_api\_public\_announcements Get Announcements **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_communication\_get\_learn\_api\_public\_announcements\_by\_announcementid Get Announcement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `announcementId` | string | Yes | — | Announcement Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "announcementId": { "type": "string", "description": "Announcement Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "announcementId" ] } ``` *** ## blackboard\_communication\_get\_learn\_api\_public\_calendars Get Calendars **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_communication\_get\_learn\_api\_public\_calendars\_items Get Calendar Items **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | No | — | Specifies only calendar items associated with 'courseId' are to be returned. **Since**: 3400.9.0 | | `type` | string | No | — | Specifies only calendar items with the given type. **Since**: 3400.9.0 \| Type \| Description \| --------- \| --------- \| \| Course \| \| \| GradebookColumn \| Read only. \| \| Institution \| \| \| OfficeHours \| \| \| Personal \| \| | | `since` | string | No | — | Specifies only calendar items after the 'since' date (inclusive) are to be returned. Maximum of 16 weeks after the 'since' date will be returned. ISO-8601 date-time format is expected: \[yyyy-MM-dd\|yyyyMMdd]\[T(hh:mm\[:ss\[.sss]]\|hhmm\[ss\[.sss]])]?\[Z\|\[+-]hh:mm]] **Since**: 3400.9.0 | | `until` | string | No | — | Specifies only calendar items before the 'until' date (inclusive) are to be returned. Maximum of 16 weeks prior to the 'until' date will be returned. ISO-8601 date-time format is expected: \[yyyy-MM-dd\|yyyyMMdd]\[T(hh:mm\[:ss\[.sss]]\|hhmm\[ss\[.sss]])]?\[Z\|\[+-]hh:mm]] **Since**: 3400.9.0 | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "title(desc),start" Supported fields are: - id - calendarId - title - start - end - modified **Since**: 3400.9.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "Specifies only calendar items associated with 'courseId' are to be returned. **Since**: 3400.9.0" }, "type": { "type": "string", "description": "Specifies only calendar items with the given type. **Since**: 3400.9.0 | Type | Description | --------- | --------- | | Course | | | GradebookColumn | Read only. | | Institution | | | OfficeHours | | | Personal | |", "enum": [ "Course", "GradebookColumn", "Institution", "OfficeHours", "Personal" ] }, "since": { "type": "string", "description": "Specifies only calendar items after the 'since' date (inclusive) are to be returned. Maximum of 16 weeks after the 'since' date will be returned. ISO-8601 date-time format is expected: [yyyy-MM-dd|yyyyMMdd][T(hh:mm[:ss[.sss]]|hhmm[ss[.sss]])]?[Z|[+-]hh:mm]] **Since**: 3400.9.0" }, "until": { "type": "string", "description": "Specifies only calendar items before the 'until' date (inclusive) are to be returned. Maximum of 16 weeks prior to the 'until' date will be returned. ISO-8601 date-time format is expected: [yyyy-MM-dd|yyyyMMdd][T(hh:mm[:ss[.sss]]|hhmm[ss[.sss]])]?[Z|[+-]hh:mm]] **Since**: 3400.9.0" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"title(desc),start\" Supported fields are: - id - calendarId - title - start - end - modified **Since**: 3400.9.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_communication\_get\_learn\_api\_public\_calendars\_items\_by\_calendaritemtype\_by\_calendaritemid Get Calendar Item **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `calendarItemType` | string | Yes | — | Calendar Item Type | | `calendarItemId` | string | Yes | — | Calendar Item Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "calendarItemType": { "type": "string", "description": "Calendar Item Type", "enum": [ "Course", "GradebookColumn", "Institution", "OfficeHours", "Personal" ] }, "calendarItemId": { "type": "string", "description": "Calendar Item Id" } }, "required": [ "PCID", "calendarItemType", "calendarItemId" ] } ``` *** ## blackboard\_communication\_get\_learn\_api\_public\_courses\_by\_courseid\_discussions Get Discussions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "title(desc),available" Supported fields are: - id - title - available - gradable - createdDate - modifiedDate - gradebookColumnId **Since**: 3900.19.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"title(desc),available\" Supported fields are: - id - title - available - gradable - createdDate - modifiedDate - gradebookColumnId **Since**: 3900.19.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_communication\_get\_learn\_api\_public\_courses\_by\_courseid\_discussions\_by\_discussionid Get Discussion **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `discussionId` | string | Yes | — | Discussion Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "discussionId": { "type": "string", "description": "Discussion Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "discussionId" ] } ``` *** ## blackboard\_communication\_get\_learn\_api\_public\_courses\_by\_courseid\_discussions\_by\_discussionid\_messages Get Discussion Messages **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `discussionId` | string | Yes | — | Discussion Id | | `groupId` | string | No | — | Search for messages which are associated with this groupId. **Since**: 3900.19.0 | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "createdDate(desc),givenName" Supported fields are: - id - discussionId - parentId - threadId - userId - groupId - givenName - familyName - status - body - createdDate - modifiedDate - isRead **Since**: 3900.19.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "discussionId": { "type": "string", "description": "Discussion Id" }, "groupId": { "type": "string", "description": "Search for messages which are associated with this groupId. **Since**: 3900.19.0" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"createdDate(desc),givenName\" Supported fields are: - id - discussionId - parentId - threadId - userId - groupId - givenName - familyName - status - body - createdDate - modifiedDate - isRead **Since**: 3900.19.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "discussionId" ] } ``` *** ## blackboard\_communication\_get\_learn\_api\_public\_courses\_by\_courseid\_discussions\_by\_discussionid\_messages\_by\_messageid\_replies Get Message Replies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `discussionId` | string | Yes | — | Discussion Id | | `messageId` | string | Yes | — | Message Id | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "createdDate(desc),givenName" Supported fields are: - id - discussionId - parentId - threadId - userId - groupId - givenName - familyName - status - body - createdDate - modifiedDate - isRead **Since**: 3900.19.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "discussionId": { "type": "string", "description": "Discussion Id" }, "messageId": { "type": "string", "description": "Message Id" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"createdDate(desc),givenName\" Supported fields are: - id - discussionId - parentId - threadId - userId - groupId - givenName - familyName - status - body - createdDate - modifiedDate - isRead **Since**: 3900.19.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "discussionId", "messageId" ] } ``` *** ## blackboard\_communication\_patch\_learn\_api\_public\_announcements\_by\_announcementid Update Announcement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `announcementId` | string | Yes | — | Announcement Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the System Announcement. | | `body` | string | No | — | The message body of the System Announcement. This field supports BbML; see \ for more information. | | `showAtLogin` | boolean | No | — | Whether this System Announcement should be displayed on the login page. | | `showInCourses` | boolean | No | — | Whether this System Announcement should be displayed on courses. | | `title` | string | No | — | The title of this System Announcement. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "announcementId": { "type": "string", "description": "Announcement Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the System Announcement.", "properties": { "duration": { "type": "object", "description": "Duration indicates when the System Announcement is Available based on whether it is Permanent or if the date/time of the request falls within its Start & End dates." } } }, "body": { "type": "string", "description": "The message body of the System Announcement. This field supports BbML; see here for more information." }, "showAtLogin": { "type": "boolean", "description": "Whether this System Announcement should be displayed on the login page." }, "showInCourses": { "type": "boolean", "description": "Whether this System Announcement should be displayed on courses." }, "title": { "type": "string", "description": "The title of this System Announcement." } }, "required": [ "PCID", "announcementId" ] } ``` *** ## blackboard\_communication\_patch\_learn\_api\_public\_calendars\_items\_by\_calendaritemtype\_by\_calendaritemid Update Calendar Item **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `calendarItemType` | string | Yes | — | Calendar Item Type | | `calendarItemId` | string | Yes | — | Calendar Item Id | | `updateSeries` | boolean | No | — | update the series calendar items or just one calendar item. true - update the entire series, false - update a single calendar item. Defaults to false. When updating an entire series the full recurrence object must be populated just as if creating a new calendar series. If updating a single calendar entry the recurrence must not be specified. | | `description` | string | No | — | Description of the calendar item. | | `disableResizing` | boolean | No | — | Whether resizing of the calendar item should NOT be allowed. | | `dynamicCalendarItemProps` | object | No | — | Extra calendar item properties if it is a GradebookColumn calendar item. | | `end` | string | No | — | End date of the calendar item either in the past if the calendar item is for an event that's already end OR in the future if it's for an event to end in the future. This is always set and should occur after the start date. | | `location` | string | No | — | Location of the calendar item and it cannot exceed 1024 characters. | | `recurrence` | object | No | — | The recurrence value | | `start` | string | No | — | Start date of the calendar item either in the past if the calendar item is for an event that's already started OR in the future if it's for an event to start in the future. This is always set and should occur before the end date. | | `title` | string | No | — | Title of the calendar item. Title length cannot exceed 255 characters. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "calendarItemType": { "type": "string", "description": "Calendar Item Type", "enum": [ "Course", "GradebookColumn", "Institution", "OfficeHours", "Personal" ] }, "calendarItemId": { "type": "string", "description": "Calendar Item Id" }, "updateSeries": { "type": "boolean", "description": "update the series calendar items or just one calendar item. true - update the entire series, false - update a single calendar item. Defaults to false. When updating an entire series the full recurrence object must be populated just as if creating a new calendar series. If updating a single calendar entry the recurrence must not be specified." }, "description": { "type": "string", "description": "Description of the calendar item." }, "disableResizing": { "type": "boolean", "description": "Whether resizing of the calendar item should NOT be allowed." }, "dynamicCalendarItemProps": { "type": "object", "description": "Extra calendar item properties if it is a GradebookColumn calendar item.", "properties": { "attemptable": { "type": "boolean", "description": "The dynamic calendar item can be attempted (can have attempts made against it) and the current user (in context) has permission/entitlement to grade attempts for the object represented by this calendar item." }, "categoryId": { "type": "string", "description": "Returns the gradeableItem categoryId value .it is only set if the calendar event is dynamically created based on a single grade book column" }, "dateRangeLimited": { "type": "boolean", "description": "The dynamic calendar item is only visible during a specific windows of time." }, "eventType": { "type": "string", "description": "Returns a human readable string describing the type of calendar item represented (e.g. assignment, test, etc.)." }, "gradable": { "type": "boolean", "description": "The dynamic calendar item can be graded and the current user (in context) has permission/entitlement to grade attempts for the object represented by this calendar item." } } }, "end": { "type": "string", "description": "End date of the calendar item either in the past if the calendar item is for an event that's already end OR in the future if it's for an event to end in the future. This is always set and should occur after the start date." }, "location": { "type": "string", "description": "Location of the calendar item and it cannot exceed 1024 characters." }, "recurrence": { "type": "object", "description": "The recurrence value", "properties": { "count": { "type": "integer", "description": "Recurrence count indicating how many times the calendar item should be repeated. Either this count OR the 'until' date is/'should be' set. When creating a calendar item, 'until' date will be used if both 'until' date and the count are set." }, "frequency": { "type": "string", "description": "Frequency of the calendar item repeated. | Type | Description | --------- | --------- | | Monthly | | | Weekly | | | Daily | |", "enum": [ "Monthly", "Weekly", "Daily" ] }, "interval": { "type": "integer", "description": "Interval between recurrences depends on the repeating type. For example, if the calendar times should be repeated every three weeks, you need set interval to 3 as well as frequency to \"Weekly\". Minimum and Maximum allowed Intervals are 1 and 100 respectively." }, "monthRepeatDay": { "type": "integer", "description": "This property is used in conjunction with the 'Monthly' frequency and it indicates on which day of the month the calendar item is/'should be' repeated on. The valid values are valid month days, that is, 1 to 31. Either this OR both 'monthPosition' and 'repeatDay' should be set to create a recurring calendar item with 'Monthly' frequency." }, "monthPosition": { "type": "integer", "description": "This property is used in conjunction with the 'Monthly' frequency and it indicates that the calendar item is/'should be' repeated on nth occurrence of 'repeatDay' in the month. Valid values for 'monthPosition' are integers in the range of -1 and 4 inclusive: -1 for the last occurrence, 1 for the first occurrence, 2 for the second occurrence, and so on. 0 is not used." }, "originalStart": { "type": "string", "description": "The original start date for the calendar item." }, "originalEnd": { "type": "string", "description": "The original end date for the calendar item." }, "repeatBroken": { "type": "boolean", "description": "Calendar item that's repeated is part of a recurring series of calendar events but the item has been changed since its original creation. In other words, the calendar item has been modified to no longer align with the recurring series (day/time changed for example) of events. This can only be true if the calendar item is repeatable." }, "repeatDay": { "type": "string", "description": "For monthly recurring event, repeat by day of week. | Type | Description | --------- | --------- | | Sunday | | | Monday | | | Tuesday | | | Wednesday | | | Thursday | | | Friday | | | Saturday | |", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "until": { "type": "string", "description": "The date the calendar item should be repeated until. Either this 'until' date OR the count is/'should be' set. When creating a calendar item, 'until' date will be used if both 'until' date and the count are set." }, "weekDays": { "type": "array", "items": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "description": "This property is used in conjunction with the 'Weekly' frequency and it indicates the days of the week the calendar item should be repeated on." } } }, "start": { "type": "string", "description": "Start date of the calendar item either in the past if the calendar item is for an event that's already started OR in the future if it's for an event to start in the future. This is always set and should occur before the end date." }, "title": { "type": "string", "description": "Title of the calendar item. Title length cannot exceed 255 characters." } }, "required": [ "PCID", "calendarItemType", "calendarItemId" ] } ``` *** ## blackboard\_communication\_post\_learn\_api\_public\_announcements Create Announcement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the System Announcement. | | `body` | string | No | — | The message body of the System Announcement. This field supports BbML; see \ for more information. | | `showAtLogin` | boolean | No | — | Whether this System Announcement should be displayed on the login page. | | `showInCourses` | boolean | No | — | Whether this System Announcement should be displayed on courses. | | `title` | string | Yes | — | The title of this System Announcement. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the System Announcement.", "properties": { "duration": { "type": "object", "description": "Duration indicates when the System Announcement is Available based on whether it is Permanent or if the date/time of the request falls within its Start & End dates." } } }, "body": { "type": "string", "description": "The message body of the System Announcement. This field supports BbML; see here for more information." }, "showAtLogin": { "type": "boolean", "description": "Whether this System Announcement should be displayed on the login page." }, "showInCourses": { "type": "boolean", "description": "Whether this System Announcement should be displayed on courses." }, "title": { "type": "string", "description": "The title of this System Announcement." } }, "required": [ "PCID", "title" ] } ``` *** ## blackboard\_communication\_post\_learn\_api\_public\_calendars\_items Create Calendar Item **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `calendarId` | string | Yes | — | Calendar source identifier which indicates the calendar on which the calendar item was created. Examples of possible values : "PERSONAL", "INSTITUTION", and course id in the format of "\_3\_1". | | `description` | string | No | — | Description of the calendar item. | | `disableResizing` | boolean | No | — | Whether resizing of the calendar item should NOT be allowed. | | `dynamicCalendarItemProps` | object | No | — | Extra calendar item properties if it is a GradebookColumn calendar item. | | `end` | string | No | — | End date of the calendar item either in the past if the calendar item is for an event that's already end OR in the future if it's for an event to end in the future. This is always set and should occur after the start date. | | `location` | string | No | — | Location of the calendar item and it cannot exceed 1024 characters. | | `recurrence` | object | No | — | The recurrence value | | `start` | string | No | — | Start date of the calendar item either in the past if the calendar item is for an event that's already started OR in the future if it's for an event to start in the future. This is always set and should occur before the end date. | | `title` | string | No | — | Title of the calendar item. Title length cannot exceed 255 characters. | | `type` | string | Yes | — | The type of this Calendar Item. \| Type \| Description \| --------- \| --------- \| \| Course \| \| \| GradebookColumn \| Read only. \| \| Institution \| \| \| OfficeHours \| \| \| Personal \| \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "calendarId": { "type": "string", "description": "Calendar source identifier which indicates the calendar on which the calendar item was created. Examples of possible values : \"PERSONAL\", \"INSTITUTION\", and course id in the format of \"_3_1\"." }, "description": { "type": "string", "description": "Description of the calendar item." }, "disableResizing": { "type": "boolean", "description": "Whether resizing of the calendar item should NOT be allowed." }, "dynamicCalendarItemProps": { "type": "object", "description": "Extra calendar item properties if it is a GradebookColumn calendar item.", "properties": { "attemptable": { "type": "boolean", "description": "The dynamic calendar item can be attempted (can have attempts made against it) and the current user (in context) has permission/entitlement to grade attempts for the object represented by this calendar item." }, "categoryId": { "type": "string", "description": "Returns the gradeableItem categoryId value .it is only set if the calendar event is dynamically created based on a single grade book column" }, "dateRangeLimited": { "type": "boolean", "description": "The dynamic calendar item is only visible during a specific windows of time." }, "eventType": { "type": "string", "description": "Returns a human readable string describing the type of calendar item represented (e.g. assignment, test, etc.)." }, "gradable": { "type": "boolean", "description": "The dynamic calendar item can be graded and the current user (in context) has permission/entitlement to grade attempts for the object represented by this calendar item." } } }, "end": { "type": "string", "description": "End date of the calendar item either in the past if the calendar item is for an event that's already end OR in the future if it's for an event to end in the future. This is always set and should occur after the start date." }, "location": { "type": "string", "description": "Location of the calendar item and it cannot exceed 1024 characters." }, "recurrence": { "type": "object", "description": "The recurrence value", "properties": { "count": { "type": "integer", "description": "Recurrence count indicating how many times the calendar item should be repeated. Either this count OR the 'until' date is/'should be' set. When creating a calendar item, 'until' date will be used if both 'until' date and the count are set." }, "frequency": { "type": "string", "description": "Frequency of the calendar item repeated. | Type | Description | --------- | --------- | | Monthly | | | Weekly | | | Daily | |", "enum": [ "Monthly", "Weekly", "Daily" ] }, "interval": { "type": "integer", "description": "Interval between recurrences depends on the repeating type. For example, if the calendar times should be repeated every three weeks, you need set interval to 3 as well as frequency to \"Weekly\". Minimum and Maximum allowed Intervals are 1 and 100 respectively." }, "monthRepeatDay": { "type": "integer", "description": "This property is used in conjunction with the 'Monthly' frequency and it indicates on which day of the month the calendar item is/'should be' repeated on. The valid values are valid month days, that is, 1 to 31. Either this OR both 'monthPosition' and 'repeatDay' should be set to create a recurring calendar item with 'Monthly' frequency." }, "monthPosition": { "type": "integer", "description": "This property is used in conjunction with the 'Monthly' frequency and it indicates that the calendar item is/'should be' repeated on nth occurrence of 'repeatDay' in the month. Valid values for 'monthPosition' are integers in the range of -1 and 4 inclusive: -1 for the last occurrence, 1 for the first occurrence, 2 for the second occurrence, and so on. 0 is not used." }, "originalStart": { "type": "string", "description": "The original start date for the calendar item." }, "originalEnd": { "type": "string", "description": "The original end date for the calendar item." }, "repeatBroken": { "type": "boolean", "description": "Calendar item that's repeated is part of a recurring series of calendar events but the item has been changed since its original creation. In other words, the calendar item has been modified to no longer align with the recurring series (day/time changed for example) of events. This can only be true if the calendar item is repeatable." }, "repeatDay": { "type": "string", "description": "For monthly recurring event, repeat by day of week. | Type | Description | --------- | --------- | | Sunday | | | Monday | | | Tuesday | | | Wednesday | | | Thursday | | | Friday | | | Saturday | |", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "until": { "type": "string", "description": "The date the calendar item should be repeated until. Either this 'until' date OR the count is/'should be' set. When creating a calendar item, 'until' date will be used if both 'until' date and the count are set." }, "weekDays": { "type": "array", "items": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "description": "This property is used in conjunction with the 'Weekly' frequency and it indicates the days of the week the calendar item should be repeated on." } } }, "start": { "type": "string", "description": "Start date of the calendar item either in the past if the calendar item is for an event that's already started OR in the future if it's for an event to start in the future. This is always set and should occur before the end date." }, "title": { "type": "string", "description": "Title of the calendar item. Title length cannot exceed 255 characters." }, "type": { "type": "string", "description": "The type of this Calendar Item. | Type | Description | --------- | --------- | | Course | | | GradebookColumn | Read only. | | Institution | | | OfficeHours | | | Personal | |", "enum": [ "Course", "GradebookColumn", "Institution", "OfficeHours", "Personal" ] } }, "required": [ "PCID", "calendarId", "type" ] } ``` # blackboard-content Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/blackboard/blackboard-content Blackboard Content - course content, file attachments, resources, review, and adaptive release **Server path:** `/blackboard-content` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid`](#blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid) | Delete Content | | [`blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid`](#blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid) | Delete File Attachment | | [`blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid`](#blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid) | Delete Content Group | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents) | Get Contents | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid) | Get Content | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules) | Get Rules | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid) | Get Rule | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria) | Get Criteria | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria_by_criterionid`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria_by_criterionid) | Get Adaptive Release Rule Criterion | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments) | Get File Attachments | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid) | Get File Attachment | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid_download`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid_download) | Download | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_children`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_children) | Get Content Children | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups) | Get Content Groups | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid) | Get Content Group | | [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatus`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatus) | Get Review Status | | [`blackboard_content_get_learn_api_public_courses_by_courseid_resources`](#blackboard_content_get_learn_api_public_courses_by_courseid_resources) | Get Top Level Course Resources | | [`blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid`](#blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid) | Get Course Resource | | [`blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid_children`](#blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid_children) | Get Course Resource Children | | [`blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid`](#blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid) | Update Content | | [`blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatus`](#blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatus) | Update Review Status | | [`blackboard_content_post_learn_api_public_courses_by_courseid_contents`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents) | Create Content | | [`blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules) | Create Rule | | [`blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria) | Create Adaptive Release Rule Criteria | | [`blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_attachments`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_attachments) | Create File Attachment | | [`blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_children`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_children) | Create Child | | [`blackboard_content_post_learn_api_public_courses_by_courseid_contents_createassignment`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents_createassignment) | Create Assignment | | [`blackboard_content_put_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid`](#blackboard_content_put_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid) | Create Content Group | *** ## blackboard\_content\_delete\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid Delete Content **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `allowChildCourseContent` | boolean | No | — | By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation. | | `deleteGrades` | boolean | No | — | If true and there is a grade column associated with this content, that grade column will be marked as deleted. All attempts and grades will also be removed. If false, the grade column will not be marked as deleted. Attempts will not be deleted and grades will be converted to manually entered grades. Defaults to false. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "allowChildCourseContent": { "type": "boolean", "description": "By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation." }, "deleteGrades": { "type": "boolean", "description": "If true and there is a grade column associated with this content, that grade column will be marked as deleted. All attempts and grades will also be removed. If false, the grade column will not be marked as deleted. Attempts will not be deleted and grades will be converted to manually entered grades. Defaults to false." } }, "required": [ "PCID", "courseId", "contentId" ] } ``` *** ## blackboard\_content\_delete\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_attachments\_by\_attachmentid Delete File Attachment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `attachmentId` | string | Yes | — | Attachment Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "attachmentId": { "type": "string", "description": "Attachment Id" } }, "required": [ "PCID", "courseId", "contentId", "attachmentId" ] } ``` *** ## blackboard\_content\_delete\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_groups\_by\_groupid Delete Content Group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | Content Id | | `allowChildCourseContent` | boolean | No | — | By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation. | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "Content Id" }, "allowChildCourseContent": { "type": "boolean", "description": "By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation." }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" } }, "required": [ "PCID", "courseId", "contentId", "groupId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents Get Contents **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `recursive` | boolean | No | — | Search for child content recursively. A value of 'true' indicates that search results should include all content descendants within the hierarchy of the specified parent. A value of 'false' indicates results should be limited to immediate children only. Not setting this field defaults to 'false' behavior; only including immediate children. **Since**: 3100.2.0 | | `title` | string | No | — | Search for content title. Will return all Content items whose title contains the supplied search value. **Since**: 3900.10.0 | | `contentHandler` | string | No | — | Search for the specific content handler. Not setting this field will return all content handlers. **Since**: 3400.5.0 | | `created` | string | No | — | Search for contents with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3700.1.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.1.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `modified` | string | No | — | Search for contents with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3700.4.0 | | `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.4.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `reviewable` | boolean | No | — | Search contents by whether they are reviewable or not. **Since**: 3700.15.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "recursive": { "type": "boolean", "description": "Search for child content recursively. A value of 'true' indicates that search results should include all content descendants within the hierarchy of the specified parent. A value of 'false' indicates results should be limited to immediate children only. Not setting this field defaults to 'false' behavior; only including immediate children. **Since**: 3100.2.0" }, "title": { "type": "string", "description": "Search for content title. Will return all Content items whose title contains the supplied search value. **Since**: 3900.10.0" }, "contentHandler": { "type": "string", "description": "Search for the specific content handler. Not setting this field will return all content handlers. **Since**: 3400.5.0" }, "created": { "type": "string", "description": "Search for contents with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3700.1.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.1.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "modified": { "type": "string", "description": "Search for contents with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3700.4.0" }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "reviewable": { "type": "boolean", "description": "Search contents by whether they are reviewable or not. **Since**: 3700.15.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid Get Content **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "contentId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_adaptiverelease\_rules Get Rules **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "title(desc)" Supported fields are: - id - title **Since**: 3900.23.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"title(desc)\" Supported fields are: - id - title **Since**: 3900.23.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "contentId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_adaptiverelease\_rules\_by\_ruleid Get Rule **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `ruleId` | string | Yes | — | Rule Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "ruleId": { "type": "string", "description": "Rule Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "contentId", "ruleId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_adaptiverelease\_rules\_by\_ruleid\_criteria Get Criteria **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `ruleId` | string | Yes | — | Rule Id | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "title(desc)" Supported fields are: - id **Since**: 3900.23.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "ruleId": { "type": "string", "description": "Rule Id" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"title(desc)\" Supported fields are: - id **Since**: 3900.23.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "contentId", "ruleId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_adaptiverelease\_rules\_by\_ruleid\_criteria\_by\_criterionid Get Adaptive Release Rule Criterion **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `ruleId` | string | Yes | — | Rule Id | | `criterionId` | string | Yes | — | Criterion Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "ruleId": { "type": "string", "description": "Rule Id" }, "criterionId": { "type": "string", "description": "Criterion Id" } }, "required": [ "PCID", "courseId", "contentId", "ruleId", "criterionId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_attachments Get File Attachments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." } }, "required": [ "PCID", "courseId", "contentId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_attachments\_by\_attachmentid Get File Attachment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `attachmentId` | string | Yes | — | Attachment Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "attachmentId": { "type": "string", "description": "Attachment Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "contentId", "attachmentId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_attachments\_by\_attachmentid\_download Download **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `attachmentId` | string | Yes | — | Attachment Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "attachmentId": { "type": "string", "description": "Attachment Id" } }, "required": [ "PCID", "courseId", "contentId", "attachmentId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_children Get Content Children **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `recursive` | boolean | No | — | Search for child content recursively. A value of 'true' indicates that search results should include all content descendants within the hierarchy of the specified parent. A value of 'false' indicates results should be limited to immediate children only. Not setting this field defaults to 'false' behavior; only including immediate children. **Since**: 3100.2.0 | | `title` | string | No | — | Search for content title. Will return all Content items whose title contains the supplied search value. **Since**: 3900.10.0 | | `contentHandler` | string | No | — | Search for the specific content handler. Not setting this field will return all content handlers. **Since**: 3400.5.0 | | `created` | string | No | — | Search for contents with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3700.1.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.1.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `modified` | string | No | — | Search for contents with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3700.4.0 | | `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.4.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `reviewable` | boolean | No | — | Search contents by whether they are reviewable or not. **Since**: 3700.15.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "recursive": { "type": "boolean", "description": "Search for child content recursively. A value of 'true' indicates that search results should include all content descendants within the hierarchy of the specified parent. A value of 'false' indicates results should be limited to immediate children only. Not setting this field defaults to 'false' behavior; only including immediate children. **Since**: 3100.2.0" }, "title": { "type": "string", "description": "Search for content title. Will return all Content items whose title contains the supplied search value. **Since**: 3900.10.0" }, "contentHandler": { "type": "string", "description": "Search for the specific content handler. Not setting this field will return all content handlers. **Since**: 3400.5.0" }, "created": { "type": "string", "description": "Search for contents with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3700.1.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.1.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "modified": { "type": "string", "description": "Search for contents with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3700.4.0" }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "reviewable": { "type": "boolean", "description": "Search contents by whether they are reviewable or not. **Since**: 3700.15.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "contentId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_groups Get Content Groups **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | Content Id | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "Content Id" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "contentId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_groups\_by\_groupid Get Content Group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | Content Id | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "Content Id" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "contentId", "groupId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_users\_by\_userid\_reviewstatus Get Review Status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "contentId", "userId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_resources Get Top Level Course Resources **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `type` | string | No | — | Search for Resources whose Type matches the specified value. Valid values are 'File' and 'Folder'. \| Type \| Description \| --------- \| --------- \| \| File \| \| \| Folder \| \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "type": { "type": "string", "description": "Search for Resources whose Type matches the specified value. Valid values are 'File' and 'Folder'. | Type | Description | --------- | --------- | | File | | | Folder | |", "enum": [ "File", "Folder" ] }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_resources\_by\_resourceid Get Course Resource **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `resourceId` | string | Yes | — | The xythos resource ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|--------------------------------------------------\| \| primary \| \_123\_1 \| \| xid \| xid-123\_1-1 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "resourceId": { "type": "string", "description": "The xythos resource ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|--------------------------------------------------| | primary | _123_1 | | xid | xid-123_1-1 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "resourceId" ] } ``` *** ## blackboard\_content\_get\_learn\_api\_public\_courses\_by\_courseid\_resources\_by\_resourceid\_children Get Course Resource Children **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `resourceId` | string | Yes | — | The xythos resource ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|--------------------------------------------------\| \| primary \| \_123\_1 \| \| xid \| xid-123\_1-1 \| | | `type` | string | No | — | Search for Resources whose Type matches the specified value. Valid values are 'File' and 'Folder'. \| Type \| Description \| --------- \| --------- \| \| File \| \| \| Folder \| \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "resourceId": { "type": "string", "description": "The xythos resource ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|--------------------------------------------------| | primary | _123_1 | | xid | xid-123_1-1 |" }, "type": { "type": "string", "description": "Search for Resources whose Type matches the specified value. Valid values are 'File' and 'Folder'. | Type | Description | --------- | --------- | | File | | | Folder | |", "enum": [ "File", "Folder" ] }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "resourceId" ] } ``` *** ## blackboard\_content\_patch\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid Update Content **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `allowChildCourseContent` | boolean | No | — | By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the content to students. | | `body` | string | No | — | The body text associated with this content. This field supports BbML; see \ for more information. | | `contentHandler` | object | No | — | Content Handler | | `description` | string | No | — | The short description of this content. This field is not used in Classic courses. For Ultra courses this is used to show information directly on the course outline. | | `launchInNewWindow` | boolean | No | — | Indicates whether the content is going to open in a new window. **Since**: 3800.10.0 | | `parentId` | string | No | — | The ID of the content's parent. Note that top-level contents do not have parents. The 'parentId' field is a writable field as of the Bb Learn 3200.6.0 release. Specifying a new value in PATCH requests allows the Content object to be moved from one parent to another. | | `position` | integer | No | — | The position of this content within its parent folder. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent. | | `reviewable` | boolean | No | — | Indicates whether Review Status is enabled for this content. Content items with review status enabled can be marked as reviewed by students in classic courses and content items with review status enabled in Ultra are either in a Forced Sequence or content that should be counted towards the progress tracking feature as of 3900.19 This can be used to track performance and in Adaptive Release rules to control the release of other content. **Since**: 3700.15.0 | | `title` | string | No | — | The title or name of this content. Typically shown as the main text to click in the course outline when accessing the content. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "allowChildCourseContent": { "type": "boolean", "description": "By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the content to students.", "properties": { "available": { "type": "string", "description": "Whether the content is currently available to students. Instructors can always access the content. If set to 'PartiallyVisible', the title will be available to students but the body will not. Defaults to Yes. | Type | Description | --------- | --------- | | Yes | | | No | | | PartiallyVisible | |", "enum": [ "Yes", "No", "PartiallyVisible" ] }, "allowGuests": { "type": "boolean", "description": "Whether this content is available to users with the 'guest' role. Defaults to true." }, "adaptiveRelease": { "type": "object", "description": "Settings controlling adaptive release of the content to students." } } }, "body": { "type": "string", "description": "The body text associated with this content. This field supports BbML; see here for more information." }, "contentHandler": { "type": "object", "description": "Content Handler", "properties": { "id": { "type": "string", "description": "The content handler's ID. Publicly supported handlers: | ID | Documentation | Since | |------------------------------------|---------------------------------|-----------| | resource/x-bb-document | ContentItemTOPubV1 | 3000.1.0 | | resource/x-bb-externallink | ExternalLinkTOPubV1 | 3000.1.0 | | resource/x-bb-folder | ContentFolderTOPubV1 | 3000.1.0 | | resource/x-bb-courselink | CourseLinkTOPubV1 | 3100.5.0 | | resource/x-bb-forumlink | DiscussionLinkTOPubV1 | 3100.6.0 | | resource/x-bb-blti-link | BasicLTITOPubV1 | 3200.6.0 | | resource/x-bb-file | ContentFileTOPubV1 | 3200.6.0 | | resource/x-bb-asmt-test-link | TestLinkTOPubV1 | 3300.5.0 | | resource/x-bb-assignment | AssignmentTOPubV1 | 3400.9.0 | | resource/x-bb-blti-bltiplacement-* | BasicLTIPlacementContentTOPubV1 | 3600.0.0 | For handlers that are not publicly supported yet, their ID will be shown here, and updates to common content attributes are allowed, but extended handler-specific attributes will not be visible." } } }, "description": { "type": "string", "description": "The short description of this content. This field is not used in Classic courses. For Ultra courses this is used to show information directly on the course outline." }, "launchInNewWindow": { "type": "boolean", "description": "Indicates whether the content is going to open in a new window. **Since**: 3800.10.0" }, "parentId": { "type": "string", "description": "The ID of the content's parent. Note that top-level contents do not have parents. The 'parentId' field is a writable field as of the Bb Learn 3200.6.0 release. Specifying a new value in PATCH requests allows the Content object to be moved from one parent to another." }, "position": { "type": "integer", "description": "The position of this content within its parent folder. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent." }, "reviewable": { "type": "boolean", "description": "Indicates whether Review Status is enabled for this content. Content items with review status enabled can be marked as reviewed by students in classic courses and content items with review status enabled in Ultra are either in a Forced Sequence or content that should be counted towards the progress tracking feature as of 3900.19 This can be used to track performance and in Adaptive Release rules to control the release of other content. **Since**: 3700.15.0" }, "title": { "type": "string", "description": "The title or name of this content. Typically shown as the main text to click in the course outline when accessing the content." } }, "required": [ "PCID", "courseId", "contentId" ] } ``` *** ## blackboard\_content\_patch\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_users\_by\_userid\_reviewstatus Update Review Status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `reviewed` | boolean | No | — | The current status of the content's 'reviewed' attribute. **Since**: 3700.16.0 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "reviewed": { "type": "boolean", "description": "The current status of the content's 'reviewed' attribute. **Since**: 3700.16.0" } }, "required": [ "PCID", "courseId", "contentId", "userId" ] } ``` *** ## blackboard\_content\_post\_learn\_api\_public\_courses\_by\_courseid\_contents Create Content **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `allowChildCourseContent` | boolean | No | — | By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the content to students. | | `body` | string | No | — | The body text associated with this content. This field supports BbML; see \ for more information. | | `contentHandler` | object | No | — | Content Handler | | `description` | string | No | — | The short description of this content. This field is not used in Classic courses. For Ultra courses this is used to show information directly on the course outline. | | `launchInNewWindow` | boolean | No | — | Indicates whether the content is going to open in a new window. **Since**: 3800.10.0 | | `parentId` | string | No | — | The ID of the content's parent. Note that top-level contents do not have parents. The 'parentId' field is a writable field as of the Bb Learn 3200.6.0 release. Specifying a new value in PATCH requests allows the Content object to be moved from one parent to another. | | `position` | integer | No | — | The position of this content within its parent folder. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent. | | `reviewable` | boolean | No | — | Indicates whether Review Status is enabled for this content. Content items with review status enabled can be marked as reviewed by students in classic courses and content items with review status enabled in Ultra are either in a Forced Sequence or content that should be counted towards the progress tracking feature as of 3900.19 This can be used to track performance and in Adaptive Release rules to control the release of other content. **Since**: 3700.15.0 | | `title` | string | Yes | — | The title or name of this content. Typically shown as the main text to click in the course outline when accessing the content. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "allowChildCourseContent": { "type": "boolean", "description": "By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the content to students.", "properties": { "available": { "type": "string", "description": "Whether the content is currently available to students. Instructors can always access the content. If set to 'PartiallyVisible', the title will be available to students but the body will not. Defaults to Yes. | Type | Description | --------- | --------- | | Yes | | | No | | | PartiallyVisible | |", "enum": [ "Yes", "No", "PartiallyVisible" ] }, "allowGuests": { "type": "boolean", "description": "Whether this content is available to users with the 'guest' role. Defaults to true." }, "adaptiveRelease": { "type": "object", "description": "Settings controlling adaptive release of the content to students." } } }, "body": { "type": "string", "description": "The body text associated with this content. This field supports BbML; see here for more information." }, "contentHandler": { "type": "object", "description": "Content Handler", "properties": { "id": { "type": "string", "description": "The content handler's ID. Publicly supported handlers: | ID | Documentation | Since | |------------------------------------|---------------------------------|-----------| | resource/x-bb-document | ContentItemTOPubV1 | 3000.1.0 | | resource/x-bb-externallink | ExternalLinkTOPubV1 | 3000.1.0 | | resource/x-bb-folder | ContentFolderTOPubV1 | 3000.1.0 | | resource/x-bb-courselink | CourseLinkTOPubV1 | 3100.5.0 | | resource/x-bb-forumlink | DiscussionLinkTOPubV1 | 3100.6.0 | | resource/x-bb-blti-link | BasicLTITOPubV1 | 3200.6.0 | | resource/x-bb-file | ContentFileTOPubV1 | 3200.6.0 | | resource/x-bb-asmt-test-link | TestLinkTOPubV1 | 3300.5.0 | | resource/x-bb-assignment | AssignmentTOPubV1 | 3400.9.0 | | resource/x-bb-blti-bltiplacement-* | BasicLTIPlacementContentTOPubV1 | 3600.0.0 | For handlers that are not publicly supported yet, their ID will be shown here, and updates to common content attributes are allowed, but extended handler-specific attributes will not be visible." } } }, "description": { "type": "string", "description": "The short description of this content. This field is not used in Classic courses. For Ultra courses this is used to show information directly on the course outline." }, "launchInNewWindow": { "type": "boolean", "description": "Indicates whether the content is going to open in a new window. **Since**: 3800.10.0" }, "parentId": { "type": "string", "description": "The ID of the content's parent. Note that top-level contents do not have parents. The 'parentId' field is a writable field as of the Bb Learn 3200.6.0 release. Specifying a new value in PATCH requests allows the Content object to be moved from one parent to another." }, "position": { "type": "integer", "description": "The position of this content within its parent folder. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent." }, "reviewable": { "type": "boolean", "description": "Indicates whether Review Status is enabled for this content. Content items with review status enabled can be marked as reviewed by students in classic courses and content items with review status enabled in Ultra are either in a Forced Sequence or content that should be counted towards the progress tracking feature as of 3900.19 This can be used to track performance and in Adaptive Release rules to control the release of other content. **Since**: 3700.15.0" }, "title": { "type": "string", "description": "The title or name of this content. Typically shown as the main text to click in the course outline when accessing the content." } }, "required": [ "PCID", "courseId", "title" ] } ``` *** ## blackboard\_content\_post\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_adaptiverelease\_rules Create Rule **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `title` | string | Yes | — | Title given to the adaptive release rule | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "title": { "type": "string", "description": "Title given to the adaptive release rule" } }, "required": [ "PCID", "courseId", "contentId", "title" ] } ``` *** ## blackboard\_content\_post\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_adaptiverelease\_rules\_by\_ruleid\_criteria Create Adaptive Release Rule Criteria **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `ruleId` | string | Yes | — | Rule Id | | `id` | string | No | — | Internal Identifier of the Rule's criteria. | | `type` | string | No | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "ruleId": { "type": "string", "description": "Rule Id" }, "id": { "type": "string", "description": "Internal Identifier of the Rule's criteria." }, "type": { "type": "string", "description": "The type value" } }, "required": [ "PCID", "courseId", "contentId", "ruleId" ] } ``` *** ## blackboard\_content\_post\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_attachments Create File Attachment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "body": { "type": "object", "description": "Request body" } }, "required": [ "PCID", "courseId", "contentId", "body" ] } ``` *** ## blackboard\_content\_post\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_children Create Child **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| keyword \| root \| | | `allowChildCourseContent` | boolean | No | — | By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the content to students. | | `body` | string | No | — | The body text associated with this content. This field supports BbML; see \ for more information. | | `contentHandler` | object | No | — | Content Handler | | `description` | string | No | — | The short description of this content. This field is not used in Classic courses. For Ultra courses this is used to show information directly on the course outline. | | `launchInNewWindow` | boolean | No | — | Indicates whether the content is going to open in a new window. **Since**: 3800.10.0 | | `parentId` | string | No | — | The ID of the content's parent. Note that top-level contents do not have parents. The 'parentId' field is a writable field as of the Bb Learn 3200.6.0 release. Specifying a new value in PATCH requests allows the Content object to be moved from one parent to another. | | `position` | integer | No | — | The position of this content within its parent folder. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent. | | `reviewable` | boolean | No | — | Indicates whether Review Status is enabled for this content. Content items with review status enabled can be marked as reviewed by students in classic courses and content items with review status enabled in Ultra are either in a Forced Sequence or content that should be counted towards the progress tracking feature as of 3900.19 This can be used to track performance and in Adaptive Release rules to control the release of other content. **Since**: 3700.15.0 | | `title` | string | Yes | — | The title or name of this content. Typically shown as the main text to click in the course outline when accessing the content. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "The Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |" }, "allowChildCourseContent": { "type": "boolean", "description": "By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the content to students.", "properties": { "available": { "type": "string", "description": "Whether the content is currently available to students. Instructors can always access the content. If set to 'PartiallyVisible', the title will be available to students but the body will not. Defaults to Yes. | Type | Description | --------- | --------- | | Yes | | | No | | | PartiallyVisible | |", "enum": [ "Yes", "No", "PartiallyVisible" ] }, "allowGuests": { "type": "boolean", "description": "Whether this content is available to users with the 'guest' role. Defaults to true." }, "adaptiveRelease": { "type": "object", "description": "Settings controlling adaptive release of the content to students." } } }, "body": { "type": "string", "description": "The body text associated with this content. This field supports BbML; see here for more information." }, "contentHandler": { "type": "object", "description": "Content Handler", "properties": { "id": { "type": "string", "description": "The content handler's ID. Publicly supported handlers: | ID | Documentation | Since | |------------------------------------|---------------------------------|-----------| | resource/x-bb-document | ContentItemTOPubV1 | 3000.1.0 | | resource/x-bb-externallink | ExternalLinkTOPubV1 | 3000.1.0 | | resource/x-bb-folder | ContentFolderTOPubV1 | 3000.1.0 | | resource/x-bb-courselink | CourseLinkTOPubV1 | 3100.5.0 | | resource/x-bb-forumlink | DiscussionLinkTOPubV1 | 3100.6.0 | | resource/x-bb-blti-link | BasicLTITOPubV1 | 3200.6.0 | | resource/x-bb-file | ContentFileTOPubV1 | 3200.6.0 | | resource/x-bb-asmt-test-link | TestLinkTOPubV1 | 3300.5.0 | | resource/x-bb-assignment | AssignmentTOPubV1 | 3400.9.0 | | resource/x-bb-blti-bltiplacement-* | BasicLTIPlacementContentTOPubV1 | 3600.0.0 | For handlers that are not publicly supported yet, their ID will be shown here, and updates to common content attributes are allowed, but extended handler-specific attributes will not be visible." } } }, "description": { "type": "string", "description": "The short description of this content. This field is not used in Classic courses. For Ultra courses this is used to show information directly on the course outline." }, "launchInNewWindow": { "type": "boolean", "description": "Indicates whether the content is going to open in a new window. **Since**: 3800.10.0" }, "parentId": { "type": "string", "description": "The ID of the content's parent. Note that top-level contents do not have parents. The 'parentId' field is a writable field as of the Bb Learn 3200.6.0 release. Specifying a new value in PATCH requests allows the Content object to be moved from one parent to another." }, "position": { "type": "integer", "description": "The position of this content within its parent folder. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent." }, "reviewable": { "type": "boolean", "description": "Indicates whether Review Status is enabled for this content. Content items with review status enabled can be marked as reviewed by students in classic courses and content items with review status enabled in Ultra are either in a Forced Sequence or content that should be counted towards the progress tracking feature as of 3900.19 This can be used to track performance and in Adaptive Release rules to control the release of other content. **Since**: 3700.15.0" }, "title": { "type": "string", "description": "The title or name of this content. Typically shown as the main text to click in the course outline when accessing the content." } }, "required": [ "PCID", "courseId", "contentId", "title" ] } ``` *** ## blackboard\_content\_post\_learn\_api\_public\_courses\_by\_courseid\_contents\_createassignment Create Assignment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `allowChildCourseContent` | boolean | No | — | By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation. | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | The availability value | | `description` | string | No | — | The description to use when creating the assignment content. | | `fileUploadIds` | string\[] | No | — | File Upload Ids | | `grading` | object | No | — | The grading value | | `instructions` | string | No | — | The text instructions to use when creating the assignment content. This field supports BbML; see \ for more information. | | `originalityReportingTool` | object | No | — | Originality Reporting Tool | | `parentId` | string | No | — | The id of the parent content for the created assignment. | | `position` | integer | No | — | The position of the created assignment within the other other content of its parent. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent. | | `score` | object | No | — | The score value | | `title` | string | Yes | — | The title used for the created assignment content and gradebook column. Typically shown as the main text to click in the course outline when accessing the assignment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allowChildCourseContent": { "type": "boolean", "description": "By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation." }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "The availability value", "properties": { "available": { "type": "string", "description": "Whether the created assignment is available to students. Instructors can always access the created assignment. If set to 'PartiallyVisible', the title will be available to students but the body will not. Defaults to Yes. | Type | Description | --------- | --------- | | Yes | | | No | | | PartiallyVisible | |", "enum": [ "Yes", "No", "PartiallyVisible" ] }, "allowGuests": { "type": "boolean", "description": "Whether the created assignment is available to users with the 'guest' role. Defaults to true." }, "adaptiveRelease": { "type": "object", "description": "Settings controlling adaptive release of created assignment to students." } } }, "description": { "type": "string", "description": "The description to use when creating the assignment content." }, "fileUploadIds": { "type": "array", "items": { "type": "string" }, "description": "File Upload Ids" }, "grading": { "type": "object", "description": "The grading value", "properties": { "due": { "type": "string", "description": "Date and time that the created assignment will be due. If not specified, this will default to the specified \"availability.adaptiveRelease.end\" date. If that is also not specified, due date defaults to null." }, "attemptsAllowed": { "type": "integer", "description": "The number of attempts allowed on the created assignment. Defaults to 1. Maximum allowed is 10 for an Ultra Assignment. Value will be ignored if isUnlimitedAttemptsAllowed is set to true." }, "gradeSchemaId": { "type": "string", "description": "The grading schema to use for the created assignment. Defaults to Score." }, "isUnlimitedAttemptsAllowed": { "type": "boolean", "description": "Determines if the assignment has unlimited number of attempts. **Since**: 3400.8.0" } } }, "instructions": { "type": "string", "description": "The text instructions to use when creating the assignment content. This field supports BbML; see here for more information." }, "originalityReportingTool": { "type": "object", "description": "Originality Reporting Tool", "properties": { "id": { "type": "string", "description": "The Originality Reporting Tools handler id." } } }, "parentId": { "type": "string", "description": "The id of the parent content for the created assignment." }, "position": { "type": "integer", "description": "The position of the created assignment within the other other content of its parent. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent." }, "score": { "type": "object", "description": "The score value", "properties": { "possible": { "type": "number", "description": "The number of points possible for the created assignment. Defaults to 100." } } }, "title": { "type": "string", "description": "The title used for the created assignment content and gradebook column. Typically shown as the main text to click in the course outline when accessing the assignment." } }, "required": [ "PCID", "courseId", "title" ] } ``` *** ## blackboard\_content\_put\_learn\_api\_public\_courses\_by\_courseid\_contents\_by\_contentid\_groups\_by\_groupid Create Content Group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `contentId` | string | Yes | — | Content Id | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `allowChildCourseContent` | boolean | No | — | By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "contentId": { "type": "string", "description": "Content Id" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "allowChildCourseContent": { "type": "boolean", "description": "By default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "contentId", "groupId" ] } ``` # blackboard-courses Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/blackboard/blackboard-courses Blackboard Courses - manage courses, categories, and course announcements **Server path:** `/blackboard-courses` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`blackboard_courses_delete_learn_api_public_catalog_categories_by_categorytype_by_categoryid`](#blackboard_courses_delete_learn_api_public_catalog_categories_by_categorytype_by_categoryid) | Delete Category | | [`blackboard_courses_delete_learn_api_public_catalog_categories_by_categorytype_by_categoryid_courses_by_courseid`](#blackboard_courses_delete_learn_api_public_catalog_categories_by_categorytype_by_categoryid_courses_by_courseid) | Delete Membership | | [`blackboard_courses_delete_learn_api_public_courses_by_courseid`](#blackboard_courses_delete_learn_api_public_courses_by_courseid) | Delete Course | | [`blackboard_courses_delete_learn_api_public_courses_by_courseid_announcements_by_announcementid`](#blackboard_courses_delete_learn_api_public_courses_by_courseid_announcements_by_announcementid) | Delete Announcement | | [`blackboard_courses_delete_learn_api_public_courses_by_courseid_children_by_childcourseid`](#blackboard_courses_delete_learn_api_public_courses_by_courseid_children_by_childcourseid) | Remove Child Course | | [`blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype`](#blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype) | Get Categories | | [`blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype_by_categoryid`](#blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype_by_categoryid) | Get Category | | [`blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype_by_categoryid_courses`](#blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype_by_categoryid_courses) | Get Memberships | | [`blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype_by_parentid_children`](#blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype_by_parentid_children) | Get Child Categories | | [`blackboard_courses_get_learn_api_public_courses`](#blackboard_courses_get_learn_api_public_courses) | Get Courses | | [`blackboard_courses_get_learn_api_public_courses_by_courseid`](#blackboard_courses_get_learn_api_public_courses_by_courseid) | Get Course | | [`blackboard_courses_get_learn_api_public_courses_by_courseid_announcements`](#blackboard_courses_get_learn_api_public_courses_by_courseid_announcements) | Get Announcements | | [`blackboard_courses_get_learn_api_public_courses_by_courseid_announcements_by_announcementid`](#blackboard_courses_get_learn_api_public_courses_by_courseid_announcements_by_announcementid) | Get Announcement | | [`blackboard_courses_get_learn_api_public_courses_by_courseid_categories`](#blackboard_courses_get_learn_api_public_courses_by_courseid_categories) | Get Memberships | | [`blackboard_courses_get_learn_api_public_courses_by_courseid_children`](#blackboard_courses_get_learn_api_public_courses_by_courseid_children) | Get Course Children | | [`blackboard_courses_get_learn_api_public_courses_by_courseid_children_by_childcourseid`](#blackboard_courses_get_learn_api_public_courses_by_courseid_children_by_childcourseid) | Get Child | | [`blackboard_courses_get_learn_api_public_courses_by_courseid_crosslistset`](#blackboard_courses_get_learn_api_public_courses_by_courseid_crosslistset) | Get Cross List Set | | [`blackboard_courses_get_learn_api_public_courses_by_courseid_tasks_by_taskid`](#blackboard_courses_get_learn_api_public_courses_by_courseid_tasks_by_taskid) | Get Task | | [`blackboard_courses_patch_learn_api_public_catalog_categories_by_categorytype_by_categoryid`](#blackboard_courses_patch_learn_api_public_catalog_categories_by_categorytype_by_categoryid) | Update Category | | [`blackboard_courses_patch_learn_api_public_courses_by_courseid`](#blackboard_courses_patch_learn_api_public_courses_by_courseid) | Update Course | | [`blackboard_courses_patch_learn_api_public_courses_by_courseid_announcements_by_announcementid`](#blackboard_courses_patch_learn_api_public_courses_by_courseid_announcements_by_announcementid) | Update Announcement | | [`blackboard_courses_post_learn_api_public_catalog_categories_by_categorytype`](#blackboard_courses_post_learn_api_public_catalog_categories_by_categorytype) | Create Category | | [`blackboard_courses_post_learn_api_public_courses`](#blackboard_courses_post_learn_api_public_courses) | Create Course | | [`blackboard_courses_post_learn_api_public_courses_by_courseid_announcements`](#blackboard_courses_post_learn_api_public_courses_by_courseid_announcements) | Create Announcement | | [`blackboard_courses_post_learn_api_public_courses_by_courseid_copy`](#blackboard_courses_post_learn_api_public_courses_by_courseid_copy) | Copy Course | | [`blackboard_courses_put_learn_api_public_catalog_categories_by_categorytype_by_categoryid_courses_by_courseid`](#blackboard_courses_put_learn_api_public_catalog_categories_by_categorytype_by_categoryid_courses_by_courseid) | Create Membership | | [`blackboard_courses_put_learn_api_public_courses_by_courseid_children_by_childcourseid`](#blackboard_courses_put_learn_api_public_courses_by_courseid_children_by_childcourseid) | Add Child Course | *** ## blackboard\_courses\_delete\_learn\_api\_public\_catalog\_categories\_by\_categorytype\_by\_categoryid Delete Category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryType` | string | Yes | — | Category Type | | `categoryId` | string | Yes | — | Category Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryType": { "type": "string", "description": "Category Type", "enum": [ "Course", "Organization" ] }, "categoryId": { "type": "string", "description": "Category Id" } }, "required": [ "PCID", "categoryType", "categoryId" ] } ``` *** ## blackboard\_courses\_delete\_learn\_api\_public\_catalog\_categories\_by\_categorytype\_by\_categoryid\_courses\_by\_courseid Delete Membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryType` | string | Yes | — | Category Type | | `categoryId` | string | Yes | — | Category Id | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryType": { "type": "string", "description": "Category Type", "enum": [ "Course", "Organization" ] }, "categoryId": { "type": "string", "description": "Category Id" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "categoryType", "categoryId", "courseId" ] } ``` *** ## blackboard\_courses\_delete\_learn\_api\_public\_courses\_by\_courseid Delete Course **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `removeFiles` | boolean | No | — | Whether to delete course files. Defaults to true. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "removeFiles": { "type": "boolean", "description": "Whether to delete course files. Defaults to true." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_courses\_delete\_learn\_api\_public\_courses\_by\_courseid\_announcements\_by\_announcementid Delete Announcement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `announcementId` | string | Yes | — | Announcement Id | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "announcementId": { "type": "string", "description": "Announcement Id" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "announcementId", "courseId" ] } ``` *** ## blackboard\_courses\_delete\_learn\_api\_public\_courses\_by\_courseid\_children\_by\_childcourseid Remove Child Course **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `childCourseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `separationStyle` | string | No | — | The method by which the courses will be separated. Default: CompleteSeparation **Since**: 3900.4.0 \| Type \| Description \| --------- \| --------- \| \| completeSeparation \| Re-enable the child course with enrollments and remove all the child enrollments from the master course. \| \| enrollmentsInBoth \| Re-enable the child course with enrollments but leave all the child enrollments in the master course as well, marking them as unavailable. \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "childCourseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "separationStyle": { "type": "string", "description": "The method by which the courses will be separated. Default: CompleteSeparation **Since**: 3900.4.0 | Type | Description | --------- | --------- | | completeSeparation | Re-enable the child course with enrollments and remove all the child enrollments from the master course. | | enrollmentsInBoth | Re-enable the child course with enrollments but leave all the child enrollments in the master course as well, marking them as unavailable. |", "enum": [ "completeSeparation", "enrollmentsInBoth" ] } }, "required": [ "PCID", "courseId", "childCourseId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_catalog\_categories\_by\_categorytype Get Categories **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryType` | string | Yes | — | Category Type | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "title(desc),start" Supported fields are: - id - categoryId - title - available - created **Since**: 3700.6.0 | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `title` | string | No | — | Search for categories with titles that contain this value. **Since**: 3700.8.0 | | `categoryId` | string | No | — | Search for categories with category IDs that contain this value. **Since**: 3700.8.0 | | `created` | string | No | — | Search for categories with a created date relative to this value. **Since**: 3700.8.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `dataSourceId` | string | No | — | Search for categories with a data source id matching this value. **Since**: 3700.9.0 | | `frontPage` | boolean | No | — | Search for categories with a front page indicator matching this value. **Since**: 3700.9.0 | | `available` | boolean | No | — | Search for categories with availability matching this value. **Since**: 3700.9.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryType": { "type": "string", "description": "Category Type", "enum": [ "Course", "Organization" ] }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"title(desc),start\" Supported fields are: - id - categoryId - title - available - created **Since**: 3700.6.0" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "title": { "type": "string", "description": "Search for categories with titles that contain this value. **Since**: 3700.8.0" }, "categoryId": { "type": "string", "description": "Search for categories with category IDs that contain this value. **Since**: 3700.8.0" }, "created": { "type": "string", "description": "Search for categories with a created date relative to this value. **Since**: 3700.8.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "dataSourceId": { "type": "string", "description": "Search for categories with a data source id matching this value. **Since**: 3700.9.0" }, "frontPage": { "type": "boolean", "description": "Search for categories with a front page indicator matching this value. **Since**: 3700.9.0" }, "available": { "type": "boolean", "description": "Search for categories with availability matching this value. **Since**: 3700.9.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "categoryType" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_catalog\_categories\_by\_categorytype\_by\_categoryid Get Category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryType` | string | Yes | — | Category Type | | `categoryId` | string | Yes | — | Category Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryType": { "type": "string", "description": "Category Type", "enum": [ "Course", "Organization" ] }, "categoryId": { "type": "string", "description": "Category Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "categoryType", "categoryId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_catalog\_categories\_by\_categorytype\_by\_categoryid\_courses Get Memberships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryType` | string | Yes | — | Category Type | | `categoryId` | string | Yes | — | Category Id | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • course\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryType": { "type": "string", "description": "Category Type", "enum": [ "Course", "Organization" ] }, "categoryId": { "type": "string", "description": "Category Id" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • course
" } }, "required": [ "PCID", "categoryType", "categoryId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_catalog\_categories\_by\_categorytype\_by\_parentid\_children Get Child Categories **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryType` | string | Yes | — | Category Type | | `parentId` | string | Yes | — | Parent Id | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "title(desc),start" Supported fields are: - id - categoryId - title - available - created **Since**: 3700.6.0 | | `title` | string | No | — | Search for categories with titles that contain this value. **Since**: 3700.8.0 | | `categoryId` | string | No | — | Search for categories with category IDs that contain this value. **Since**: 3700.8.0 | | `created` | string | No | — | Search for categories with a created date relative to this value. **Since**: 3700.8.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `dataSourceId` | string | No | — | Search for categories with a data source id matching this value. **Since**: 3700.9.0 | | `frontPage` | boolean | No | — | Search for categories with a front page indicator matching this value. **Since**: 3700.9.0 | | `available` | boolean | No | — | Search for categories with availability matching this value. **Since**: 3700.9.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryType": { "type": "string", "description": "Category Type", "enum": [ "Course", "Organization" ] }, "parentId": { "type": "string", "description": "Parent Id" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"title(desc),start\" Supported fields are: - id - categoryId - title - available - created **Since**: 3700.6.0" }, "title": { "type": "string", "description": "Search for categories with titles that contain this value. **Since**: 3700.8.0" }, "categoryId": { "type": "string", "description": "Search for categories with category IDs that contain this value. **Since**: 3700.8.0" }, "created": { "type": "string", "description": "Search for categories with a created date relative to this value. **Since**: 3700.8.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "dataSourceId": { "type": "string", "description": "Search for categories with a data source id matching this value. **Since**: 3700.9.0" }, "frontPage": { "type": "boolean", "description": "Search for categories with a front page indicator matching this value. **Since**: 3700.9.0" }, "available": { "type": "boolean", "description": "Search for categories with availability matching this value. **Since**: 3700.9.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "categoryType", "parentId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_courses Get Courses **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `modified` | string | No | — | Search for courses with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3500.4.0 | | `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3500.4.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `courseId` | string | No | — | Search for courses with courseId properties that contain this value. **Since**: 3100.0.0 | | `name` | string | No | — | Search for courses with name properties that contain this value. **Since**: 3100.0.0 | | `description` | string | No | — | Search for courses with description properties that contain this value. **Since**: 3100.0.0 | | `externalId` | string | No | — | Search for courses with externalId properties that contain this value. **Since**: 3100.0.0 | | `created` | string | No | — | Search for courses with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0 | | `allowGuests` | boolean | No | — | Search for courses which are configured to allow/disallow guest access, based on input. Default: n/a (return courses regardless of guests allowed) **Since**: 3200.3.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `availability.available` | string | No | — | Search for courses with availability.available properties that contain this value. **Since**: 3000.13.0 \| Type \| Description \| --------- \| --------- \| \| Yes \| Students may access the course. \| \| No \| Students may not access the course. \| \| Disabled \| Disabled by the SIS. Students may not access the course. **Since**: 3100.0.0 \| \| Term \| Availability is inherited from the term settings. Requires a termId be set. \| | | `dataSourceId` | string | No | — | Search for courses with this dataSourceId. This may optionally be the data source's externalId using the syntax "externalId:math101". **Since**: 3100.0.0 | | `termId` | string | No | — | Search for courses with this termId. This may optionally be the term's externalId using the syntax "externalId:spring2015". **Since**: 3100.0.0 | | `organization` | boolean | No | — | Search for courses by organization flag. A value of 'true' indicates that search results should be limited to only Organizations. A value of 'false' indicates results should be limited to Courses. Not setting this field indicates that both Courses and Organizations should be returned. **Since**: 3100.0.0 | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "name(desc),created" Supported fields are: - courseId - name - externalId - created - modified **Since**: 3400.8.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "modified": { "type": "string", "description": "Search for courses with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3500.4.0" }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3500.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "courseId": { "type": "string", "description": "Search for courses with courseId properties that contain this value. **Since**: 3100.0.0" }, "name": { "type": "string", "description": "Search for courses with name properties that contain this value. **Since**: 3100.0.0" }, "description": { "type": "string", "description": "Search for courses with description properties that contain this value. **Since**: 3100.0.0" }, "externalId": { "type": "string", "description": "Search for courses with externalId properties that contain this value. **Since**: 3100.0.0" }, "created": { "type": "string", "description": "Search for courses with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0" }, "allowGuests": { "type": "boolean", "description": "Search for courses which are configured to allow/disallow guest access, based on input. Default: n/a (return courses regardless of guests allowed) **Since**: 3200.3.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "availability.available": { "type": "string", "description": "Search for courses with availability.available properties that contain this value. **Since**: 3000.13.0 | Type | Description | --------- | --------- | | Yes | Students may access the course. | | No | Students may not access the course. | | Disabled | Disabled by the SIS. Students may not access the course. **Since**: 3100.0.0 | | Term | Availability is inherited from the term settings. Requires a termId be set. |", "enum": [ "Yes", "No", "Disabled", "Term" ] }, "dataSourceId": { "type": "string", "description": "Search for courses with this dataSourceId. This may optionally be the data source's externalId using the syntax \"externalId:math101\". **Since**: 3100.0.0" }, "termId": { "type": "string", "description": "Search for courses with this termId. This may optionally be the term's externalId using the syntax \"externalId:spring2015\". **Since**: 3100.0.0" }, "organization": { "type": "boolean", "description": "Search for courses by organization flag. A value of 'true' indicates that search results should be limited to only Organizations. A value of 'false' indicates results should be limited to Courses. Not setting this field indicates that both Courses and Organizations should be returned. **Since**: 3100.0.0" }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"name(desc),created\" Supported fields are: - courseId - name - externalId - created - modified **Since**: 3400.8.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_courses\_by\_courseid Get Course **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_courses\_by\_courseid\_announcements Get Announcements **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `created` | string | No | — | Search for announcements with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3500.3.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. 'lessThan' also an accepted value. **Since**: 3500.3.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `modified` | string | No | — | Search for announcements with a modified date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3500.3.0 | | `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. 'lessThan' also an accepted value. **Since**: 3500.3.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `title` | string | No | — | Search for announcements with a title like the provided value. **Since**: 3500.3.0 | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "title(desc),created" Supported fields are: - title - modified **Since**: 3500.3.0 | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "created": { "type": "string", "description": "Search for announcements with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3500.3.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. 'lessThan' also an accepted value. **Since**: 3500.3.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "modified": { "type": "string", "description": "Search for announcements with a modified date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3500.3.0" }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. 'lessThan' also an accepted value. **Since**: 3500.3.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "title": { "type": "string", "description": "Search for announcements with a title like the provided value. **Since**: 3500.3.0" }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"title(desc),created\" Supported fields are: - title - modified **Since**: 3500.3.0" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_courses\_by\_courseid\_announcements\_by\_announcementid Get Announcement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `announcementId` | string | Yes | — | Announcement Id | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "announcementId": { "type": "string", "description": "Announcement Id" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "announcementId", "courseId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_courses\_by\_courseid\_categories Get Memberships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • category\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • category
" } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_courses\_by\_courseid\_children Get Course Children **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • childCourse\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • childCourse
" } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_courses\_by\_courseid\_children\_by\_childcourseid Get Child **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `childCourseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • childCourse\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "childCourseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • childCourse
" } }, "required": [ "PCID", "courseId", "childCourseId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_courses\_by\_courseid\_crosslistset Get Cross List Set **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_courses\_get\_learn\_api\_public\_courses\_by\_courseid\_tasks\_by\_taskid Get Task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `taskId` | string | Yes | — | Task Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "taskId": { "type": "string", "description": "Task Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "taskId" ] } ``` *** ## blackboard\_courses\_patch\_learn\_api\_public\_catalog\_categories\_by\_categorytype\_by\_categoryid Update Category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryType` | string | Yes | — | Category Type | | `categoryId` | string | Yes | — | Category Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `available` | boolean | No | — | Boolean indicating whether or not the category is available | | `description` | string | No | — | The description of the category | | `frontPage` | boolean | No | — | Boolean indicating whether or not the category should appear on the catalog front page | | `institutionRoleIds` | string\[] | No | — | The roles for which this category is available, if category is set to restricted. Not populated for lists of categories, only for individual category | | `restricted` | boolean | No | — | Boolean indicating whether or not category is available to all roles, or restricted to a specific set of roles. | | `title` | string | No | — | The title of category | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryType": { "type": "string", "description": "Category Type", "enum": [ "Course", "Organization" ] }, "categoryId": { "type": "string", "description": "Category Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "available": { "type": "boolean", "description": "Boolean indicating whether or not the category is available" }, "description": { "type": "string", "description": "The description of the category" }, "frontPage": { "type": "boolean", "description": "Boolean indicating whether or not the category should appear on the catalog front page" }, "institutionRoleIds": { "type": "array", "items": { "type": "string" }, "description": "The roles for which this category is available, if category is set to restricted. Not populated for lists of categories, only for individual category" }, "restricted": { "type": "boolean", "description": "Boolean indicating whether or not category is available to all roles, or restricted to a specific set of roles." }, "title": { "type": "string", "description": "The title of category" } }, "required": [ "PCID", "categoryType", "categoryId" ] } ``` *** ## blackboard\_courses\_patch\_learn\_api\_public\_courses\_by\_courseid Update Course **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `allowGuests` | boolean | No | — | Whether guests (users with the role guest) are allowed access to the course. Defaults to true. | | `availability` | object | No | — | Settings controlling availability of the course to students. | | `closedComplete` | boolean | No | — | This status does not affect availability of the course for viewing in any way. closedComplete is valid for both Ultra and Classic courses. If an Ultra course is in closedComplete mode, updates are not possible. For a Classic course in closedComplete mode, updates are still possible (through Web UI but not through REST i.e. closed is enforced for original courses when updated through REST the same way Ultra courses are blocked) but new notifications are not generated. | | `dataSourceId` | string | No | — | The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax "externalId:math101". | | `description` | string | No | — | The description of the course. | | `enrollment` | object | No | — | Settings controlling how students may enroll in the course. | | `externalId` | string | No | — | An optional externally-defined unique ID for the course. Defaults to the courseId. Formerly known as 'batchUid'. | | `locale` | object | No | — | Settings controlling localization within the course. | | `name` | string | No | — | The name of the course. | | `termId` | string | No | — | The ID of the term associated to this course. This may optionally be the term's externalId using the syntax "externalId:spring.2016". | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "allowGuests": { "type": "boolean", "description": "Whether guests (users with the role guest) are allowed access to the course. Defaults to true." }, "availability": { "type": "object", "description": "Settings controlling availability of the course to students.", "properties": { "available": { "type": "string", "description": "Whether the course is currently available to students. Instructors can always access the course if they have 'Access unavailable course' entitlement. If set to 'Term', the course's parent term availability settings will be used. | Type | Description | --------- | --------- | | Yes | Students may access the course. | | No | Students may not access the course. | | Disabled | Disabled by the SIS. Students may not access the course. @since 3100.0.0 | | Term | Availability is inherited from the term settings. Requires a termId be set. |", "enum": [ "Yes", "No", "Disabled", "Term" ] }, "duration": { "type": "object", "description": "Settings controlling the length of time the course is available." } } }, "closedComplete": { "type": "boolean", "description": "This status does not affect availability of the course for viewing in any way. closedComplete is valid for both Ultra and Classic courses. If an Ultra course is in closedComplete mode, updates are not possible. For a Classic course in closedComplete mode, updates are still possible (through Web UI but not through REST i.e. closed is enforced for original courses when updated through REST the same way Ultra courses are blocked) but new notifications are not generated." }, "dataSourceId": { "type": "string", "description": "The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax \"externalId:math101\"." }, "description": { "type": "string", "description": "The description of the course." }, "enrollment": { "type": "object", "description": "Settings controlling how students may enroll in the course.", "properties": { "type": { "type": "string", "description": "Specifies the enrollment options for the course. Defaults to InstructorLed. | Type | Description | --------- | --------- | | InstructorLed | Enrollment tasks for the course can only performed by the instructor | | SelfEnrollment | Instructors have the ability to enroll users, and students can also enroll themselves in the course | | EmailEnrollment | Instructors have the ability to enroll users, and students can email requests to the instructor for enrollment |", "enum": [ "InstructorLed", "SelfEnrollment", "EmailEnrollment" ] }, "start": { "type": "string", "description": "The date on which enrollments are allowed for the course. May only be set if enrollment.type is SelfEnrollment." }, "end": { "type": "string", "description": "The date on which enrollment in this course ends. May only be set if enrollment.type is SelfEnrollment." }, "accessCode": { "type": "string", "description": "The enrollment access code associated with this course. May only be set if enrollment.type is SelfEnrollment." } } }, "externalId": { "type": "string", "description": "An optional externally-defined unique ID for the course. Defaults to the courseId. Formerly known as 'batchUid'." }, "locale": { "type": "object", "description": "Settings controlling localization within the course.", "properties": { "id": { "type": "string", "description": "The locale of this course." }, "force": { "type": "boolean", "description": "Whether students are forced to use the course's specified locale." } } }, "name": { "type": "string", "description": "The name of the course." }, "termId": { "type": "string", "description": "The ID of the term associated to this course. This may optionally be the term's externalId using the syntax \"externalId:spring.2016\"." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_courses\_patch\_learn\_api\_public\_courses\_by\_courseid\_announcements\_by\_announcementid Update Announcement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `announcementId` | string | Yes | — | Announcement Id | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the course to students. | | `body` | string | No | — | The message body of the Announcement. This field supports BbML; see \ for more information. | | `draft` | boolean | No | — | An indication of whether or not the Announcement is in draft status. | | `title` | string | No | — | The title of this Announcement. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "announcementId": { "type": "string", "description": "Announcement Id" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the course to students.", "properties": { "duration": { "type": "object", "description": "Duration indicates when the System Announcement is Available based on whether it is Permanent or if the date/time of the request falls within its Start & End dates." } } }, "body": { "type": "string", "description": "The message body of the Announcement. This field supports BbML; see here for more information." }, "draft": { "type": "boolean", "description": "An indication of whether or not the Announcement is in draft status." }, "title": { "type": "string", "description": "The title of this Announcement." } }, "required": [ "PCID", "announcementId", "courseId" ] } ``` *** ## blackboard\_courses\_post\_learn\_api\_public\_catalog\_categories\_by\_categorytype Create Category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryType` | string | Yes | — | Category Type | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `available` | boolean | Yes | — | Boolean indicating whether or not the category is available | | `categoryId` | string | Yes | — | The human-readable id of the category | | `description` | string | No | — | The description of the category | | `frontPage` | boolean | No | — | Boolean indicating whether or not the category should appear on the catalog front page | | `institutionRoleIds` | string\[] | No | — | The roles for which this category is available, if category is set to restricted. Not populated for lists of categories, only for individual category | | `parentId` | string | No | — | The ID of this category's parent category | | `restricted` | boolean | No | — | Boolean indicating whether or not category is available to all roles, or restricted to a specific set of roles. | | `title` | string | Yes | — | The title of category | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryType": { "type": "string", "description": "Category Type", "enum": [ "Course", "Organization" ] }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "available": { "type": "boolean", "description": "Boolean indicating whether or not the category is available" }, "categoryId": { "type": "string", "description": "The human-readable id of the category" }, "description": { "type": "string", "description": "The description of the category" }, "frontPage": { "type": "boolean", "description": "Boolean indicating whether or not the category should appear on the catalog front page" }, "institutionRoleIds": { "type": "array", "items": { "type": "string" }, "description": "The roles for which this category is available, if category is set to restricted. Not populated for lists of categories, only for individual category" }, "parentId": { "type": "string", "description": "The ID of this category's parent category" }, "restricted": { "type": "boolean", "description": "Boolean indicating whether or not category is available to all roles, or restricted to a specific set of roles." }, "title": { "type": "string", "description": "The title of category" } }, "required": [ "PCID", "categoryType", "available", "categoryId", "title" ] } ``` *** ## blackboard\_courses\_post\_learn\_api\_public\_courses Create Course **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `allowGuests` | boolean | No | — | Whether guests (users with the role guest) are allowed access to the course. Defaults to true. | | `availability` | object | No | — | Settings controlling availability of the course to students. | | `closedComplete` | boolean | No | — | This status does not affect availability of the course for viewing in any way. closedComplete is valid for both Ultra and Classic courses. If an Ultra course is in closedComplete mode, updates are not possible. For a Classic course in closedComplete mode, updates are still possible (through Web UI but not through REST i.e. closed is enforced for original courses when updated through REST the same way Ultra courses are blocked) but new notifications are not generated. | | `courseId` | string | Yes | — | The Course ID attribute, shown to users in the UI. | | `dataSourceId` | string | No | — | The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax "externalId:math101". | | `description` | string | No | — | The description of the course. | | `enrollment` | object | No | — | Settings controlling how students may enroll in the course. | | `externalId` | string | No | — | An optional externally-defined unique ID for the course. Defaults to the courseId. Formerly known as 'batchUid'. | | `locale` | object | No | — | Settings controlling localization within the course. | | `name` | string | Yes | — | The name of the course. | | `organization` | boolean | No | — | Whether this object represents an Organization. Defaults to false. | | `termId` | string | No | — | The ID of the term associated to this course. This may optionally be the term's externalId using the syntax "externalId:spring.2016". | | `ultraStatus` | string | No | — | Whether the course is rendered using Classic or Ultra Course View. \| Type \| Description \| --------- \| --------- \| \| Undecided \| The ultra status is not decided. \| \| Classic \| The course is decided as classic. \| \| Ultra \| The course is decided as ultra \| \| UltraPreview \| The course is currently in Ultra mode but during the preview state where it may still be reverted via a Restore to the classic state \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "allowGuests": { "type": "boolean", "description": "Whether guests (users with the role guest) are allowed access to the course. Defaults to true." }, "availability": { "type": "object", "description": "Settings controlling availability of the course to students.", "properties": { "available": { "type": "string", "description": "Whether the course is currently available to students. Instructors can always access the course if they have 'Access unavailable course' entitlement. If set to 'Term', the course's parent term availability settings will be used. | Type | Description | --------- | --------- | | Yes | Students may access the course. | | No | Students may not access the course. | | Disabled | Disabled by the SIS. Students may not access the course. @since 3100.0.0 | | Term | Availability is inherited from the term settings. Requires a termId be set. |", "enum": [ "Yes", "No", "Disabled", "Term" ] }, "duration": { "type": "object", "description": "Settings controlling the length of time the course is available." } } }, "closedComplete": { "type": "boolean", "description": "This status does not affect availability of the course for viewing in any way. closedComplete is valid for both Ultra and Classic courses. If an Ultra course is in closedComplete mode, updates are not possible. For a Classic course in closedComplete mode, updates are still possible (through Web UI but not through REST i.e. closed is enforced for original courses when updated through REST the same way Ultra courses are blocked) but new notifications are not generated." }, "courseId": { "type": "string", "description": "The Course ID attribute, shown to users in the UI." }, "dataSourceId": { "type": "string", "description": "The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax \"externalId:math101\"." }, "description": { "type": "string", "description": "The description of the course." }, "enrollment": { "type": "object", "description": "Settings controlling how students may enroll in the course.", "properties": { "type": { "type": "string", "description": "Specifies the enrollment options for the course. Defaults to InstructorLed. | Type | Description | --------- | --------- | | InstructorLed | Enrollment tasks for the course can only performed by the instructor | | SelfEnrollment | Instructors have the ability to enroll users, and students can also enroll themselves in the course | | EmailEnrollment | Instructors have the ability to enroll users, and students can email requests to the instructor for enrollment |", "enum": [ "InstructorLed", "SelfEnrollment", "EmailEnrollment" ] }, "start": { "type": "string", "description": "The date on which enrollments are allowed for the course. May only be set if enrollment.type is SelfEnrollment." }, "end": { "type": "string", "description": "The date on which enrollment in this course ends. May only be set if enrollment.type is SelfEnrollment." }, "accessCode": { "type": "string", "description": "The enrollment access code associated with this course. May only be set if enrollment.type is SelfEnrollment." } } }, "externalId": { "type": "string", "description": "An optional externally-defined unique ID for the course. Defaults to the courseId. Formerly known as 'batchUid'." }, "locale": { "type": "object", "description": "Settings controlling localization within the course.", "properties": { "id": { "type": "string", "description": "The locale of this course." }, "force": { "type": "boolean", "description": "Whether students are forced to use the course's specified locale." } } }, "name": { "type": "string", "description": "The name of the course." }, "organization": { "type": "boolean", "description": "Whether this object represents an Organization. Defaults to false." }, "termId": { "type": "string", "description": "The ID of the term associated to this course. This may optionally be the term's externalId using the syntax \"externalId:spring.2016\"." }, "ultraStatus": { "type": "string", "description": "Whether the course is rendered using Classic or Ultra Course View. | Type | Description | --------- | --------- | | Undecided | The ultra status is not decided. | | Classic | The course is decided as classic. | | Ultra | The course is decided as ultra | | UltraPreview | The course is currently in Ultra mode but during the preview state where it may still be reverted via a Restore to the classic state |", "enum": [ "Undecided", "Classic", "Ultra", "UltraPreview" ] } }, "required": [ "PCID", "courseId", "name" ] } ``` *** ## blackboard\_courses\_post\_learn\_api\_public\_courses\_by\_courseid\_announcements Create Announcement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the course to students. | | `body` | string | No | — | The message body of the Announcement. This field supports BbML; see \ for more information. | | `draft` | boolean | No | — | An indication of whether or not the Announcement is in draft status. | | `title` | string | Yes | — | The title of this Announcement. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the course to students.", "properties": { "duration": { "type": "object", "description": "Duration indicates when the System Announcement is Available based on whether it is Permanent or if the date/time of the request falls within its Start & End dates." } } }, "body": { "type": "string", "description": "The message body of the Announcement. This field supports BbML; see here for more information." }, "draft": { "type": "boolean", "description": "An indication of whether or not the Announcement is in draft status." }, "title": { "type": "string", "description": "The title of this Announcement." } }, "required": [ "PCID", "courseId", "title" ] } ``` *** ## blackboard\_courses\_post\_learn\_api\_public\_courses\_by\_courseid\_copy Copy Course **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `copy` | object | No | — | The options which will be used when copying the specified course | | `targetCourse` | object | Yes | — | The destination course to copy into. This can be either a new course, defined by the courseId field, or an existing course, defined by the id field. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "copy": { "type": "object", "description": "The options which will be used when copying the specified course", "properties": { "adaptiveReleaseRules": { "type": "boolean", "description": "Represents whether or not the adaptive release rules will be copied." }, "announcements": { "type": "boolean", "description": "Represents whether or not the announcements will be copied." }, "assessments": { "type": "boolean", "description": "Represents whether or not the assessments will be copied." }, "blogs": { "type": "boolean", "description": "Represents whether or not the blogs will be copied." }, "calendar": { "type": "boolean", "description": "Represents whether or not the calendar will be copied." }, "contacts": { "type": "boolean", "description": "Represents whether or not the contacts information will be copied." }, "contentAlignments": { "type": "boolean", "description": "Represents whether or not the content alignments will be copied." }, "contentAreas": { "type": "boolean", "description": "Represents whether or not the content areas will be copied." }, "discussions": { "type": "string", "description": "Represents whether and how to copy the discussion forum | Type | Description | --------- | --------- | | None | Discussion board will not be copied | | ForumsAndStarterPosts | Discussion board with Formus and starter posts will be copied | | ForumsOnly | Discussion board with only forums will be copied |", "enum": [ "None", "ForumsAndStarterPosts", "ForumsOnly" ] }, "glossary": { "type": "boolean", "description": "Represents whether or not the glossary will be copied." }, "gradebook": { "type": "boolean", "description": "Represents whether or not the grade book, columns and settings will be copied." }, "groupSettings": { "type": "boolean", "description": "Represents whether or not the group settings will be copied." }, "journals": { "type": "boolean", "description": "Represents whether or not the journals will be copied." }, "retentionRules": { "type": "boolean", "description": "Represents whether or not the retention rules will be copied." }, "rubrics": { "type": "boolean", "description": "Represents whether or not the rubrics will be copied." }, "settings": { "type": "object", "description": "The course settings to be copied" }, "tasks": { "type": "boolean", "description": "Represents whether or not the tasks will be copied." }, "wikis": { "type": "boolean", "description": "Represents whether or not the wikis will be copied." } } }, "targetCourse": { "type": "object", "description": "The destination course to copy into. This can be either a new course, defined by the courseId field, or an existing course, defined by the id field.", "properties": { "courseId": { "type": "string", "description": "The CourseId that will represent the new course." }, "id": { "type": "object", "description": "The id value" } } } }, "required": [ "PCID", "courseId", "targetCourse" ] } ``` *** ## blackboard\_courses\_put\_learn\_api\_public\_catalog\_categories\_by\_categorytype\_by\_categoryid\_courses\_by\_courseid Create Membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categoryType` | string | Yes | — | Category Type | | `categoryId` | string | Yes | — | Category Id | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryType": { "type": "string", "description": "Category Type", "enum": [ "Course", "Organization" ] }, "categoryId": { "type": "string", "description": "Category Id" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "categoryType", "categoryId", "courseId" ] } ``` *** ## blackboard\_courses\_put\_learn\_api\_public\_courses\_by\_courseid\_children\_by\_childcourseid Add Child Course **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `childCourseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `ignoreEnrollmentErrors` | boolean | No | — | By default, enrollment errors encountered during a course merge will result in a 409 CONFLICT response. The ignoreEnrollmentErrors parameter can be sent as true in order to bypass enrollment errors. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "childCourseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "ignoreEnrollmentErrors": { "type": "boolean", "description": "By default, enrollment errors encountered during a course merge will result in a 409 CONFLICT response. The ignoreEnrollmentErrors parameter can be sent as true in order to bypass enrollment errors." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "childCourseId" ] } ``` # blackboard-grades Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/blackboard/blackboard-grades Blackboard Grades - course grades, attempts, notations, gradebook categories, and grading periods **Server path:** `/blackboard-grades` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid`](#blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid) | Delete Attachment | | [`blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid`](#blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid) | Delete Grade Column | | [`blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid`](#blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid) | Delete Grade Notation | | [`blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid`](#blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid) | Delete Grading Period | | [`blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid`](#blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid) | Delete Grade Schema | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files) | Get Attempt File Meta Data List | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid) | Get Attempt File Meta Data | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid_download`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid_download) | Download | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_categories`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_categories) | Get Gradebook Categories | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_categories_by_categoryid`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_categories_by_categoryid) | Get Gradebook Category | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns) | Get Grade Columns | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid) | Get Grade Column | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts) | Get Column Attempts | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts_by_attemptid`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts_by_attemptid) | Get Column Attempt | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users) | Get Column Grades | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_by_userid`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_by_userid) | Get Column Grade | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_lastchanged`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_lastchanged) | Get Column Grade Last Changed | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_gradenotations`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_gradenotations) | Get Grade Notations | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid) | Get Grade Notation | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_periods`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_periods) | Get Grading Periods | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid) | Get Grading Period | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_schemas`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_schemas) | Get Grade Schemas | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid) | Get Grade Schema | | [`blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_users_by_userid`](#blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_users_by_userid) | Get User Grades | | [`blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid`](#blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid) | Update Grade Column | | [`blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts_by_attemptid`](#blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts_by_attemptid) | Update Column Attempt | | [`blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_by_userid`](#blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_by_userid) | Update Column Grade | | [`blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid`](#blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid) | Update Grade Notation | | [`blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid`](#blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid) | Update Grading Period | | [`blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid`](#blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid) | Update Grade Schema | | [`blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files`](#blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files) | Attach File | | [`blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_columns`](#blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_columns) | Create Grade Column | | [`blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts`](#blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts) | Create Column Attempt | | [`blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_gradenotations`](#blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_gradenotations) | Create Grade Notation | | [`blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_periods`](#blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_periods) | Create Grading Period | | [`blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_schemas`](#blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_schemas) | Create Grade Schema | *** ## blackboard\_grades\_delete\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_attempts\_by\_attemptid\_files\_by\_attemptfileid Delete Attachment **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `attemptId` | string | Yes | — | Attempt Id | | `attemptFileId` | string | Yes | — | Attempt File Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "attemptId": { "type": "string", "description": "Attempt Id" }, "attemptFileId": { "type": "string", "description": "Attempt File Id" } }, "required": [ "PCID", "courseId", "attemptId", "attemptFileId" ] } ``` *** ## blackboard\_grades\_delete\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid Delete Grade Column **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `columnId` | string | Yes | — | The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:column1 \| \| finalGrade \| finalGrade \| | | `onlyIfEmpty` | boolean | No | — | Only If Empty | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "columnId": { "type": "string", "description": "The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |" }, "onlyIfEmpty": { "type": "boolean", "description": "Only If Empty" } }, "required": [ "PCID", "courseId", "columnId" ] } ``` *** ## blackboard\_grades\_delete\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_gradenotations\_by\_gradenotationid Delete Grade Notation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `gradeNotationId` | string | Yes | — | Grade Notation Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "gradeNotationId": { "type": "string", "description": "Grade Notation Id" } }, "required": [ "PCID", "courseId", "gradeNotationId" ] } ``` *** ## blackboard\_grades\_delete\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_periods\_by\_periodid Delete Grading Period **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `periodId` | string | Yes | — | Period Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "periodId": { "type": "string", "description": "Period Id" } }, "required": [ "PCID", "courseId", "periodId" ] } ``` *** ## blackboard\_grades\_delete\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_schemas\_by\_schemaid Delete Grade Schema **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `schemaId` | string | Yes | — | The grade schema ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:schema1 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "schemaId": { "type": "string", "description": "The grade schema ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:schema1 |" } }, "required": [ "PCID", "courseId", "schemaId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_attempts\_by\_attemptid\_files Get Attempt File Meta Data List **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `attemptId` | string | Yes | — | Attempt Id | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "attemptId": { "type": "string", "description": "Attempt Id" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "attemptId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_attempts\_by\_attemptid\_files\_by\_attemptfileid Get Attempt File Meta Data **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `attemptId` | string | Yes | — | Attempt Id | | `attemptFileId` | string | Yes | — | Attempt File Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "attemptId": { "type": "string", "description": "Attempt Id" }, "attemptFileId": { "type": "string", "description": "Attempt File Id" } }, "required": [ "PCID", "courseId", "attemptId", "attemptFileId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_attempts\_by\_attemptid\_files\_by\_attemptfileid\_download Download **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `attemptId` | string | Yes | — | Attempt Id | | `attemptFileId` | string | Yes | — | Attempt File Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "attemptId": { "type": "string", "description": "Attempt Id" }, "attemptFileId": { "type": "string", "description": "Attempt File Id" } }, "required": [ "PCID", "courseId", "attemptId", "attemptFileId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_categories Get Gradebook Categories **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_categories\_by\_categoryid Get Gradebook Category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `categoryId` | string | Yes | — | the ID of the category to return | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "categoryId": { "type": "string", "description": "the ID of the category to return" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "categoryId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns Get Grade Columns **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `contentId` | string | No | — | Search for grade columns associated with this content item. **Since**: 3000.11.0 | | `displayName` | string | No | — | The 'displayName' value to use as search criteria. Currently only supports 'contains' searches. **Since**: 3300.2.0 | | `name` | string | No | — | The 'name' value to use as search criteria. Currently only supports 'contains' searches. **Since**: 3900.11.0 | | `gradebookCategoryId` | string\[] | No | — | Search for grade columns associated with the 'gradebookCategoryId'. comma-delimited list of the gradebook category ids. **Since**: 3900.11.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "contentId": { "type": "string", "description": "Search for grade columns associated with this content item. **Since**: 3000.11.0" }, "displayName": { "type": "string", "description": "The 'displayName' value to use as search criteria. Currently only supports 'contains' searches. **Since**: 3300.2.0" }, "name": { "type": "string", "description": "The 'name' value to use as search criteria. Currently only supports 'contains' searches. **Since**: 3900.11.0" }, "gradebookCategoryId": { "type": "array", "items": { "type": "string" }, "description": "Search for grade columns associated with the 'gradebookCategoryId'. comma-delimited list of the gradebook category ids. **Since**: 3900.11.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid Get Grade Column **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `columnId` | string | Yes | — | The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:column1 \| \| finalGrade \| finalGrade \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "columnId": { "type": "string", "description": "The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "columnId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid\_attempts Get Column Attempts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `columnId` | string | Yes | — | The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:column1 \| \| finalGrade \| finalGrade \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `userId` | string | No | — | Search for grade column attempts submitted by this user. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| **Since**: 3100.4.0 | | `attemptStatuses` | string | No | — | Search for grade column attempts with one of these statuses. **Since**: 3100.4.0 \| Type \| Description \| --------- \| --------- \| \| NotAttempted \| none of the students in a group has submitted an attempt; applies only to group assessments \| \| Abandoned \| **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. \| \| InProgress \| attempt activity has commenced, but has not been submitted for grading \| \| Suspended \| **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. \| \| Canceled \| **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. \| \| NeedsGrading \| attempt has been submitted for grading, but has not been fully graded \| \| Completed \| a grade has been entered for the attempt \| \| InProgressAgain \| attempt has been graded, but more student activity occurred after the grade was entered; applies only to collaborative tools such as discussions \| \| NeedsGradingAgain \| additional student activity occurring after a grade was entered requires that the attempt be regraded; applies only to collaborative tools such as discussions \| | | `created` | string | No | — | Search for attempts with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.0.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.0.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `modified` | string | No | — | Search for attempts with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.0.0 | | `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.0.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `attemptDate` | string | No | — | Search for attempts with attempt date relative to this value. 'attemptDateCompare' may also be sent to control search behavior. **Since**: 3800.0.0 | | `attemptDateCompare` | string | No | — | Used alongside the 'attemptDate' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.0.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "columnId": { "type": "string", "description": "The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "userId": { "type": "string", "description": "Search for grade column attempts submitted by this user. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 | **Since**: 3100.4.0" }, "attemptStatuses": { "type": "string", "description": "Search for grade column attempts with one of these statuses. **Since**: 3100.4.0 | Type | Description | --------- | --------- | | NotAttempted | none of the students in a group has submitted an attempt; applies only to group assessments | | Abandoned | **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | InProgress | attempt activity has commenced, but has not been submitted for grading | | Suspended | **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | Canceled | **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | NeedsGrading | attempt has been submitted for grading, but has not been fully graded | | Completed | a grade has been entered for the attempt | | InProgressAgain | attempt has been graded, but more student activity occurred after the grade was entered; applies only to collaborative tools such as discussions | | NeedsGradingAgain | additional student activity occurring after a grade was entered requires that the attempt be regraded; applies only to collaborative tools such as discussions |", "enum": [ "NotAttempted", "Abandoned", "InProgress", "Suspended", "Canceled", "NeedsGrading", "Completed", "InProgressAgain", "NeedsGradingAgain" ] }, "created": { "type": "string", "description": "Search for attempts with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.0.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "modified": { "type": "string", "description": "Search for attempts with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.0.0" }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "attemptDate": { "type": "string", "description": "Search for attempts with attempt date relative to this value. 'attemptDateCompare' may also be sent to control search behavior. **Since**: 3800.0.0" }, "attemptDateCompare": { "type": "string", "description": "Used alongside the 'attemptDate' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "columnId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid\_attempts\_by\_attemptid Get Column Attempt **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `columnId` | string | Yes | — | The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:column1 \| \| finalGrade \| finalGrade \| | | `attemptId` | string | Yes | — | Attempt Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "columnId": { "type": "string", "description": "The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |" }, "attemptId": { "type": "string", "description": "Attempt Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "columnId", "attemptId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid\_users Get Column Grades **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `columnId` | string | Yes | — | The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:column1 \| \| finalGrade \| finalGrade \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `changeIndex` | integer | No | — | Retrieve only items modified after the given change index. **Since**: 3300.4.0 | | `includeUnpostedGrades` | boolean | No | — | If true, calculated columns exposed in the response will be processed such that any unposted grades are included in their calculations. If false, only posted grades will be included in calculations. Entitlements course.gradebook-grades.VIEW, course.gradebook.MODIFY and course.gradebook-grades.EXECUTE are required to use this parameter. **Since**: 3800.4.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "columnId": { "type": "string", "description": "The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "changeIndex": { "type": "integer", "description": "Retrieve only items modified after the given change index. **Since**: 3300.4.0" }, "includeUnpostedGrades": { "type": "boolean", "description": "If true, calculated columns exposed in the response will be processed such that any unposted grades are included in their calculations. If false, only posted grades will be included in calculations. Entitlements course.gradebook-grades.VIEW, course.gradebook.MODIFY and course.gradebook-grades.EXECUTE are required to use this parameter. **Since**: 3800.4.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "columnId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid\_users\_by\_userid Get Column Grade **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `columnId` | string | Yes | — | The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:column1 \| \| finalGrade \| finalGrade \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "columnId": { "type": "string", "description": "The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "columnId", "userId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid\_users\_lastchanged Get Column Grade Last Changed **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `columnId` | string | Yes | — | The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:column1 \| \| finalGrade \| finalGrade \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "columnId": { "type": "string", "description": "The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "columnId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_gradenotations Get Grade Notations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_gradenotations\_by\_gradenotationid Get Grade Notation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `gradeNotationId` | string | Yes | — | Grade Notation Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "gradeNotationId": { "type": "string", "description": "Grade Notation Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "gradeNotationId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_periods Get Grading Periods **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" or "(asc)" suffix to request an ascending or descending sort for that property. e.g. "title(desc),description" Supported fields are: - id - title - position - dateMode - description **Since**: 3300.2.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" or \"(asc)\" suffix to request an ascending or descending sort for that property. e.g. \"title(desc),description\" Supported fields are: - id - title - position - dateMode - description **Since**: 3300.2.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_periods\_by\_periodid Get Grading Period **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `periodId` | string | Yes | — | Period Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "periodId": { "type": "string", "description": "Period Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "periodId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_schemas Get Grade Schemas **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_schemas\_by\_schemaid Get Grade Schema **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `schemaId` | string | Yes | — | The grade schema ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:schema1 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "schemaId": { "type": "string", "description": "The grade schema ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:schema1 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "schemaId" ] } ``` *** ## blackboard\_grades\_get\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_users\_by\_userid Get User Grades **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "userId" ] } ``` *** ## blackboard\_grades\_patch\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid Update Grade Column **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `columnId` | string | Yes | — | The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:column1 \| \| finalGrade \| finalGrade \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling the availability/visibility of grade column data. | | `description` | string | No | — | The description of the grade column. | | `displayName` | string | No | — | The display name of the grade column. Only applicable for Classic courses. Ultra courses will simply use the `name` field. **Since**: 3300.2.0 | | `externalGrade` | boolean | No | — | Whether this grade column is an external grade column. | | `externalId` | string | No | — | The externalId for this grade column | | `externalToolId` | string | No | — | The externalId for this grade column **Since**: 3500.2.0 | | `gradebookCategoryId` | string | No | — | The gradebook category ID for the grade column. **Since**: 3400.2.0 | | `grading` | object | No | — | Settings controlling whether numerical and text grade values for this grade column are calculated, determined based on attempts, or manually entered. | | `includeInCalculations` | boolean | No | — | Indicates whether or not this column is included in gradebook calculations. Cannot be set for Ultra courses. Default: true **Since**: 3800.4.0 | | `name` | string | No | — | The name of the grade column. | | `score` | object | No | — | Settings controlling the numerical scoring of this grade column. | | `showStatisticsToStudents` | boolean | No | — | Indicates whether or not column statistics are shown to students. Read-only for Ultra courses. Default: false **Since**: 3800.4.0 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "columnId": { "type": "string", "description": "The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling the availability/visibility of grade column data.", "properties": { "available": { "type": "string", "description": "Whether this grade column is available to students | Type | Description | --------- | --------- | | Yes | Students may view the grade column. | | No | Students may not view the grade column. |", "enum": [ "Yes", "No" ] } } }, "description": { "type": "string", "description": "The description of the grade column." }, "displayName": { "type": "string", "description": "The display name of the grade column. Only applicable for Classic courses. Ultra courses will simply use the `name` field. **Since**: 3300.2.0" }, "externalGrade": { "type": "boolean", "description": "Whether this grade column is an external grade column." }, "externalId": { "type": "string", "description": "The externalId for this grade column" }, "externalToolId": { "type": "string", "description": "The externalId for this grade column **Since**: 3500.2.0" }, "gradebookCategoryId": { "type": "string", "description": "The gradebook category ID for the grade column. **Since**: 3400.2.0" }, "grading": { "type": "object", "description": "Settings controlling whether numerical and text grade values for this grade column are calculated, determined based on attempts, or manually entered.", "properties": { "due": { "type": "string", "description": "The date on which attempts are due for the grade column." }, "attemptsAllowed": { "type": "integer", "description": "Number of attempts allowed for the grade column." }, "scoringModel": { "type": "string", "description": "The scoring model for the submitted grade column attempts. | Type | Description | --------- | --------- | | Last | | | Highest | | | Lowest | | | First | | | Average | |", "enum": [ "Last", "Highest", "Lowest", "First", "Average" ] }, "schemaId": { "type": "string", "description": "The ID of the grade schema associated with this grade column. Mutable since 3400.2.0 **Since**: 3200.13.0" }, "anonymousGrading": { "type": "object", "description": "Settings for anonymous grading" } } }, "includeInCalculations": { "type": "boolean", "description": "Indicates whether or not this column is included in gradebook calculations. Cannot be set for Ultra courses. Default: true **Since**: 3800.4.0" }, "name": { "type": "string", "description": "The name of the grade column." }, "score": { "type": "object", "description": "Settings controlling the numerical scoring of this grade column.", "properties": { "possible": { "type": "number", "description": "The points possible for this grade column." } } }, "showStatisticsToStudents": { "type": "boolean", "description": "Indicates whether or not column statistics are shown to students. Read-only for Ultra courses. Default: false **Since**: 3800.4.0" } }, "required": [ "PCID", "courseId", "columnId" ] } ``` *** ## blackboard\_grades\_patch\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid\_attempts\_by\_attemptid Update Column Attempt **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `columnId` | string | Yes | — | Column Id | | `attemptId` | string | Yes | — | Attempt Id | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `attemptReceipt` | object | No | — | Attempt Receipt | | `exempt` | boolean | No | — | Whether the score associated with this attempt is ignored when computing the user's grade for the associated grade column. | | `feedback` | string | No | — | The instructor feedback associated with this attempt. | | `notes` | string | No | — | The instructor notes associated with this attempt. | | `reconciliationMode` | string | No | — | The reconciliation mode to use when reconciling the attempt grade. When modifying reconciliationMode, score is also required. A new score will not be calculated based on the reconciliationMode **Since**: 3700.2.0 \| Type \| Description \| --------- \| --------- \| \| Average \| \| \| Highest \| \| \| Lowest \| \| \| Custom \| \| | | `score` | number | No | — | The score associated with this attempt. | | `status` | string | No | — | The status of this attempt. \| Type \| Description \| --------- \| --------- \| \| NotAttempted \| none of the students in a group has submitted an attempt; applies only to group assessments \| \| Abandoned \| **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. \| \| InProgress \| attempt activity has commenced, but has not been submitted for grading \| \| Suspended \| **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. \| \| Canceled \| **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. \| \| NeedsGrading \| attempt has been submitted for grading, but has not been fully graded \| \| Completed \| a grade has been entered for the attempt \| \| InProgressAgain \| attempt has been graded, but more student activity occurred after the grade was entered; applies only to collaborative tools such as discussions \| \| NeedsGradingAgain \| additional student activity occurring after a grade was entered requires that the attempt be regraded; applies only to collaborative tools such as discussions \| | | `studentComments` | string | No | — | The student comments associated with this attempt. | | `studentSubmission` | string | No | — | The student submission text associated with this attempt. | | `text` | string | No | — | The text grade associated with this attempt. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "columnId": { "type": "string", "description": "Column Id" }, "attemptId": { "type": "string", "description": "Attempt Id" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "attemptReceipt": { "type": "object", "description": "Attempt Receipt", "properties": { "receiptId": { "type": "string", "description": "The associated receipt ID." }, "submissionDate": { "type": "string", "description": "Get the associated receipt submission date." } } }, "exempt": { "type": "boolean", "description": "Whether the score associated with this attempt is ignored when computing the user's grade for the associated grade column." }, "feedback": { "type": "string", "description": "The instructor feedback associated with this attempt." }, "notes": { "type": "string", "description": "The instructor notes associated with this attempt." }, "reconciliationMode": { "type": "string", "description": "The reconciliation mode to use when reconciling the attempt grade. When modifying reconciliationMode, score is also required. A new score will not be calculated based on the reconciliationMode **Since**: 3700.2.0 | Type | Description | --------- | --------- | | Average | | | Highest | | | Lowest | | | Custom | |", "enum": [ "Average", "Highest", "Lowest", "Custom" ] }, "score": { "type": "number", "description": "The score associated with this attempt." }, "status": { "type": "string", "description": "The status of this attempt. | Type | Description | --------- | --------- | | NotAttempted | none of the students in a group has submitted an attempt; applies only to group assessments | | Abandoned | **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | InProgress | attempt activity has commenced, but has not been submitted for grading | | Suspended | **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | Canceled | **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | NeedsGrading | attempt has been submitted for grading, but has not been fully graded | | Completed | a grade has been entered for the attempt | | InProgressAgain | attempt has been graded, but more student activity occurred after the grade was entered; applies only to collaborative tools such as discussions | | NeedsGradingAgain | additional student activity occurring after a grade was entered requires that the attempt be regraded; applies only to collaborative tools such as discussions |", "enum": [ "NotAttempted", "Abandoned", "InProgress", "Suspended", "Canceled", "NeedsGrading", "Completed", "InProgressAgain", "NeedsGradingAgain" ] }, "studentComments": { "type": "string", "description": "The student comments associated with this attempt." }, "studentSubmission": { "type": "string", "description": "The student submission text associated with this attempt." }, "text": { "type": "string", "description": "The text grade associated with this attempt." } }, "required": [ "PCID", "columnId", "attemptId", "courseId" ] } ``` *** ## blackboard\_grades\_patch\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid\_users\_by\_userid Update Column Grade **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `columnId` | string | Yes | — | The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:column1 \| \| finalGrade \| finalGrade \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `exempt` | boolean | No | — | Whether the score associated with this grade is ignored when computing the course grade. | | `feedback` | string | No | — | The instructor feedback associated with this grade. This feedback is used for grades on manual grade columns. That is, when column.grading.type = Manual. It is also used when column.grading.type = Attempts and the grade has been manually overridden. | | `gradeNotationId` | string | No | — | The Id of a Grade Notation which can be optionally associated with this Grade. If a Grade Notation is specified for this Grade, then the DisplayGrade's Text attribute will contain the Grade Notation's Description. | | `notes` | string | No | — | The instructor notes associated with this grade. This notes field is used for grades on manual grade columns. That is, when column.grading.type = Manual. It is also used when column.grading.type = Attempts and the grade has been manually overridden. | | `score` | number | No | — | The overridden score of this grade. This field is only used for overriding the grade | | `text` | string | No | — | The overridden text representation of this grade. This field is only used for overriding the grade via text value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "columnId": { "type": "string", "description": "The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword 'finalGrade', which indicates that the course's final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "exempt": { "type": "boolean", "description": "Whether the score associated with this grade is ignored when computing the course grade." }, "feedback": { "type": "string", "description": "The instructor feedback associated with this grade. This feedback is used for grades on manual grade columns. That is, when column.grading.type = Manual. It is also used when column.grading.type = Attempts and the grade has been manually overridden." }, "gradeNotationId": { "type": "string", "description": "The Id of a Grade Notation which can be optionally associated with this Grade. If a Grade Notation is specified for this Grade, then the DisplayGrade's Text attribute will contain the Grade Notation's Description." }, "notes": { "type": "string", "description": "The instructor notes associated with this grade. This notes field is used for grades on manual grade columns. That is, when column.grading.type = Manual. It is also used when column.grading.type = Attempts and the grade has been manually overridden." }, "score": { "type": "number", "description": "The overridden score of this grade. This field is only used for overriding the grade" }, "text": { "type": "string", "description": "The overridden text representation of this grade. This field is only used for overriding the grade via text value" } }, "required": [ "PCID", "courseId", "columnId", "userId" ] } ``` *** ## blackboard\_grades\_patch\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_gradenotations\_by\_gradenotationid Update Grade Notation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `gradeNotationId` | string | Yes | — | Grade Notation Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `code` | string | No | — | The performance code associated with the grade notation. | | `description` | string | No | — | The description of the grade notation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "gradeNotationId": { "type": "string", "description": "Grade Notation Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "code": { "type": "string", "description": "The performance code associated with the grade notation." }, "description": { "type": "string", "description": "The description of the grade notation." } }, "required": [ "PCID", "courseId", "gradeNotationId" ] } ``` *** ## blackboard\_grades\_patch\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_periods\_by\_periodid Update Grading Period **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `periodId` | string | Yes | — | Period Id | | `associate` | boolean | No | — | The associate value | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `dateMode` | string | No | — | Property may be set to DoNotUseDates to explicitly blank dates, in which case startDate and endDate are ignored; otherwise set to UseDates; in this case startDate and endDate must be included and valid. \| Type \| Description \| --------- \| --------- \| \| DoNotUseDates \| Do not use dates \| \| UseDates \| Use dates \| | | `description` | string | No | — | The description of the grading period. Length is limited to 1000 characters. | | `end` | string | No | — | If start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. End dates will be persisted as ending at 23:59:59 on the submitted day. | | `position` | integer | No | — | The relative position of the grading period to other grading periods when viewed in the grade book. | | `start` | string | No | — | If start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. Start dates will be persisted as starting at 00:00:00 on the submitted day. | | `title` | string | No | — | The title of the grading period. Length is limited to 64 characters. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "periodId": { "type": "string", "description": "Period Id" }, "associate": { "type": "boolean", "description": "The associate value" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "dateMode": { "type": "string", "description": "Property may be set to DoNotUseDates to explicitly blank dates, in which case startDate and endDate are ignored; otherwise set to UseDates; in this case startDate and endDate must be included and valid. | Type | Description | --------- | --------- | | DoNotUseDates | Do not use dates | | UseDates | Use dates |", "enum": [ "DoNotUseDates", "UseDates" ] }, "description": { "type": "string", "description": "The description of the grading period. Length is limited to 1000 characters." }, "end": { "type": "string", "description": "If start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. End dates will be persisted as ending at 23:59:59 on the submitted day." }, "position": { "type": "integer", "description": "The relative position of the grading period to other grading periods when viewed in the grade book." }, "start": { "type": "string", "description": "If start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. Start dates will be persisted as starting at 00:00:00 on the submitted day." }, "title": { "type": "string", "description": "The title of the grading period. Length is limited to 64 characters." } }, "required": [ "PCID", "courseId", "periodId" ] } ``` *** ## blackboard\_grades\_patch\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_schemas\_by\_schemaid Update Grade Schema **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `schemaId` | string | Yes | — | The grade schema ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:schema1 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `description` | string | No | — | The description of this grade schema. | | `externalId` | string | No | — | The externalId associated with this grade schema. | | `symbols` | object\[] | No | — | The list of grade symbols for this grade schema. Only returned for Tabular scaleType schemas. | | `title` | string | No | — | The title of this grade schema. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "schemaId": { "type": "string", "description": "The grade schema ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:schema1 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "description": { "type": "string", "description": "The description of this grade schema." }, "externalId": { "type": "string", "description": "The externalId associated with this grade schema." }, "symbols": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of this grade symbol." }, "absoluteValue": { "type": "number", "description": "The absoluteValue of this grade symbol." }, "lowerBound": { "type": "number", "description": "The lowerBound of this grade symbol." }, "upperBound": { "type": "number", "description": "The upperBound of this grade symbol." } } }, "description": "The list of grade symbols for this grade schema. Only returned for Tabular scaleType schemas." }, "title": { "type": "string", "description": "The title of this grade schema." } }, "required": [ "PCID", "courseId", "schemaId" ] } ``` *** ## blackboard\_grades\_post\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_attempts\_by\_attemptid\_files Attach File **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `attemptId` | string | Yes | — | Attempt Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `name` | string | No | — | The name of the file which has been attached to an Attempt including the file extension. | | `uploadId` | string | Yes | — | Upload Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "attemptId": { "type": "string", "description": "Attempt Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "name": { "type": "string", "description": "The name of the file which has been attached to an Attempt including the file extension." }, "uploadId": { "type": "string", "description": "Upload Id" } }, "required": [ "PCID", "courseId", "attemptId", "uploadId" ] } ``` *** ## blackboard\_grades\_post\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns Create Grade Column **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling the availability/visibility of grade column data. | | `description` | string | No | — | The description of the grade column. | | `displayName` | string | No | — | The display name of the grade column. Only applicable for Classic courses. Ultra courses will simply use the `name` field. **Since**: 3300.2.0 | | `externalGrade` | boolean | No | — | Whether this grade column is an external grade column. | | `externalId` | string | No | — | The externalId for this grade column | | `externalToolId` | string | No | — | The externalId for this grade column **Since**: 3500.2.0 | | `gradebookCategoryId` | string | No | — | The gradebook category ID for the grade column. **Since**: 3400.2.0 | | `grading` | object | Yes | — | Settings controlling whether numerical and text grade values for this grade column are calculated, determined based on attempts, or manually entered. | | `includeInCalculations` | boolean | No | — | Indicates whether or not this column is included in gradebook calculations. Cannot be set for Ultra courses. Default: true **Since**: 3800.4.0 | | `name` | string | Yes | — | The name of the grade column. | | `score` | object | No | — | Settings controlling the numerical scoring of this grade column. | | `showStatisticsToStudents` | boolean | No | — | Indicates whether or not column statistics are shown to students. Read-only for Ultra courses. Default: false **Since**: 3800.4.0 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling the availability/visibility of grade column data.", "properties": { "available": { "type": "string", "description": "Whether this grade column is available to students | Type | Description | --------- | --------- | | Yes | Students may view the grade column. | | No | Students may not view the grade column. |", "enum": [ "Yes", "No" ] } } }, "description": { "type": "string", "description": "The description of the grade column." }, "displayName": { "type": "string", "description": "The display name of the grade column. Only applicable for Classic courses. Ultra courses will simply use the `name` field. **Since**: 3300.2.0" }, "externalGrade": { "type": "boolean", "description": "Whether this grade column is an external grade column." }, "externalId": { "type": "string", "description": "The externalId for this grade column" }, "externalToolId": { "type": "string", "description": "The externalId for this grade column **Since**: 3500.2.0" }, "gradebookCategoryId": { "type": "string", "description": "The gradebook category ID for the grade column. **Since**: 3400.2.0" }, "grading": { "type": "object", "description": "Settings controlling whether numerical and text grade values for this grade column are calculated, determined based on attempts, or manually entered.", "properties": { "type": { "type": "string", "description": "The type of Grading settings for this Grade Column. | Type | Description | --------- | --------- | | Attempts | Indicates score and grade values are determined based on user attempts | | Calculated | Indicates score and grade values are determined by applying a calculated formula. | | Manual | Indicates score and grade values are manually entered. |", "enum": [ "Attempts", "Calculated", "Manual" ] }, "due": { "type": "string", "description": "The date on which attempts are due for the grade column." }, "attemptsAllowed": { "type": "integer", "description": "Number of attempts allowed for the grade column." }, "scoringModel": { "type": "string", "description": "The scoring model for the submitted grade column attempts. | Type | Description | --------- | --------- | | Last | | | Highest | | | Lowest | | | First | | | Average | |", "enum": [ "Last", "Highest", "Lowest", "First", "Average" ] }, "schemaId": { "type": "string", "description": "The ID of the grade schema associated with this grade column. Mutable since 3400.2.0 **Since**: 3200.13.0" }, "anonymousGrading": { "type": "object", "description": "Settings for anonymous grading" } }, "required": [ "anonymousGrading", "type" ] }, "includeInCalculations": { "type": "boolean", "description": "Indicates whether or not this column is included in gradebook calculations. Cannot be set for Ultra courses. Default: true **Since**: 3800.4.0" }, "name": { "type": "string", "description": "The name of the grade column." }, "score": { "type": "object", "description": "Settings controlling the numerical scoring of this grade column.", "properties": { "possible": { "type": "number", "description": "The points possible for this grade column." } } }, "showStatisticsToStudents": { "type": "boolean", "description": "Indicates whether or not column statistics are shown to students. Read-only for Ultra courses. Default: false **Since**: 3800.4.0" } }, "required": [ "PCID", "courseId", "grading", "name" ] } ``` *** ## blackboard\_grades\_post\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_columns\_by\_columnid\_attempts Create Column Attempt **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `columnId` | string | Yes | — | Column Id | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `attemptDate` | string | No | — | Return the attempt date associated with this attempt. | | `attemptReceipt` | object | No | — | Attempt Receipt | | `exempt` | boolean | No | — | Whether the score associated with this attempt is ignored when computing the user's grade for the associated grade column. | | `feedback` | string | No | — | The instructor feedback associated with this attempt. | | `notes` | string | No | — | The instructor notes associated with this attempt. | | `reconciliationMode` | string | No | — | The reconciliation mode to use when reconciling the attempt grade. When modifying reconciliationMode, score is also required. A new score will not be calculated based on the reconciliationMode **Since**: 3700.2.0 \| Type \| Description \| --------- \| --------- \| \| Average \| \| \| Highest \| \| \| Lowest \| \| \| Custom \| \| | | `score` | number | No | — | The score associated with this attempt. | | `status` | string | No | — | The status of this attempt. \| Type \| Description \| --------- \| --------- \| \| NotAttempted \| none of the students in a group has submitted an attempt; applies only to group assessments \| \| Abandoned \| **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. \| \| InProgress \| attempt activity has commenced, but has not been submitted for grading \| \| Suspended \| **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. \| \| Canceled \| **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. \| \| NeedsGrading \| attempt has been submitted for grading, but has not been fully graded \| \| Completed \| a grade has been entered for the attempt \| \| InProgressAgain \| attempt has been graded, but more student activity occurred after the grade was entered; applies only to collaborative tools such as discussions \| \| NeedsGradingAgain \| additional student activity occurring after a grade was entered requires that the attempt be regraded; applies only to collaborative tools such as discussions \| | | `studentComments` | string | No | — | The student comments associated with this attempt. | | `studentSubmission` | string | No | — | The student submission text associated with this attempt. | | `text` | string | No | — | The text grade associated with this attempt. | | `userId` | string | No | — | The user ID associated with this attempt. Defaults to the authenticated user on create. Can be specified as a user other than the authenticated user if the authenticated user has the "course.gradebook.MODIFY" entitlement and the authenticated application has the "course.attempt.nonowner.SUBMIT" entitlement. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "columnId": { "type": "string", "description": "Column Id" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "attemptDate": { "type": "string", "description": "Return the attempt date associated with this attempt." }, "attemptReceipt": { "type": "object", "description": "Attempt Receipt", "properties": { "receiptId": { "type": "string", "description": "The associated receipt ID." }, "submissionDate": { "type": "string", "description": "Get the associated receipt submission date." } } }, "exempt": { "type": "boolean", "description": "Whether the score associated with this attempt is ignored when computing the user's grade for the associated grade column." }, "feedback": { "type": "string", "description": "The instructor feedback associated with this attempt." }, "notes": { "type": "string", "description": "The instructor notes associated with this attempt." }, "reconciliationMode": { "type": "string", "description": "The reconciliation mode to use when reconciling the attempt grade. When modifying reconciliationMode, score is also required. A new score will not be calculated based on the reconciliationMode **Since**: 3700.2.0 | Type | Description | --------- | --------- | | Average | | | Highest | | | Lowest | | | Custom | |", "enum": [ "Average", "Highest", "Lowest", "Custom" ] }, "score": { "type": "number", "description": "The score associated with this attempt." }, "status": { "type": "string", "description": "The status of this attempt. | Type | Description | --------- | --------- | | NotAttempted | none of the students in a group has submitted an attempt; applies only to group assessments | | Abandoned | **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | InProgress | attempt activity has commenced, but has not been submitted for grading | | Suspended | **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | Canceled | **Deprecated**: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | NeedsGrading | attempt has been submitted for grading, but has not been fully graded | | Completed | a grade has been entered for the attempt | | InProgressAgain | attempt has been graded, but more student activity occurred after the grade was entered; applies only to collaborative tools such as discussions | | NeedsGradingAgain | additional student activity occurring after a grade was entered requires that the attempt be regraded; applies only to collaborative tools such as discussions |", "enum": [ "NotAttempted", "Abandoned", "InProgress", "Suspended", "Canceled", "NeedsGrading", "Completed", "InProgressAgain", "NeedsGradingAgain" ] }, "studentComments": { "type": "string", "description": "The student comments associated with this attempt." }, "studentSubmission": { "type": "string", "description": "The student submission text associated with this attempt." }, "text": { "type": "string", "description": "The text grade associated with this attempt." }, "userId": { "type": "string", "description": "The user ID associated with this attempt. Defaults to the authenticated user on create. Can be specified as a user other than the authenticated user if the authenticated user has the \"course.gradebook.MODIFY\" entitlement and the authenticated application has the \"course.attempt.nonowner.SUBMIT\" entitlement." } }, "required": [ "PCID", "columnId", "courseId" ] } ``` *** ## blackboard\_grades\_post\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_gradenotations Create Grade Notation **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `code` | string | Yes | — | The performance code associated with the grade notation. | | `description` | string | Yes | — | The description of the grade notation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "code": { "type": "string", "description": "The performance code associated with the grade notation." }, "description": { "type": "string", "description": "The description of the grade notation." } }, "required": [ "PCID", "courseId", "code", "description" ] } ``` *** ## blackboard\_grades\_post\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_periods Create Grading Period **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `associate` | boolean | No | — | The associate value | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `dateMode` | string | No | — | Property may be set to DoNotUseDates to explicitly blank dates, in which case startDate and endDate are ignored; otherwise set to UseDates; in this case startDate and endDate must be included and valid. \| Type \| Description \| --------- \| --------- \| \| DoNotUseDates \| Do not use dates \| \| UseDates \| Use dates \| | | `description` | string | No | — | The description of the grading period. Length is limited to 1000 characters. | | `end` | string | No | — | If start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. End dates will be persisted as ending at 23:59:59 on the submitted day. | | `position` | integer | No | — | The relative position of the grading period to other grading periods when viewed in the grade book. | | `start` | string | No | — | If start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. Start dates will be persisted as starting at 00:00:00 on the submitted day. | | `title` | string | Yes | — | The title of the grading period. Length is limited to 64 characters. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "associate": { "type": "boolean", "description": "The associate value" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "dateMode": { "type": "string", "description": "Property may be set to DoNotUseDates to explicitly blank dates, in which case startDate and endDate are ignored; otherwise set to UseDates; in this case startDate and endDate must be included and valid. | Type | Description | --------- | --------- | | DoNotUseDates | Do not use dates | | UseDates | Use dates |", "enum": [ "DoNotUseDates", "UseDates" ] }, "description": { "type": "string", "description": "The description of the grading period. Length is limited to 1000 characters." }, "end": { "type": "string", "description": "If start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. End dates will be persisted as ending at 23:59:59 on the submitted day." }, "position": { "type": "integer", "description": "The relative position of the grading period to other grading periods when viewed in the grade book." }, "start": { "type": "string", "description": "If start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. Start dates will be persisted as starting at 00:00:00 on the submitted day." }, "title": { "type": "string", "description": "The title of the grading period. Length is limited to 64 characters." } }, "required": [ "PCID", "courseId", "title" ] } ``` *** ## blackboard\_grades\_post\_learn\_api\_public\_courses\_by\_courseid\_gradebook\_schemas Create Grade Schema **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `description` | string | No | — | The description of this grade schema. | | `externalId` | string | No | — | The externalId associated with this grade schema. | | `scaleType` | string | No | — | The scale type of this grade schema. \| Type \| Description \| --------- \| --------- \| \| Percent \| \| \| Score \| \| \| Tabular \| \| \| Text \| \| \| CompleteIncomplete \| \| | | `symbols` | object\[] | No | — | The list of grade symbols for this grade schema. Only returned for Tabular scaleType schemas. | | `title` | string | Yes | — | The title of this grade schema. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "description": { "type": "string", "description": "The description of this grade schema." }, "externalId": { "type": "string", "description": "The externalId associated with this grade schema." }, "scaleType": { "type": "string", "description": "The scale type of this grade schema. | Type | Description | --------- | --------- | | Percent | | | Score | | | Tabular | | | Text | | | CompleteIncomplete | |", "enum": [ "Percent", "Score", "Tabular", "Text", "CompleteIncomplete" ] }, "symbols": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of this grade symbol." }, "absoluteValue": { "type": "number", "description": "The absoluteValue of this grade symbol." }, "lowerBound": { "type": "number", "description": "The lowerBound of this grade symbol." }, "upperBound": { "type": "number", "description": "The upperBound of this grade symbol." } } }, "description": "The list of grade symbols for this grade schema. Only returned for Tabular scaleType schemas." }, "title": { "type": "string", "description": "The title of this grade schema." } }, "required": [ "PCID", "courseId", "title" ] } ``` # blackboard-groups Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/blackboard/blackboard-groups Blackboard Groups - course groups, group users, memberships, and messages **Server path:** `/blackboard-groups` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_by_groupid`](#blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_by_groupid) | Delete Group | | [`blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid`](#blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid) | Delete Group Membership | | [`blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_sets_by_groupid`](#blackboard_groups_delete_learn_api_public_courses_by_courseid_groups_sets_by_groupid) | Delete Group Set | | [`blackboard_groups_delete_learn_api_public_courses_by_courseid_messages_by_messageid`](#blackboard_groups_delete_learn_api_public_courses_by_courseid_messages_by_messageid) | Delete Message | | [`blackboard_groups_delete_learn_api_public_courses_by_courseid_users_by_userid`](#blackboard_groups_delete_learn_api_public_courses_by_courseid_users_by_userid) | Delete Membership | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups) | Get Groups | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid) | Get Group | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid_users`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid_users) | Get Group Memberships | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid) | Get Group Membership | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets) | Get Group Sets | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets_by_groupid`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets_by_groupid) | Get Group Set | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets_by_groupid_groups`](#blackboard_groups_get_learn_api_public_courses_by_courseid_groups_sets_by_groupid_groups) | Get Group Set Children | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_messages`](#blackboard_groups_get_learn_api_public_courses_by_courseid_messages) | Get Messages | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_messages_by_messageid_participants`](#blackboard_groups_get_learn_api_public_courses_by_courseid_messages_by_messageid_participants) | Get Message Participants | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_messages_folders`](#blackboard_groups_get_learn_api_public_courses_by_courseid_messages_folders) | Get Folders | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_users`](#blackboard_groups_get_learn_api_public_courses_by_courseid_users) | Get Course Memberships | | [`blackboard_groups_get_learn_api_public_courses_by_courseid_users_by_userid`](#blackboard_groups_get_learn_api_public_courses_by_courseid_users_by_userid) | Get Membership | | [`blackboard_groups_get_learn_api_public_users_by_userid_courses`](#blackboard_groups_get_learn_api_public_users_by_userid_courses) | Get User Memberships | | [`blackboard_groups_patch_learn_api_public_courses_by_courseid_groups_by_groupid`](#blackboard_groups_patch_learn_api_public_courses_by_courseid_groups_by_groupid) | Update Group | | [`blackboard_groups_patch_learn_api_public_courses_by_courseid_groups_sets_by_groupid`](#blackboard_groups_patch_learn_api_public_courses_by_courseid_groups_sets_by_groupid) | Update Group Set | | [`blackboard_groups_patch_learn_api_public_courses_by_courseid_messages_by_messageid`](#blackboard_groups_patch_learn_api_public_courses_by_courseid_messages_by_messageid) | Update Message | | [`blackboard_groups_patch_learn_api_public_courses_by_courseid_users_by_userid`](#blackboard_groups_patch_learn_api_public_courses_by_courseid_users_by_userid) | Update Membership | | [`blackboard_groups_post_learn_api_public_courses_by_courseid_groups`](#blackboard_groups_post_learn_api_public_courses_by_courseid_groups) | Create Group | | [`blackboard_groups_post_learn_api_public_courses_by_courseid_groups_sets`](#blackboard_groups_post_learn_api_public_courses_by_courseid_groups_sets) | Create Group Set | | [`blackboard_groups_post_learn_api_public_courses_by_courseid_groups_sets_by_groupid_groups`](#blackboard_groups_post_learn_api_public_courses_by_courseid_groups_sets_by_groupid_groups) | Create Group Set Child | | [`blackboard_groups_post_learn_api_public_courses_by_courseid_messages`](#blackboard_groups_post_learn_api_public_courses_by_courseid_messages) | Create Message | | [`blackboard_groups_put_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid`](#blackboard_groups_put_learn_api_public_courses_by_courseid_groups_by_groupid_users_by_userid) | Create Group Membership | | [`blackboard_groups_put_learn_api_public_courses_by_courseid_users_by_userid`](#blackboard_groups_put_learn_api_public_courses_by_courseid_users_by_userid) | Create Membership | *** ## blackboard\_groups\_delete\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid Delete Group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "groupId", "courseId" ] } ``` *** ## blackboard\_groups\_delete\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid\_users\_by\_userid Delete Group Membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "courseId", "groupId", "userId" ] } ``` *** ## blackboard\_groups\_delete\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets\_by\_groupid Delete Group Set **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" } }, "required": [ "PCID", "courseId", "groupId" ] } ``` *** ## blackboard\_groups\_delete\_learn\_api\_public\_courses\_by\_courseid\_messages\_by\_messageid Delete Message **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `messageId` | string | Yes | — | Message Id | | `folderType` | string | No | — | Specifies the folder type, The default type is inbox \| Type \| Description \| --------- \| --------- \| \| Inbox \| \| \| Sent \| \| \| Delete \| \| \| Custom \| \| | | `folderName` | string | No | — | Specifies the folder name of the custom folder | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "messageId": { "type": "string", "description": "Message Id" }, "folderType": { "type": "string", "description": "Specifies the folder type, The default type is inbox | Type | Description | --------- | --------- | | Inbox | | | Sent | | | Delete | | | Custom | |", "enum": [ "Inbox", "Sent", "Delete", "Custom" ] }, "folderName": { "type": "string", "description": "Specifies the folder name of the custom folder" } }, "required": [ "PCID", "courseId", "messageId" ] } ``` *** ## blackboard\_groups\_delete\_learn\_api\_public\_courses\_by\_courseid\_users\_by\_userid Delete Membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "courseId", "userId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups Get Groups **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `name` | string | No | — | The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0 | | `nameCompare` | string | No | — | Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 \| Type \| Description \| --------- \| --------- \| \| equals \| \| \| notEquals \| \| \| contains \| \| \| notContains \| \| \| startsWith \| \| | | `inGroupSet` | boolean | No | — | Indicates whether only groups in a GroupSet (or groups NOT in a GroupSet) should be included **Since**: 3900.10.0 | | `created` | string | No | — | Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `modified` | string | No | — | Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0 | | `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "name(desc)" Supported fields are: - name - externalId **Since**: 3100.4.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "name": { "type": "string", "description": "The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0" }, "nameCompare": { "type": "string", "description": "Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 | Type | Description | --------- | --------- | | equals | | | notEquals | | | contains | | | notContains | | | startsWith | |", "enum": [ "equals", "notEquals", "contains", "notContains", "startsWith" ] }, "inGroupSet": { "type": "boolean", "description": "Indicates whether only groups in a GroupSet (or groups NOT in a GroupSet) should be included **Since**: 3900.10.0" }, "created": { "type": "string", "description": "Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "modified": { "type": "string", "description": "Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0" }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"name(desc)\" Supported fields are: - name - externalId **Since**: 3100.4.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid Get Group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "groupId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid\_users Get Group Memberships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • user\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • user
" } }, "required": [ "PCID", "groupId", "courseId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid\_users\_by\_userid Get Group Membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "groupId", "userId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets Get Group Sets **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `name` | string | No | — | The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0 | | `nameCompare` | string | No | — | Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 \| Type \| Description \| --------- \| --------- \| \| equals \| \| \| notEquals \| \| \| contains \| \| \| notContains \| \| \| startsWith \| \| | | `created` | string | No | — | Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `modified` | string | No | — | Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0 | | `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "name(desc)" Supported fields are: - name - externalId **Since**: 3100.4.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "name": { "type": "string", "description": "The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0" }, "nameCompare": { "type": "string", "description": "Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 | Type | Description | --------- | --------- | | equals | | | notEquals | | | contains | | | notContains | | | startsWith | |", "enum": [ "equals", "notEquals", "contains", "notContains", "startsWith" ] }, "created": { "type": "string", "description": "Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "modified": { "type": "string", "description": "Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0" }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"name(desc)\" Supported fields are: - name - externalId **Since**: 3100.4.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets\_by\_groupid Get Group Set **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "groupId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets\_by\_groupid\_groups Get Group Set Children **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `name` | string | No | — | The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0 | | `nameCompare` | string | No | — | Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 \| Type \| Description \| --------- \| --------- \| \| equals \| \| \| notEquals \| \| \| contains \| \| \| notContains \| \| \| startsWith \| \| | | `created` | string | No | — | Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `modified` | string | No | — | Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0 | | `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "name(desc)" Supported fields are: - name - externalId **Since**: 3100.4.0 | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "name": { "type": "string", "description": "The group 'name' value to use as search criteria. See also: nameCompare. **Since**: 3900.10.0" }, "nameCompare": { "type": "string", "description": "Used alongside the 'name' search parameter. Defaults to StartsWith if not specified. **Since**: 3900.10.0 | Type | Description | --------- | --------- | | equals | | | notEquals | | | contains | | | notContains | | | startsWith | |", "enum": [ "equals", "notEquals", "contains", "notContains", "startsWith" ] }, "created": { "type": "string", "description": "Search for groups with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.8.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "modified": { "type": "string", "description": "Search for groups with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.8.0" }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"name(desc)\" Supported fields are: - name - externalId **Since**: 3100.4.0" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "groupId", "courseId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_messages Get Messages **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `folderType` | string | No | — | Specifies the folder type, The default type is inbox \| Type \| Description \| --------- \| --------- \| \| Inbox \| \| \| Sent \| \| \| Delete \| \| \| Custom \| \| | | `folderName` | string | No | — | Specifies the folder name of the custom folder | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "isRead(desc),start" Supported fields are: - isRead - postedDate **Since**: 3900.2.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • sender\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "folderType": { "type": "string", "description": "Specifies the folder type, The default type is inbox | Type | Description | --------- | --------- | | Inbox | | | Sent | | | Delete | | | Custom | |", "enum": [ "Inbox", "Sent", "Delete", "Custom" ] }, "folderName": { "type": "string", "description": "Specifies the folder name of the custom folder" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"isRead(desc),start\" Supported fields are: - isRead - postedDate **Since**: 3900.2.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • sender
" } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_messages\_by\_messageid\_participants Get Message Participants **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `messageId` | string | Yes | — | Message Id | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `participationType` | string | No | — | Search the participation type **Since**: 3800.20.0 | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "PARTICIPATION\_TYPE(desc),start" Supported fields are: - participationType **Since**: 3900.2.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • user\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "messageId": { "type": "string", "description": "Message Id" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "participationType": { "type": "string", "description": "Search the participation type **Since**: 3800.20.0" }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"PARTICIPATION_TYPE(desc),start\" Supported fields are: - participationType **Since**: 3900.2.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • user
" } }, "required": [ "PCID", "courseId", "messageId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_messages\_folders Get Folders **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_users Get Course Memberships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `role` | string | No | — | Search for memberships with a course role id that matches this value. **Since**: 3500.5.0 | | `created` | string | No | — | Search for memberships with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `modified` | string | No | — | Search for memberships with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.9.0 | | `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3800.9.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `dataSourceId` | string | No | — | Search for memberships with this dataSourceId. This may optionally be the data source's externalId using the syntax "externalId:math101". **Since**: 3100.0.0 | | `lastAccessed` | string | No | — | Search for memberships with a last accessed date relative to this value. 'lastAccessedCompare' may also be sent to control search behavior. **Since**: 3300.9.0 | | `lastAccessedCompare` | string | No | — | Used alongside the 'lastAccessed' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3300.9.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `availability.available` | string | No | — | Search for users with availability.available properties that contain this value. **Since**: 3100.0.0 \| Type \| Description \| --------- \| --------- \| \| Yes \| \| \| No \| \| \| Disabled \| **Since**: 3100.0.0 \| | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "created(desc)" Supported fields are: - created - lastAccessed (Since 3300.9.0) **Since**: 3100.0.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • user\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "role": { "type": "string", "description": "Search for memberships with a course role id that matches this value. **Since**: 3500.5.0" }, "created": { "type": "string", "description": "Search for memberships with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "modified": { "type": "string", "description": "Search for memberships with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.9.0" }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3800.9.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "dataSourceId": { "type": "string", "description": "Search for memberships with this dataSourceId. This may optionally be the data source's externalId using the syntax \"externalId:math101\". **Since**: 3100.0.0" }, "lastAccessed": { "type": "string", "description": "Search for memberships with a last accessed date relative to this value. 'lastAccessedCompare' may also be sent to control search behavior. **Since**: 3300.9.0" }, "lastAccessedCompare": { "type": "string", "description": "Used alongside the 'lastAccessed' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3300.9.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "availability.available": { "type": "string", "description": "Search for users with availability.available properties that contain this value. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |", "enum": [ "Yes", "No", "Disabled" ] }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"created(desc)\" Supported fields are: - created - lastAccessed (Since 3300.9.0) **Since**: 3100.0.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • user
" } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_courses\_by\_courseid\_users\_by\_userid Get Membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • user\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • user
" } }, "required": [ "PCID", "courseId", "userId" ] } ``` *** ## blackboard\_groups\_get\_learn\_api\_public\_users\_by\_userid\_courses Get User Memberships **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `role` | string | No | — | Search for memberships with a course role id that matches this value. **Since**: 3500.5.0 | | `created` | string | No | — | Search for memberships with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `modified` | string | No | — | Search for memberships with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.9.0 | | `modifiedCompare` | string | No | — | Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3800.9.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `dataSourceId` | string | No | — | Search for memberships with this dataSourceId. This may optionally be the data source's externalId using the syntax "externalId:math101". **Since**: 3100.0.0 | | `lastAccessed` | string | No | — | Search for memberships with a last accessed date relative to this value. 'lastAccessedCompare' may also be sent to control search behavior. **Since**: 3300.9.0 | | `lastAccessedCompare` | string | No | — | Used alongside the 'lastAccessed' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3300.9.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `availability.available` | string | No | — | Search for users with availability.available properties that contain this value. **Since**: 3100.0.0 \| Type \| Description \| --------- \| --------- \| \| Yes \| \| \| No \| \| \| Disabled \| **Since**: 3100.0.0 \| | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "created(desc)" Supported fields are: - created - lastAccessed (Since 3300.9.0) **Since**: 3100.0.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • course\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "role": { "type": "string", "description": "Search for memberships with a course role id that matches this value. **Since**: 3500.5.0" }, "created": { "type": "string", "description": "Search for memberships with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "modified": { "type": "string", "description": "Search for memberships with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.9.0" }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3800.9.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "dataSourceId": { "type": "string", "description": "Search for memberships with this dataSourceId. This may optionally be the data source's externalId using the syntax \"externalId:math101\". **Since**: 3100.0.0" }, "lastAccessed": { "type": "string", "description": "Search for memberships with a last accessed date relative to this value. 'lastAccessedCompare' may also be sent to control search behavior. **Since**: 3300.9.0" }, "lastAccessedCompare": { "type": "string", "description": "Used alongside the 'lastAccessed' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3300.9.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "availability.available": { "type": "string", "description": "Search for users with availability.available properties that contain this value. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |", "enum": [ "Yes", "No", "Disabled" ] }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"created(desc)\" Supported fields are: - created - lastAccessed (Since 3300.9.0) **Since**: 3100.0.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • course
" } }, "required": [ "PCID", "userId" ] } ``` *** ## blackboard\_groups\_patch\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid Update Group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the group to students. | | `description` | string | No | — | The description of the group. This field supports BbML; see \ for more information. | | `enrollment` | object | No | — | Settings controlling enrollment of the group to students. | | `externalId` | string | No | — | An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create. | | `name` | string | No | — | The title of the group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the group to students.", "properties": { "available": { "type": "string", "description": "Whether the Group is currently available to students. | Type | Description | --------- | --------- | | Yes | Students may access the group. | | No | Students may not access the group. | | SignupOnly | Students may only signup and see the group listed, not yet access it. |", "enum": [ "Yes", "No", "SignupOnly" ] } } }, "description": { "type": "string", "description": "The description of the group. This field supports BbML; see here for more information." }, "enrollment": { "type": "object", "description": "Settings controlling enrollment of the group to students.", "properties": { "limit": { "type": "integer", "description": "The maximum allowed enrollment size for self enrolled groups." }, "signupSheet": { "type": "object", "description": "Settings controlling signup to the group for students. Only applicable if Enrollment.Type allows self enrollment." } } }, "externalId": { "type": "string", "description": "An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create." }, "name": { "type": "string", "description": "The title of the group." } }, "required": [ "PCID", "courseId", "groupId" ] } ``` *** ## blackboard\_groups\_patch\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets\_by\_groupid Update Group Set **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the group to students. | | `description` | string | No | — | The description of the group. This field supports BbML; see \ for more information. | | `enrollment` | object | No | — | Settings controlling enrollment of the group to students. | | `externalId` | string | No | — | An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create. | | `name` | string | No | — | The title of the group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the group to students.", "properties": { "available": { "type": "string", "description": "Whether the Group is currently available to students. | Type | Description | --------- | --------- | | Yes | Students may access the group. | | No | Students may not access the group. | | SignupOnly | Students may only signup and see the group listed, not yet access it. |", "enum": [ "Yes", "No", "SignupOnly" ] } } }, "description": { "type": "string", "description": "The description of the group. This field supports BbML; see here for more information." }, "enrollment": { "type": "object", "description": "Settings controlling enrollment of the group to students.", "properties": { "limit": { "type": "integer", "description": "The maximum allowed enrollment size for self enrolled groups." }, "signupSheet": { "type": "object", "description": "Settings controlling signup to the group for students. Only applicable if Enrollment.Type allows self enrollment." } } }, "externalId": { "type": "string", "description": "An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create." }, "name": { "type": "string", "description": "The title of the group." } }, "required": [ "PCID", "groupId", "courseId" ] } ``` *** ## blackboard\_groups\_patch\_learn\_api\_public\_courses\_by\_courseid\_messages\_by\_messageid Update Message **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `messageId` | string | Yes | — | Message Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `isRead` | boolean | No | — | Whether or not the message has been read | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "messageId": { "type": "string", "description": "Message Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "isRead": { "type": "boolean", "description": "Whether or not the message has been read" } }, "required": [ "PCID", "courseId", "messageId" ] } ``` *** ## blackboard\_groups\_patch\_learn\_api\_public\_courses\_by\_courseid\_users\_by\_userid Update Membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | The availability value | | `childCourseId` | string | No | — | The primary ID of the child, cross-listed course, in which the user is directly enrolled. \

This field is read only in Learn versions 3000.11.0 through 3400.0.0. As of 3400.1.0, this field is mutable. \

If this membership's course is a parent course in a cross-listed set, the childCourseId can be updated to move the membership enrollment between child courses and the parent course in the set. Patching the childCourseId to "null" will move the membership to the parent course. **Since**: 3000.11.0 | | `courseRoleId` | string | No | — | The user's role in the course. These roles are also valid for an organization, although they are named differently in the UI. Custom course roles may also be referenced by their IDs. \| Type \| Description \| --------- \| --------- \| \| Instructor \| Has access to all areas in the Control Panel. This role is generally given to those developing, teaching, or facilitating the class. Instructors may access a course that is unavailable to students. This role is customizable and may have different capabilities from what is documented here. \| \| BbFacilitator \| The facilitator is an instructor like role. Facilitators are restricted versions of an instructor, in that they are able to deliver course instruction and administer all aspects of a pre-constructed course, but are not allowed to modify or alter the course. This role is customizable and may have different capabilities from what is documented here. \| \| TeachingAssistant \| The teaching assistant role is that of a co-teacher. Teaching assistants are able to administer all areas of a course. Their only limitations are those imposed by the instructor or Blackboard administrator at your school. This role is customizable and may have different capabilities from what is documented here. \| \| CourseBuilder \| Manages the course without having access to student grades. This role is customizable and may have different capabilities from what is documented here. \| \| Grader \| Assists the instructor in the creation, management, delivery, and grading of items. This role is customizable and may have different capabilities from what is documented here. \| \| Student \| \| \| Guest \| Has no access to the Control Panel. Areas within the course are made available to guests, but typically they can only view course materials; they do not have access to tests or assessments, and do not have permission to post on discussion boards. This role's behavior is immutable. \| | | `dataSourceId` | string | No | — | The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax "externalId:math101". | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "The availability value", "properties": { "available": { "type": "string", "description": "null | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |", "enum": [ "Yes", "No", "Disabled" ] } } }, "childCourseId": { "type": "string", "description": "The primary ID of the child, cross-listed course, in which the user is directly enrolled.

This field is read only in Learn versions 3000.11.0 through 3400.0.0. As of 3400.1.0, this field is mutable.

If this membership's course is a parent course in a cross-listed set, the childCourseId can be updated to move the membership enrollment between child courses and the parent course in the set. Patching the childCourseId to \"null\" will move the membership to the parent course. **Since**: 3000.11.0" }, "courseRoleId": { "type": "string", "description": "The user's role in the course. These roles are also valid for an organization, although they are named differently in the UI. Custom course roles may also be referenced by their IDs. | Type | Description | --------- | --------- | | Instructor | Has access to all areas in the Control Panel. This role is generally given to those developing, teaching, or facilitating the class. Instructors may access a course that is unavailable to students. This role is customizable and may have different capabilities from what is documented here. | | BbFacilitator | The facilitator is an instructor like role. Facilitators are restricted versions of an instructor, in that they are able to deliver course instruction and administer all aspects of a pre-constructed course, but are not allowed to modify or alter the course. This role is customizable and may have different capabilities from what is documented here. | | TeachingAssistant | The teaching assistant role is that of a co-teacher. Teaching assistants are able to administer all areas of a course. Their only limitations are those imposed by the instructor or Blackboard administrator at your school. This role is customizable and may have different capabilities from what is documented here. | | CourseBuilder | Manages the course without having access to student grades. This role is customizable and may have different capabilities from what is documented here. | | Grader | Assists the instructor in the creation, management, delivery, and grading of items. This role is customizable and may have different capabilities from what is documented here. | | Student | | | Guest | Has no access to the Control Panel. Areas within the course are made available to guests, but typically they can only view course materials; they do not have access to tests or assessments, and do not have permission to post on discussion boards. This role's behavior is immutable. |", "enum": [ "Instructor", "BbFacilitator", "TeachingAssistant", "CourseBuilder", "Grader", "Student", "Guest" ] }, "dataSourceId": { "type": "string", "description": "The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax \"externalId:math101\"." } }, "required": [ "PCID", "courseId", "userId" ] } ``` *** ## blackboard\_groups\_post\_learn\_api\_public\_courses\_by\_courseid\_groups Create Group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the group to students. | | `description` | string | No | — | The description of the group. This field supports BbML; see \ for more information. | | `enrollment` | object | No | — | Settings controlling enrollment of the group to students. | | `externalId` | string | No | — | An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create. | | `name` | string | Yes | — | The title of the group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the group to students.", "properties": { "available": { "type": "string", "description": "Whether the Group is currently available to students. | Type | Description | --------- | --------- | | Yes | Students may access the group. | | No | Students may not access the group. | | SignupOnly | Students may only signup and see the group listed, not yet access it. |", "enum": [ "Yes", "No", "SignupOnly" ] } } }, "description": { "type": "string", "description": "The description of the group. This field supports BbML; see here for more information." }, "enrollment": { "type": "object", "description": "Settings controlling enrollment of the group to students.", "properties": { "type": { "type": "string", "description": "Whether the Group allows self enrollment or only enrolled by instructor. This can only be set on creation. | Type | Description | --------- | --------- | | InstructorOnly | Students are added to the Group by the instructor | | SelfEnrollment | Students are added to the Group by self enrollment |", "enum": [ "InstructorOnly", "SelfEnrollment" ] }, "limit": { "type": "integer", "description": "The maximum allowed enrollment size for self enrolled groups." }, "signupSheet": { "type": "object", "description": "Settings controlling signup to the group for students. Only applicable if Enrollment.Type allows self enrollment." } } }, "externalId": { "type": "string", "description": "An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create." }, "name": { "type": "string", "description": "The title of the group." } }, "required": [ "PCID", "courseId", "name" ] } ``` *** ## blackboard\_groups\_post\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets Create Group Set **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the group to students. | | `description` | string | No | — | The description of the group. This field supports BbML; see \ for more information. | | `enrollment` | object | No | — | Settings controlling enrollment of the group to students. | | `externalId` | string | No | — | An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create. | | `name` | string | Yes | — | The title of the group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the group to students.", "properties": { "available": { "type": "string", "description": "Whether the Group is currently available to students. | Type | Description | --------- | --------- | | Yes | Students may access the group. | | No | Students may not access the group. | | SignupOnly | Students may only signup and see the group listed, not yet access it. |", "enum": [ "Yes", "No", "SignupOnly" ] } } }, "description": { "type": "string", "description": "The description of the group. This field supports BbML; see here for more information." }, "enrollment": { "type": "object", "description": "Settings controlling enrollment of the group to students.", "properties": { "type": { "type": "string", "description": "Whether the Group allows self enrollment or only enrolled by instructor. This can only be set on creation. | Type | Description | --------- | --------- | | InstructorOnly | Students are added to the Group by the instructor | | SelfEnrollment | Students are added to the Group by self enrollment |", "enum": [ "InstructorOnly", "SelfEnrollment" ] }, "limit": { "type": "integer", "description": "The maximum allowed enrollment size for self enrolled groups." }, "signupSheet": { "type": "object", "description": "Settings controlling signup to the group for students. Only applicable if Enrollment.Type allows self enrollment." } } }, "externalId": { "type": "string", "description": "An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create." }, "name": { "type": "string", "description": "The title of the group." } }, "required": [ "PCID", "courseId", "name" ] } ``` *** ## blackboard\_groups\_post\_learn\_api\_public\_courses\_by\_courseid\_groups\_sets\_by\_groupid\_groups Create Group Set Child **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the group to students. | | `description` | string | No | — | The description of the group. This field supports BbML; see \ for more information. | | `enrollment` | object | No | — | Settings controlling enrollment of the group to students. | | `externalId` | string | No | — | An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create. | | `name` | string | Yes | — | The title of the group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the group to students.", "properties": { "available": { "type": "string", "description": "Whether the Group is currently available to students. | Type | Description | --------- | --------- | | Yes | Students may access the group. | | No | Students may not access the group. | | SignupOnly | Students may only signup and see the group listed, not yet access it. |", "enum": [ "Yes", "No", "SignupOnly" ] } } }, "description": { "type": "string", "description": "The description of the group. This field supports BbML; see here for more information." }, "enrollment": { "type": "object", "description": "Settings controlling enrollment of the group to students.", "properties": { "type": { "type": "string", "description": "Whether the Group allows self enrollment or only enrolled by instructor. This can only be set on creation. | Type | Description | --------- | --------- | | InstructorOnly | Students are added to the Group by the instructor | | SelfEnrollment | Students are added to the Group by self enrollment |", "enum": [ "InstructorOnly", "SelfEnrollment" ] }, "limit": { "type": "integer", "description": "The maximum allowed enrollment size for self enrolled groups." }, "signupSheet": { "type": "object", "description": "Settings controlling signup to the group for students. Only applicable if Enrollment.Type allows self enrollment." } } }, "externalId": { "type": "string", "description": "An externally-defined unique ID for the group. Defaults to a random UUID if not provided during create." }, "name": { "type": "string", "description": "The title of the group." } }, "required": [ "PCID", "groupId", "courseId", "name" ] } ``` *** ## blackboard\_groups\_post\_learn\_api\_public\_courses\_by\_courseid\_messages Create Message **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `attachment` | object | No | — | The attachment value | | `bccUsers` | string\[] | No | — | The bcc participants of the message | | `body` | string | No | — | The body text of the message. This field supports BbML; see \ for more information. | | `ccUsers` | string\[] | No | — | The cc participants of the message | | `id` | string | No | — | The ID of the message | | `isExistingAttachment` | boolean | No | — | Whether or not the attachment is the existing attachment for the message | | `isRead` | boolean | No | — | Whether or not the message has been read | | `isReply` | boolean | No | — | Whether or not this message is a reply to another message | | `subject` | string | No | — | The subject of the message. | | `toUsers` | string\[] | No | — | The to participants of the message | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "attachment": { "type": "object", "description": "The attachment value", "properties": { "id": { "type": "string", "description": "The ID of file attachment" }, "fileName": { "type": "string", "description": "The fileName of the attachment" }, "mimeType": { "type": "string", "description": "The mime type of the attachment" }, "fileLocation": { "type": "string", "description": "The location of the uploaded file" } } }, "bccUsers": { "type": "array", "items": { "type": "string" }, "description": "The bcc participants of the message" }, "body": { "type": "string", "description": "The body text of the message. This field supports BbML; see here for more information." }, "ccUsers": { "type": "array", "items": { "type": "string" }, "description": "The cc participants of the message" }, "id": { "type": "string", "description": "The ID of the message" }, "isExistingAttachment": { "type": "boolean", "description": "Whether or not the attachment is the existing attachment for the message" }, "isRead": { "type": "boolean", "description": "Whether or not the message has been read" }, "isReply": { "type": "boolean", "description": "Whether or not this message is a reply to another message" }, "subject": { "type": "string", "description": "The subject of the message." }, "toUsers": { "type": "array", "items": { "type": "string" }, "description": "The to participants of the message" } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_groups\_put\_learn\_api\_public\_courses\_by\_courseid\_groups\_by\_groupid\_users\_by\_userid Create Group Membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `groupId` | string | Yes | — | The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "groupId": { "type": "string", "description": "The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "groupId", "userId" ] } ``` *** ## blackboard\_groups\_put\_learn\_api\_public\_courses\_by\_courseid\_users\_by\_userid Create Membership **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | The availability value | | `childCourseId` | string | No | — | The primary ID of the child, cross-listed course, in which the user is directly enrolled. \

This field is read only in Learn versions 3000.11.0 through 3400.0.0. As of 3400.1.0, this field is mutable. \

If this membership's course is a parent course in a cross-listed set, the childCourseId can be updated to move the membership enrollment between child courses and the parent course in the set. Patching the childCourseId to "null" will move the membership to the parent course. **Since**: 3000.11.0 | | `courseRoleId` | string | No | — | The user's role in the course. These roles are also valid for an organization, although they are named differently in the UI. Custom course roles may also be referenced by their IDs. \| Type \| Description \| --------- \| --------- \| \| Instructor \| Has access to all areas in the Control Panel. This role is generally given to those developing, teaching, or facilitating the class. Instructors may access a course that is unavailable to students. This role is customizable and may have different capabilities from what is documented here. \| \| BbFacilitator \| The facilitator is an instructor like role. Facilitators are restricted versions of an instructor, in that they are able to deliver course instruction and administer all aspects of a pre-constructed course, but are not allowed to modify or alter the course. This role is customizable and may have different capabilities from what is documented here. \| \| TeachingAssistant \| The teaching assistant role is that of a co-teacher. Teaching assistants are able to administer all areas of a course. Their only limitations are those imposed by the instructor or Blackboard administrator at your school. This role is customizable and may have different capabilities from what is documented here. \| \| CourseBuilder \| Manages the course without having access to student grades. This role is customizable and may have different capabilities from what is documented here. \| \| Grader \| Assists the instructor in the creation, management, delivery, and grading of items. This role is customizable and may have different capabilities from what is documented here. \| \| Student \| \| \| Guest \| Has no access to the Control Panel. Areas within the course are made available to guests, but typically they can only view course materials; they do not have access to tests or assessments, and do not have permission to post on discussion boards. This role's behavior is immutable. \| | | `dataSourceId` | string | No | — | The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax "externalId:math101". | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "The availability value", "properties": { "available": { "type": "string", "description": "null | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |", "enum": [ "Yes", "No", "Disabled" ] } } }, "childCourseId": { "type": "string", "description": "The primary ID of the child, cross-listed course, in which the user is directly enrolled.

This field is read only in Learn versions 3000.11.0 through 3400.0.0. As of 3400.1.0, this field is mutable.

If this membership's course is a parent course in a cross-listed set, the childCourseId can be updated to move the membership enrollment between child courses and the parent course in the set. Patching the childCourseId to \"null\" will move the membership to the parent course. **Since**: 3000.11.0" }, "courseRoleId": { "type": "string", "description": "The user's role in the course. These roles are also valid for an organization, although they are named differently in the UI. Custom course roles may also be referenced by their IDs. | Type | Description | --------- | --------- | | Instructor | Has access to all areas in the Control Panel. This role is generally given to those developing, teaching, or facilitating the class. Instructors may access a course that is unavailable to students. This role is customizable and may have different capabilities from what is documented here. | | BbFacilitator | The facilitator is an instructor like role. Facilitators are restricted versions of an instructor, in that they are able to deliver course instruction and administer all aspects of a pre-constructed course, but are not allowed to modify or alter the course. This role is customizable and may have different capabilities from what is documented here. | | TeachingAssistant | The teaching assistant role is that of a co-teacher. Teaching assistants are able to administer all areas of a course. Their only limitations are those imposed by the instructor or Blackboard administrator at your school. This role is customizable and may have different capabilities from what is documented here. | | CourseBuilder | Manages the course without having access to student grades. This role is customizable and may have different capabilities from what is documented here. | | Grader | Assists the instructor in the creation, management, delivery, and grading of items. This role is customizable and may have different capabilities from what is documented here. | | Student | | | Guest | Has no access to the Control Panel. Areas within the course are made available to guests, but typically they can only view course materials; they do not have access to tests or assessments, and do not have permission to post on discussion boards. This role's behavior is immutable. |", "enum": [ "Instructor", "BbFacilitator", "TeachingAssistant", "CourseBuilder", "Grader", "Student", "Guest" ] }, "dataSourceId": { "type": "string", "description": "The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax \"externalId:math101\"." } }, "required": [ "PCID", "courseId", "userId" ] } ``` # blackboard-institutional Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/blackboard/blackboard-institutional Blackboard Institutional - hierarchy, attendance, terms, and SIS logs **Server path:** `/blackboard-institutional` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings) | Delete All Meetings In Course | | [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid) | Delete Course Meeting | | [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid_users`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid_users) | Delete All Records In Meeting | | [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid) | Delete Attendance Record | | [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_users_by_userid`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_users_by_userid) | Delete All Attendance Records By Course And User Id | | [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_users_by_userid_all`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_users_by_userid_all) | Delete All Attendance By User Id | | [`blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid`](#blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid) | Delete Node | | [`blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid`](#blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid) | Delete Node Course Association | | [`blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users_by_userid`](#blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users_by_userid) | Delete Node User Association | | [`blackboard_institutional_delete_learn_api_public_terms_by_termid`](#blackboard_institutional_delete_learn_api_public_terms_by_termid) | Delete Term | | [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings) | Get Course Meetings | | [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid) | Get Course Meeting | | [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid_users`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid_users) | Get Attendance Records By Meeting Id | | [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid) | Get Attendance Record | | [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_downloadurl`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_downloadurl) | Generate Attendance Data Download Url | | [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_users_by_userid`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_users_by_userid) | Get Attendance Records By User Id | | [`blackboard_institutional_get_learn_api_public_courses_by_courseid_nodes`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_nodes) | Get Nodes For Course | | [`blackboard_institutional_get_learn_api_public_courses_by_courseid_performance_contentreviewstatus`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_performance_contentreviewstatus) | Get Review Status By Course Id | | [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes) | Get Nodes | | [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid) | Get Node | | [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_children`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_children) | Get Node Children | | [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses) | Get Node Course Associations | | [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_tools_by_tooltype`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_tools_by_tooltype) | Get Tools | | [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users) | Get Node User Associations | | [`blackboard_institutional_get_learn_api_public_logs_sis_datasets_by_id`](#blackboard_institutional_get_learn_api_public_logs_sis_datasets_by_id) | Get SIS Logs By Data Set Uid | | [`blackboard_institutional_get_learn_api_public_terms`](#blackboard_institutional_get_learn_api_public_terms) | Get Terms | | [`blackboard_institutional_get_learn_api_public_terms_by_termid`](#blackboard_institutional_get_learn_api_public_terms_by_termid) | Get Term | | [`blackboard_institutional_get_learn_api_public_users_by_userid_nodes`](#blackboard_institutional_get_learn_api_public_users_by_userid_nodes) | Get Nodes For User | | [`blackboard_institutional_patch_learn_api_public_courses_by_courseid_meetings_by_meetingid`](#blackboard_institutional_patch_learn_api_public_courses_by_courseid_meetings_by_meetingid) | Update Course Meeting | | [`blackboard_institutional_patch_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid`](#blackboard_institutional_patch_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid) | Update Attendance Record | | [`blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid`](#blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid) | Update Node | | [`blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid`](#blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid) | Update Node Course Association | | [`blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid_tools_by_tooltype_by_toolid`](#blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid_tools_by_tooltype_by_toolid) | Patch Tool | | [`blackboard_institutional_patch_learn_api_public_terms_by_termid`](#blackboard_institutional_patch_learn_api_public_terms_by_termid) | Update Term | | [`blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings`](#blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings) | Create Course Meeting | | [`blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings_by_meetingid_users`](#blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings_by_meetingid_users) | Create Attendance Record | | [`blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_bulk`](#blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_bulk) | Update Attendance Records | | [`blackboard_institutional_post_learn_api_public_institutionalhierarchy_nodes`](#blackboard_institutional_post_learn_api_public_institutionalhierarchy_nodes) | Create Node | | [`blackboard_institutional_post_learn_api_public_institutionalhierarchy_nodes_by_nodeid_children`](#blackboard_institutional_post_learn_api_public_institutionalhierarchy_nodes_by_nodeid_children) | Create Child Node | | [`blackboard_institutional_post_learn_api_public_terms`](#blackboard_institutional_post_learn_api_public_terms) | Create Term | | [`blackboard_institutional_put_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid`](#blackboard_institutional_put_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid) | Create Node Course Association | | [`blackboard_institutional_put_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users_by_userid`](#blackboard_institutional_put_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users_by_userid) | Create Node Course Association | *** ## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings Delete All Meetings In Course **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid Delete Course Meeting **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `meetingId` | string | Yes | — | Meeting Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "meetingId": { "type": "string", "description": "Meeting Id" } }, "required": [ "PCID", "courseId", "meetingId" ] } ``` *** ## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users Delete All Records In Meeting **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `meetingId` | string | Yes | — | Meeting Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "meetingId": { "type": "string", "description": "Meeting Id" } }, "required": [ "PCID", "courseId", "meetingId" ] } ``` *** ## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users\_by\_userid Delete Attendance Record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `meetingId` | string | Yes | — | Meeting Id | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "meetingId": { "type": "string", "description": "Meeting Id" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "courseId", "meetingId", "userId" ] } ``` *** ## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings\_users\_by\_userid Delete All Attendance Records By Course And User Id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "courseId", "userId" ] } ``` *** ## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings\_users\_by\_userid\_all Delete All Attendance By User Id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "courseId", "userId" ] } ``` *** ## blackboard\_institutional\_delete\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid Delete Node **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" } }, "required": [ "PCID", "nodeId" ] } ``` *** ## blackboard\_institutional\_delete\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_courses\_by\_courseid Delete Node Course Association **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "nodeId", "courseId" ] } ``` *** ## blackboard\_institutional\_delete\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_users\_by\_userid Delete Node User Association **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "nodeId", "userId" ] } ``` *** ## blackboard\_institutional\_delete\_learn\_api\_public\_terms\_by\_termid Delete Term **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `termId` | string | Yes | — | The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. \| ID type \| Example \| \|------------\|------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:spring.2016 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "termId": { "type": "string", "description": "The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. | ID type | Example | |------------|------------------------| | primary | _123_1 | | externalId | externalId:spring.2016 |" } }, "required": [ "PCID", "termId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings Get Course Meetings **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Sort order for results | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Sort order for results" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid Get Course Meeting **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `meetingId` | string | Yes | — | Meeting Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "meetingId": { "type": "string", "description": "Meeting Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "meetingId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users Get Attendance Records By Meeting Id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `sort` | string | No | — | Sort order for results | | `meetingId` | string | Yes | — | Meeting Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "sort": { "type": "string", "description": "Sort order for results" }, "meetingId": { "type": "string", "description": "Meeting Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "meetingId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users\_by\_userid Get Attendance Record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `meetingId` | string | Yes | — | Meeting Id | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "meetingId": { "type": "string", "description": "Meeting Id" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "meetingId", "userId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings\_downloadurl Generate Attendance Data Download Url **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings\_users\_by\_userid Get Attendance Records By User Id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `sort` | string | No | — | Sort order for results | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "sort": { "type": "string", "description": "Sort order for results" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "userId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_nodes Get Nodes For Course **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • node\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • node
" } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_performance\_contentreviewstatus Get Review Status By Course Id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `userId` | string | No | — | Optional search criteria to filter by user id. **Since**: 3700.15.0 | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "userId": { "type": "string", "description": "Optional search criteria to filter by user id. **Since**: 3700.15.0" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes Get Nodes **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `recursive` | boolean | No | — | Search Institutional Hierarchy Nodes recursively. If true, returns all descendant nodes of the specified Node. If false, only immediate children are returned (defualt: false) **Since**: 3800.14.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "recursive": { "type": "boolean", "description": "Search Institutional Hierarchy Nodes recursively. If true, returns all descendant nodes of the specified Node. If false, only immediate children are returned (defualt: false) **Since**: 3800.14.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid Get Node **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "nodeId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_children Get Node Children **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `recursive` | boolean | No | — | Search Institutional Hierarchy Nodes recursively. If true, returns all descendant nodes of the specified Node. If false, only immediate children are returned (defualt: false) **Since**: 3800.14.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "recursive": { "type": "boolean", "description": "Search Institutional Hierarchy Nodes recursively. If true, returns all descendant nodes of the specified Node. If false, only immediate children are returned (defualt: false) **Since**: 3800.14.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "nodeId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_courses Get Node Course Associations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `course.organization` | boolean | No | — | Filters Hierarchy Node associations based on whether it is a Node-Course or a Node-Organization association. A value of 'true' indicates that search results should be limited to Node-Organization associations. A value of 'false' indicates results should be limited to Node-Course associations. Not setting this field indicates that both Node-Course and Node-Organization associations should be returned. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • course\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "course.organization": { "type": "boolean", "description": "Filters Hierarchy Node associations based on whether it is a Node-Course or a Node-Organization association. A value of 'true' indicates that search results should be limited to Node-Organization associations. A value of 'false' indicates results should be limited to Node-Course associations. Not setting this field indicates that both Node-Course and Node-Organization associations should be returned." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • course
" } }, "required": [ "PCID", "nodeId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_tools\_by\_tooltype Get Tools **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `toolType` | string | Yes | — | Tool Type | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "toolType": { "type": "string", "description": "Tool Type", "enum": [ "Course", "Organization", "Content" ] }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "nodeId", "toolType" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_users Get Node User Associations **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • user\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • user
" } }, "required": [ "PCID", "nodeId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_logs\_sis\_datasets\_by\_id Get SIS Logs By Data Set Uid **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | : dataSetUid of the integration | | `level` | string | No | — | : Logs can be filtered with level. Default level is Error. Logs will be pulled of that level and above i.e. for level = Warning result set will have warning and error level log messages | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": ": dataSetUid of the integration" }, "level": { "type": "string", "description": ": Logs can be filtered with level. Default level is Error. Logs will be pulled of that level and above i.e. for level = Warning result set will have warning and error level log messages", "enum": [ "Debug", "Information", "Warning", "Error" ] }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "id" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_terms Get Terms **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `externalId` | string | No | — | Search for term with externalId properties that contain this value. **Since**: 3100.6.0 | | `dataSourceId` | string | No | — | Search for term with this dataSourceId. **Since**: 3100.6.0 | | `availability.available` | string | No | — | Search for users with availability.available properties that contain this value. **Since**: 3100.6.0 \| Type \| Description \| --------- \| --------- \| \| Yes \| Students may access the term and the courses it contains. \| \| No \| Students may not access the term or the courses it contains. \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "externalId": { "type": "string", "description": "Search for term with externalId properties that contain this value. **Since**: 3100.6.0" }, "dataSourceId": { "type": "string", "description": "Search for term with this dataSourceId. **Since**: 3100.6.0" }, "availability.available": { "type": "string", "description": "Search for users with availability.available properties that contain this value. **Since**: 3100.6.0 | Type | Description | --------- | --------- | | Yes | Students may access the term and the courses it contains. | | No | Students may not access the term or the courses it contains. |", "enum": [ "Yes", "No" ] }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_terms\_by\_termid Get Term **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `termId` | string | Yes | — | The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. \| ID type \| Example \| \|------------\|------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:spring.2016 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "termId": { "type": "string", "description": "The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. | ID type | Example | |------------|------------------------| | primary | _123_1 | | externalId | externalId:spring.2016 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "termId" ] } ``` *** ## blackboard\_institutional\_get\_learn\_api\_public\_users\_by\_userid\_nodes Get Nodes For User **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • node\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • node
" } }, "required": [ "PCID", "userId" ] } ``` *** ## blackboard\_institutional\_patch\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid Update Course Meeting **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `meetingId` | string | Yes | — | Meeting Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `description` | string | No | — | The description of the meeting | | `end` | string | No | — | The end time of meeting | | `externalLink` | string | No | — | The externalLink of course meeting | | `start` | string | No | — | The start time of meeting | | `title` | string | No | — | The title of the meeting | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "meetingId": { "type": "string", "description": "Meeting Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "description": { "type": "string", "description": "The description of the meeting" }, "end": { "type": "string", "description": "The end time of meeting" }, "externalLink": { "type": "string", "description": "The externalLink of course meeting" }, "start": { "type": "string", "description": "The start time of meeting" }, "title": { "type": "string", "description": "The title of the meeting" } }, "required": [ "PCID", "courseId", "meetingId" ] } ``` *** ## blackboard\_institutional\_patch\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users\_by\_userid Update Attendance Record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `meetingId` | string | Yes | — | Meeting Id | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `status` | string | No | — | The attendance status of the user. \| Type \| Description \| --------- \| --------- \| \| Absent \| \| \| Late \| \| \| Present \| \| \| Excused \| \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "meetingId": { "type": "string", "description": "Meeting Id" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "status": { "type": "string", "description": "The attendance status of the user. | Type | Description | --------- | --------- | | Absent | | | Late | | | Present | | | Excused | |", "enum": [ "Absent", "Late", "Present", "Excused" ] } }, "required": [ "PCID", "courseId", "meetingId", "userId" ] } ``` *** ## blackboard\_institutional\_patch\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid Update Node **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `description` | string | No | — | Node description | | `externalId` | string | No | — | Node unique identifier | | `title` | string | No | — | Node display name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "description": { "type": "string", "description": "Node description" }, "externalId": { "type": "string", "description": "Node unique identifier" }, "title": { "type": "string", "description": "Node display name" } }, "required": [ "PCID", "nodeId" ] } ``` *** ## blackboard\_institutional\_patch\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_courses\_by\_courseid Update Node Course Association **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `isPrimary` | boolean | No | — | Whether or not this association represents the primary node association of the course | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "isPrimary": { "type": "boolean", "description": "Whether or not this association represents the primary node association of the course" } }, "required": [ "PCID", "nodeId", "courseId" ] } ``` *** ## blackboard\_institutional\_patch\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_tools\_by\_tooltype\_by\_toolid Patch Tool **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `toolType` | string | Yes | — | Tool Type | | `toolId` | string | Yes | — | Tool Id | | `updateExistingOriginalCourses` | boolean | No | — | Scope of updated Tool Settings. By default if the parameter is not present or is set as false, the updated settings will be applied to new Original courses and all Ultra courses (new and existing). If present and value is true, the updated settings will be applied to all new and existing courses (Original and Ultra). **Since**: 3900.16.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `guestSettings` | object | No | — | Guest Settings | | `observerSettings` | object | No | — | Observer Settings | | `toolSettings` | object | No | — | Tool Settings | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "toolType": { "type": "string", "description": "Tool Type", "enum": [ "Course", "Organization", "Content" ] }, "toolId": { "type": "string", "description": "Tool Id" }, "updateExistingOriginalCourses": { "type": "boolean", "description": "Scope of updated Tool Settings. By default if the parameter is not present or is set as false, the updated settings will be applied to new Original courses and all Ultra courses (new and existing). If present and value is true, the updated settings will be applied to all new and existing courses (Original and Ultra). **Since**: 3900.16.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "guestSettings": { "type": "object", "description": "Guest Settings", "properties": { "available": { "type": "boolean", "description": "Whether the tool is available." }, "locked": { "type": "boolean", "description": "Whether the tool is locked." }, "applicable": { "type": "boolean", "description": "Whether the available and locked settings are applicable." } } }, "observerSettings": { "type": "object", "description": "Observer Settings", "properties": { "available": { "type": "boolean", "description": "Whether the tool is available." }, "locked": { "type": "boolean", "description": "Whether the tool is locked." }, "applicable": { "type": "boolean", "description": "Whether the available and locked settings are applicable." } } }, "toolSettings": { "type": "object", "description": "Tool Settings", "properties": { "available": { "type": "boolean", "description": "Whether the tool is available." }, "locked": { "type": "boolean", "description": "Whether the tool is locked." }, "applicable": { "type": "boolean", "description": "Whether the available and locked settings are applicable." } } } }, "required": [ "PCID", "nodeId", "toolType", "toolId" ] } ``` *** ## blackboard\_institutional\_patch\_learn\_api\_public\_terms\_by\_termid Update Term **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `termId` | string | Yes | — | The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. \| ID type \| Example \| \|------------\|------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:spring.2016 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the term to students. | | `dataSourceId` | string | No | — | The ID of the data source associated with this term. This may optionally be the data source's externalId using the syntax "externalId:math101". | | `description` | string | No | — | The description of the term. This field supports BbML; see \ for more information. | | `externalId` | string | No | — | An externally-defined unique ID for the term. Formerly known as 'sourcedidId'. | | `name` | string | No | — | The name of the term. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "termId": { "type": "string", "description": "The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. | ID type | Example | |------------|------------------------| | primary | _123_1 | | externalId | externalId:spring.2016 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the term to students.", "properties": { "available": { "type": "string", "description": "Whether the term and the courses it contains are available to students. Instructors can always access their courses. | Type | Description | --------- | --------- | | Yes | Students may access the term and the courses it contains. | | No | Students may not access the term or the courses it contains. |", "enum": [ "Yes", "No" ] }, "duration": { "type": "object", "description": "Settings controlling the length of time the term is available." } } }, "dataSourceId": { "type": "string", "description": "The ID of the data source associated with this term. This may optionally be the data source's externalId using the syntax \"externalId:math101\"." }, "description": { "type": "string", "description": "The description of the term. This field supports BbML; see here for more information." }, "externalId": { "type": "string", "description": "An externally-defined unique ID for the term. Formerly known as 'sourcedidId'." }, "name": { "type": "string", "description": "The name of the term." } }, "required": [ "PCID", "termId" ] } ``` *** ## blackboard\_institutional\_post\_learn\_api\_public\_courses\_by\_courseid\_meetings Create Course Meeting **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `description` | string | Yes | — | The description of the meeting | | `end` | string | Yes | — | The end time of meeting | | `externalLink` | string | No | — | The externalLink of course meeting | | `start` | string | Yes | — | The start time of meeting | | `title` | string | Yes | — | The title of the meeting | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "description": { "type": "string", "description": "The description of the meeting" }, "end": { "type": "string", "description": "The end time of meeting" }, "externalLink": { "type": "string", "description": "The externalLink of course meeting" }, "start": { "type": "string", "description": "The start time of meeting" }, "title": { "type": "string", "description": "The title of the meeting" } }, "required": [ "PCID", "courseId", "description", "end", "start", "title" ] } ``` *** ## blackboard\_institutional\_post\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users Create Attendance Record **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `meetingId` | string | Yes | — | Meeting Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `status` | string | Yes | — | The attendance status of the user. \| Type \| Description \| --------- \| --------- \| \| Absent \| \| \| Late \| \| \| Present \| \| \| Excused \| \| | | `userId` | string | Yes | — | The learn external id of the user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "meetingId": { "type": "string", "description": "Meeting Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "status": { "type": "string", "description": "The attendance status of the user. | Type | Description | --------- | --------- | | Absent | | | Late | | | Present | | | Excused | |", "enum": [ "Absent", "Late", "Present", "Excused" ] }, "userId": { "type": "string", "description": "The learn external id of the user." } }, "required": [ "PCID", "courseId", "meetingId", "status", "userId" ] } ``` *** ## blackboard\_institutional\_post\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users\_bulk Update Attendance Records **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `meetingId` | string | Yes | — | Meeting Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `status` | string | Yes | — | The attendance status of the user. \| Type \| Description \| --------- \| --------- \| \| Absent \| \| \| Late \| \| \| Present \| \| \| Excused \| \| | | `userId` | string | Yes | — | The learn external id of the user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "meetingId": { "type": "string", "description": "Meeting Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "status": { "type": "string", "description": "The attendance status of the user. | Type | Description | --------- | --------- | | Absent | | | Late | | | Present | | | Excused | |", "enum": [ "Absent", "Late", "Present", "Excused" ] }, "userId": { "type": "string", "description": "The learn external id of the user." } }, "required": [ "PCID", "courseId", "meetingId", "status", "userId" ] } ``` *** ## blackboard\_institutional\_post\_learn\_api\_public\_institutionalhierarchy\_nodes Create Node **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `description` | string | No | — | Node description | | `externalId` | string | No | — | Node unique identifier | | `title` | string | Yes | — | Node display name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "description": { "type": "string", "description": "Node description" }, "externalId": { "type": "string", "description": "Node unique identifier" }, "title": { "type": "string", "description": "Node display name" } }, "required": [ "PCID", "title" ] } ``` *** ## blackboard\_institutional\_post\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_children Create Child Node **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `description` | string | No | — | Node description | | `externalId` | string | No | — | Node unique identifier | | `title` | string | Yes | — | Node display name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "description": { "type": "string", "description": "Node description" }, "externalId": { "type": "string", "description": "Node unique identifier" }, "title": { "type": "string", "description": "Node display name" } }, "required": [ "PCID", "nodeId", "title" ] } ``` *** ## blackboard\_institutional\_post\_learn\_api\_public\_terms Create Term **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `availability` | object | No | — | Settings controlling availability of the term to students. | | `dataSourceId` | string | No | — | The ID of the data source associated with this term. This may optionally be the data source's externalId using the syntax "externalId:math101". | | `description` | string | No | — | The description of the term. This field supports BbML; see \ for more information. | | `externalId` | string | Yes | — | An externally-defined unique ID for the term. Formerly known as 'sourcedidId'. | | `name` | string | Yes | — | The name of the term. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "availability": { "type": "object", "description": "Settings controlling availability of the term to students.", "properties": { "available": { "type": "string", "description": "Whether the term and the courses it contains are available to students. Instructors can always access their courses. | Type | Description | --------- | --------- | | Yes | Students may access the term and the courses it contains. | | No | Students may not access the term or the courses it contains. |", "enum": [ "Yes", "No" ] }, "duration": { "type": "object", "description": "Settings controlling the length of time the term is available." } } }, "dataSourceId": { "type": "string", "description": "The ID of the data source associated with this term. This may optionally be the data source's externalId using the syntax \"externalId:math101\"." }, "description": { "type": "string", "description": "The description of the term. This field supports BbML; see here for more information." }, "externalId": { "type": "string", "description": "An externally-defined unique ID for the term. Formerly known as 'sourcedidId'." }, "name": { "type": "string", "description": "The name of the term." } }, "required": [ "PCID", "externalId", "name" ] } ``` *** ## blackboard\_institutional\_put\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_courses\_by\_courseid Create Node Course Association **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `isPrimary` | boolean | No | — | Whether or not this association represents the primary node association of the course | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "isPrimary": { "type": "boolean", "description": "Whether or not this association represents the primary node association of the course" } }, "required": [ "PCID", "nodeId", "courseId" ] } ``` *** ## blackboard\_institutional\_put\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_users\_by\_userid Create Node Course Association **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `nodeId` | string | Yes | — | The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:breakfastClub \| | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nodeId": { "type": "string", "description": "The node ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:breakfastClub |" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "nodeId", "userId" ] } ``` # blackboard-system Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/blackboard/blackboard-system Blackboard System - LTI, proctoring, uploads, system info, and assessments **Server path:** `/blackboard-system` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`blackboard_system_delete_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid`](#blackboard_system_delete_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid) | Delete Question | | [`blackboard_system_delete_learn_api_public_lti_domains_by_domainid`](#blackboard_system_delete_learn_api_public_lti_domains_by_domainid) | Delete Domain Config | | [`blackboard_system_delete_learn_api_public_lti_placements_by_placementid`](#blackboard_system_delete_learn_api_public_lti_placements_by_placementid) | Delete Placement | | [`blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions`](#blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions) | Get Questions | | [`blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid`](#blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid) | Get Question By Id | | [`blackboard_system_get_learn_api_public_lti_domains`](#blackboard_system_get_learn_api_public_lti_domains) | Get Domain Configs | | [`blackboard_system_get_learn_api_public_lti_domains_by_domainid`](#blackboard_system_get_learn_api_public_lti_domains_by_domainid) | Get Domain Config | | [`blackboard_system_get_learn_api_public_lti_placements`](#blackboard_system_get_learn_api_public_lti_placements) | Get Placements | | [`blackboard_system_get_learn_api_public_lti_placements_by_placementid`](#blackboard_system_get_learn_api_public_lti_placements_by_placementid) | Get Placement | | [`blackboard_system_get_learn_api_public_proctoring_services`](#blackboard_system_get_learn_api_public_proctoring_services) | Get Proctoring Services | | [`blackboard_system_get_learn_api_public_proctoring_services_by_proctoringserviceid`](#blackboard_system_get_learn_api_public_proctoring_services_by_proctoringserviceid) | Get Proctoring Service | | [`blackboard_system_get_learn_api_public_system_policies_privacy`](#blackboard_system_get_learn_api_public_system_policies_privacy) | Get Policies | | [`blackboard_system_get_learn_api_public_system_tasks_by_taskid`](#blackboard_system_get_learn_api_public_system_tasks_by_taskid) | Get System Task | | [`blackboard_system_get_learn_api_public_system_version`](#blackboard_system_get_learn_api_public_system_version) | Get Version | | [`blackboard_system_patch_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid`](#blackboard_system_patch_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid) | Update Question | | [`blackboard_system_patch_learn_api_public_lti_domains_by_domainid`](#blackboard_system_patch_learn_api_public_lti_domains_by_domainid) | Update Domain Config | | [`blackboard_system_patch_learn_api_public_lti_placements_by_placementid`](#blackboard_system_patch_learn_api_public_lti_placements_by_placementid) | Update Placement | | [`blackboard_system_post_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions`](#blackboard_system_post_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions) | Create Question | | [`blackboard_system_post_learn_api_public_lti_domains`](#blackboard_system_post_learn_api_public_lti_domains) | Create Domain Config | | [`blackboard_system_post_learn_api_public_lti_placements`](#blackboard_system_post_learn_api_public_lti_placements) | Create Placement | | [`blackboard_system_post_learn_api_public_uploads`](#blackboard_system_post_learn_api_public_uploads) | Upload | *** ## blackboard\_system\_delete\_learn\_api\_public\_courses\_by\_courseid\_assessments\_by\_assessmentid\_questions\_by\_questionid Delete Question **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `assessmentId` | string | Yes | — | Assessment Id | | `questionId` | string | Yes | — | Question Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "assessmentId": { "type": "string", "description": "Assessment Id" }, "questionId": { "type": "string", "description": "Question Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "assessmentId", "questionId" ] } ``` *** ## blackboard\_system\_delete\_learn\_api\_public\_lti\_domains\_by\_domainid Delete Domain Config **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `domainId` | string | Yes | — | Domain Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "domainId": { "type": "string", "description": "Domain Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "domainId" ] } ``` *** ## blackboard\_system\_delete\_learn\_api\_public\_lti\_placements\_by\_placementid Delete Placement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `placementId` | string | Yes | — | Placement Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "placementId": { "type": "string", "description": "Placement Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "placementId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_courses\_by\_courseid\_assessments\_by\_assessmentid\_questions Get Questions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `assessmentId` | string | Yes | — | Assessment Id | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "assessmentId": { "type": "string", "description": "Assessment Id" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "assessmentId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_courses\_by\_courseid\_assessments\_by\_assessmentid\_questions\_by\_questionid Get Question By Id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `assessmentId` | string | Yes | — | Assessment Id | | `questionId` | string | Yes | — | Question Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "assessmentId": { "type": "string", "description": "Assessment Id" }, "questionId": { "type": "string", "description": "Question Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "assessmentId", "questionId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_lti\_domains Get Domain Configs **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_lti\_domains\_by\_domainid Get Domain Config **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `domainId` | string | Yes | — | Domain Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "domainId": { "type": "string", "description": "Domain Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "domainId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_lti\_placements Get Placements **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `handle` | string | No | — | Search for placements with handle properties that contain this value. **Since**: 3200.12.0 | | `name` | string | No | — | Search for placements with name properties that contain this value. **Since**: 3200.12.0 | | `type` | string | No | — | Search for placements with type properties that contain this value. **Since**: 3200.12.0 \| Type \| Description \| --------- \| --------- \| \| Application \| Application or Student Tool Placement \| \| ContentHandler \| Content Type placement \| \| ContentItemMessage \| Content-item Message placement (see IMSGlobal spec) **Since**: 3300.5.0 \| \| System \| System-level Tools \| \| Administrator \| Administrator-level Tools **Since**: 3400.1.0 \| \| UltraUI \| Ultra-UI Extensions **Since**: 3700.6.0 \| \| BaseNavigation \| Base Navigation \| \| CourseNavigation \| Course Navigation \| \| Proctoring \| Proctoring **Since**: 3900.10.0 \| | | `authorId` | string | No | — | Search for placements with author ID properties that contain this value. **Since**: 3200.12.0 **Deprecated**: since 3900.0.0; Field was never used and has been removed | | `courseId` | string | No | — | Search for LTI placements that are available for this course. Note this only applies to Application, ContentHandler, and ContentItemMessage types currently **Since**: 3900.0.0 | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "name.family(desc),created" **Since**: 3100.0.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "handle": { "type": "string", "description": "Search for placements with handle properties that contain this value. **Since**: 3200.12.0" }, "name": { "type": "string", "description": "Search for placements with name properties that contain this value. **Since**: 3200.12.0" }, "type": { "type": "string", "description": "Search for placements with type properties that contain this value. **Since**: 3200.12.0 | Type | Description | --------- | --------- | | Application | Application or Student Tool Placement | | ContentHandler | Content Type placement | | ContentItemMessage | Content-item Message placement (see IMSGlobal spec) **Since**: 3300.5.0 | | System | System-level Tools | | Administrator | Administrator-level Tools **Since**: 3400.1.0 | | UltraUI | Ultra-UI Extensions **Since**: 3700.6.0 | | BaseNavigation | Base Navigation | | CourseNavigation | Course Navigation | | Proctoring | Proctoring **Since**: 3900.10.0 |", "enum": [ "Application", "ContentHandler", "ContentItemMessage", "System", "Administrator", "UltraUI", "BaseNavigation", "CourseNavigation", "Proctoring" ] }, "authorId": { "type": "string", "description": "Search for placements with author ID properties that contain this value. **Since**: 3200.12.0 **Deprecated**: since 3900.0.0; Field was never used and has been removed" }, "courseId": { "type": "string", "description": "Search for LTI placements that are available for this course. Note this only applies to Application, ContentHandler, and ContentItemMessage types currently **Since**: 3900.0.0" }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"name.family(desc),created\" **Since**: 3100.0.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_lti\_placements\_by\_placementid Get Placement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `placementId` | string | Yes | — | Placement Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "placementId": { "type": "string", "description": "Placement Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "placementId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_proctoring\_services Get Proctoring Services **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `availability.available` | string | No | — | Search for proctoring services with availability.available properties that contain this value. \| Type \| Description \| --------- \| --------- \| \| Yes \| \| \| No \| \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "availability.available": { "type": "string", "description": "Search for proctoring services with availability.available properties that contain this value. | Type | Description | --------- | --------- | | Yes | | | No | |", "enum": [ "Yes", "No" ] }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_proctoring\_services\_by\_proctoringserviceid Get Proctoring Service **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `proctoringServiceId` | string | Yes | — | Proctoring Service Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proctoringServiceId": { "type": "string", "description": "Proctoring Service Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "proctoringServiceId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_system\_policies\_privacy Get Policies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `locale` | string | No | — | the locale, otherwise it defaults to en\_US | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "locale": { "type": "string", "description": "the locale, otherwise it defaults to en_US" } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_system\_tasks\_by\_taskid Get System Task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `taskId` | string | Yes | — | Task Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "taskId": { "type": "string", "description": "Task Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "taskId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_system\_version Get Version ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_patch\_learn\_api\_public\_courses\_by\_courseid\_assessments\_by\_assessmentid\_questions\_by\_questionid Update Question **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `assessmentId` | string | Yes | — | Assessment Id | | `questionId` | string | Yes | — | Question Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `correctResponseFeedback` | string | No | — | Feedback displayed to students when their submitted response is correct. | | `incorrectResponseFeedback` | string | No | — | Feedback displayed to students when their submitted response is incorrect. | | `instructorNotes` | string | No | — | Text added to the question as a note for the instructor. It is not intended to be displayed to students. | | `points` | number | No | — | The point value for the question. | | `position` | integer | No | — | Position of the Question on the Assessment Canvas. | | `questionHandler` | object | No | — | Question Handler | | `text` | string | No | — | The main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor. | | `title` | string | No | — | The title of the question. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "assessmentId": { "type": "string", "description": "Assessment Id" }, "questionId": { "type": "string", "description": "Question Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "correctResponseFeedback": { "type": "string", "description": "Feedback displayed to students when their submitted response is correct." }, "incorrectResponseFeedback": { "type": "string", "description": "Feedback displayed to students when their submitted response is incorrect." }, "instructorNotes": { "type": "string", "description": "Text added to the question as a note for the instructor. It is not intended to be displayed to students." }, "points": { "type": "number", "description": "The point value for the question." }, "position": { "type": "integer", "description": "Position of the Question on the Assessment Canvas." }, "questionHandler": { "type": "object", "description": "Question Handler", "properties": { "type": { "type": "string", "description": "Type of Question supported. | Type | Description | --------- | --------- | | Presentation | **Since**: 3300.9.0 | | EitherOr | Read Only **Since**: 3300.9.0 | | Essay | Read Only **Since**: 3300.9.0 | | MultipleAnswer | Read Only **Since**: 3400.4.0 | | Numeric | Read Only **Since**: 3400.4.0 | | MultipleChoice | Read Only **Since**: 3400.4.0 | | Ordering | Read Only **Since**: 3400.4.0 | | Matching | Read Only **Since**: 3400.4.0 | | FillInTheBlank | Read Only **Since**: 3400.4.0 | | Calculated | Read Only **Since**: 3400.4.0 | | FileResponse | Read Only **Since**: 3400.4.0 | | LikertOpinionScale | Read Only **Since**: 3400.4.0 | | QuizBowl | Read Only **Since**: 3400.4.0 | | HotSpot | Read Only **Since**: 3400.4.0 | | JumbledSentence | Read Only **Since**: 3400.4.0 | | FillInTheBlankPlus | Read Only **Since**: 3400.4.0 | | QuestionBlock | Read Only **Since**: 3700.2.0 |", "enum": [ "Presentation", "EitherOr", "Essay", "MultipleAnswer", "Numeric", "MultipleChoice", "Ordering", "Matching", "FillInTheBlank", "Calculated", "FileResponse", "LikertOpinionScale", "QuizBowl", "HotSpot", "JumbledSentence", "FillInTheBlankPlus", "QuestionBlock" ] } } }, "text": { "type": "string", "description": "The main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor." }, "title": { "type": "string", "description": "The title of the question." } }, "required": [ "PCID", "courseId", "assessmentId", "questionId" ] } ``` *** ## blackboard\_system\_patch\_learn\_api\_public\_lti\_domains\_by\_domainid Update Domain Config **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `domainId` | string | Yes | — | Domain Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `allowGradesService` | boolean | No | — | Whether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. **Since**: 3600.0.0 | | `allowMembershipService` | boolean | No | — | Whether the Tool is allowed to call the LTI Names and Roles service and get the course memberships. | | `clientId` | string | No | — | The client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 **Since**: 3600.0.0 | | `customParameters` | object | No | — | The custom parameters for the given domain. | | `description` | string | No | — | The description of the domain configuration **Since**: 3900.23.0 | | `jwksUrl` | string | No | — | The JWKS URL of the tool, if specified. It is optional and can be null **Since**: 3800.17.0 | | `key` | string | No | — | The key value | | `name` | string | No | — | The name of the domain configuration **Since**: 3900.23.0 | | `primaryDomain` | string | No | — | The primary domain name associated with this configuration. | | `publicKey` | string | No | — | The public key of the tool, if specified. It is optional and can be null **Since**: 3800.17.0 | | `secret` | string | No | — | The secret value | | `sendEmail` | boolean | No | — | Whether the user's email address can be sent to the LTI tool provider. | | `sendName` | boolean | No | — | Whether the user's name can be sent to the LTI tool provider. | | `sendRole` | boolean | No | — | Whether the user's role can be sent to the LTI tool provider. | | `sendUserDataType` | string | No | — | Enum indicating when user data can be sent to the LTI tool provider. \| Type \| Description \| --------- \| --------- \| \| Never \| \| \| Sslonly \| \| \| Always \| **Since**: 3300.9.0 \| | | `status` | string | No | — | Enum that indicates if the set of domains associated with this config can or cannot be linked to. \| Type \| Description \| --------- \| --------- \| \| Approved \| \| \| Excluded \| \| \| NeedsApproval \| **Since**: 3300.9.0 \| | | `useSplashScreen` | boolean | No | — | Whether a splash screen is shown before launching the LTI link. Cannot be set to true if allowMembershipService is true. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "domainId": { "type": "string", "description": "Domain Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "allowGradesService": { "type": "boolean", "description": "Whether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. **Since**: 3600.0.0" }, "allowMembershipService": { "type": "boolean", "description": "Whether the Tool is allowed to call the LTI Names and Roles service and get the course memberships." }, "clientId": { "type": "string", "description": "The client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 **Since**: 3600.0.0" }, "customParameters": { "type": "object", "description": "The custom parameters for the given domain." }, "description": { "type": "string", "description": "The description of the domain configuration **Since**: 3900.23.0" }, "jwksUrl": { "type": "string", "description": "The JWKS URL of the tool, if specified. It is optional and can be null **Since**: 3800.17.0" }, "key": { "type": "string", "description": "The key value" }, "name": { "type": "string", "description": "The name of the domain configuration **Since**: 3900.23.0" }, "primaryDomain": { "type": "string", "description": "The primary domain name associated with this configuration." }, "publicKey": { "type": "string", "description": "The public key of the tool, if specified. It is optional and can be null **Since**: 3800.17.0" }, "secret": { "type": "string", "description": "The secret value" }, "sendEmail": { "type": "boolean", "description": "Whether the user's email address can be sent to the LTI tool provider." }, "sendName": { "type": "boolean", "description": "Whether the user's name can be sent to the LTI tool provider." }, "sendRole": { "type": "boolean", "description": "Whether the user's role can be sent to the LTI tool provider." }, "sendUserDataType": { "type": "string", "description": "Enum indicating when user data can be sent to the LTI tool provider. | Type | Description | --------- | --------- | | Never | | | Sslonly | | | Always | **Since**: 3300.9.0 |", "enum": [ "Never", "Sslonly", "Always" ] }, "status": { "type": "string", "description": "Enum that indicates if the set of domains associated with this config can or cannot be linked to. | Type | Description | --------- | --------- | | Approved | | | Excluded | | | NeedsApproval | **Since**: 3300.9.0 |", "enum": [ "Approved", "Excluded", "NeedsApproval" ] }, "useSplashScreen": { "type": "boolean", "description": "Whether a splash screen is shown before launching the LTI link. Cannot be set to true if allowMembershipService is true." } }, "required": [ "PCID", "domainId" ] } ``` *** ## blackboard\_system\_patch\_learn\_api\_public\_lti\_placements\_by\_placementid Update Placement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `placementId` | string | Yes | — | Placement Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `allowGrading` | boolean | No | — | Whether this placement can accept grades from the tool provider and a grade column can be created for it. This only applies to Enum\[Type]#`ContentHandler` types. All others don't support grading and will be set to false. | | `allowStudents` | boolean | No | — | Whether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool. | | `authorId` | string | No | — | Id of the creator of the placement **Deprecated**: since 3900.0 not used | | `availability` | object | No | — | Settings controlling availability of the placement. | | `customParameters` | object | No | — | Custom launch parameters for the tool. | | `description` | string | No | — | The description of the placement. Not required to be unique. Maximum length is 1000 characters, BAD\_REQUEST error with message is returned if greater than 1000 characters. | | `iconUrl` | string | No | — | The URL of the icon for this placement, if any. Not required to be unique, must be a complete and valid URL. Maximum length is 255 characters, BAD\_REQUEST error with message is returned if greater than 255 characters or incomplete URL. | | `instructorCreated` | boolean | No | — | Whether an instructor created the placement or not (otherwise admin) **Deprecated**: since 3900.0 not used | | `key` | string | No | — | The key value | | `launchInNewWindow` | boolean | No | — | Whether this placement link should be opened in a new window or not. | | `name` | string | No | — | The name of the placement. Not required to be unique. Maximum length of 50 characters, BAD\_REQUEST error with message is returned if greater than 50 characters. | | `secret` | string | No | — | The secret value | | `url` | string | No | — | The URL of the tool provider. Not required to be unique, must be a complete and valid URL. Maximum length is 1024 characters, BAD\_REQUEST error with message is returned if greater than 1024 characters or incomplete URL. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "placementId": { "type": "string", "description": "Placement Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "allowGrading": { "type": "boolean", "description": "Whether this placement can accept grades from the tool provider and a grade column can be created for it. This only applies to Enum[Type]#`ContentHandler` types. All others don't support grading and will be set to false." }, "allowStudents": { "type": "boolean", "description": "Whether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool." }, "authorId": { "type": "string", "description": "Id of the creator of the placement **Deprecated**: since 3900.0 not used" }, "availability": { "type": "object", "description": "Settings controlling availability of the placement.", "properties": { "available": { "type": "string", "description": "Whether the placement is available within the system. | Type | Description | --------- | --------- | | Yes | | | No | |", "enum": [ "Yes", "No" ] } } }, "customParameters": { "type": "object", "description": "Custom launch parameters for the tool." }, "description": { "type": "string", "description": "The description of the placement. Not required to be unique. Maximum length is 1000 characters, BAD_REQUEST error with message is returned if greater than 1000 characters." }, "iconUrl": { "type": "string", "description": "The URL of the icon for this placement, if any. Not required to be unique, must be a complete and valid URL. Maximum length is 255 characters, BAD_REQUEST error with message is returned if greater than 255 characters or incomplete URL." }, "instructorCreated": { "type": "boolean", "description": "Whether an instructor created the placement or not (otherwise admin) **Deprecated**: since 3900.0 not used" }, "key": { "type": "string", "description": "The key value" }, "launchInNewWindow": { "type": "boolean", "description": "Whether this placement link should be opened in a new window or not." }, "name": { "type": "string", "description": "The name of the placement. Not required to be unique. Maximum length of 50 characters, BAD_REQUEST error with message is returned if greater than 50 characters." }, "secret": { "type": "string", "description": "The secret value" }, "url": { "type": "string", "description": "The URL of the tool provider. Not required to be unique, must be a complete and valid URL. Maximum length is 1024 characters, BAD_REQUEST error with message is returned if greater than 1024 characters or incomplete URL." } }, "required": [ "PCID", "placementId" ] } ``` *** ## blackboard\_system\_post\_learn\_api\_public\_courses\_by\_courseid\_assessments\_by\_assessmentid\_questions Create Question **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `assessmentId` | string | Yes | — | Assessment Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `correctResponseFeedback` | string | No | — | Feedback displayed to students when their submitted response is correct. | | `incorrectResponseFeedback` | string | No | — | Feedback displayed to students when their submitted response is incorrect. | | `instructorNotes` | string | No | — | Text added to the question as a note for the instructor. It is not intended to be displayed to students. | | `points` | number | No | — | The point value for the question. | | `position` | integer | No | — | Position of the Question on the Assessment Canvas. | | `questionHandler` | object | No | — | Question Handler | | `text` | string | Yes | — | The main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor. | | `title` | string | No | — | The title of the question. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "assessmentId": { "type": "string", "description": "Assessment Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "correctResponseFeedback": { "type": "string", "description": "Feedback displayed to students when their submitted response is correct." }, "incorrectResponseFeedback": { "type": "string", "description": "Feedback displayed to students when their submitted response is incorrect." }, "instructorNotes": { "type": "string", "description": "Text added to the question as a note for the instructor. It is not intended to be displayed to students." }, "points": { "type": "number", "description": "The point value for the question." }, "position": { "type": "integer", "description": "Position of the Question on the Assessment Canvas." }, "questionHandler": { "type": "object", "description": "Question Handler", "properties": { "type": { "type": "string", "description": "Type of Question supported. | Type | Description | --------- | --------- | | Presentation | **Since**: 3300.9.0 | | EitherOr | Read Only **Since**: 3300.9.0 | | Essay | Read Only **Since**: 3300.9.0 | | MultipleAnswer | Read Only **Since**: 3400.4.0 | | Numeric | Read Only **Since**: 3400.4.0 | | MultipleChoice | Read Only **Since**: 3400.4.0 | | Ordering | Read Only **Since**: 3400.4.0 | | Matching | Read Only **Since**: 3400.4.0 | | FillInTheBlank | Read Only **Since**: 3400.4.0 | | Calculated | Read Only **Since**: 3400.4.0 | | FileResponse | Read Only **Since**: 3400.4.0 | | LikertOpinionScale | Read Only **Since**: 3400.4.0 | | QuizBowl | Read Only **Since**: 3400.4.0 | | HotSpot | Read Only **Since**: 3400.4.0 | | JumbledSentence | Read Only **Since**: 3400.4.0 | | FillInTheBlankPlus | Read Only **Since**: 3400.4.0 | | QuestionBlock | Read Only **Since**: 3700.2.0 |", "enum": [ "Presentation", "EitherOr", "Essay", "MultipleAnswer", "Numeric", "MultipleChoice", "Ordering", "Matching", "FillInTheBlank", "Calculated", "FileResponse", "LikertOpinionScale", "QuizBowl", "HotSpot", "JumbledSentence", "FillInTheBlankPlus", "QuestionBlock" ] } } }, "text": { "type": "string", "description": "The main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor." }, "title": { "type": "string", "description": "The title of the question." } }, "required": [ "PCID", "courseId", "assessmentId", "text" ] } ``` *** ## blackboard\_system\_post\_learn\_api\_public\_lti\_domains Create Domain Config **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `allowGradesService` | boolean | No | — | Whether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. **Since**: 3600.0.0 | | `allowMembershipService` | boolean | No | — | Whether the Tool is allowed to call the LTI Names and Roles service and get the course memberships. | | `clientId` | string | No | — | The client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 **Since**: 3600.0.0 | | `customParameters` | object | No | — | The custom parameters for the given domain. | | `description` | string | No | — | The description of the domain configuration **Since**: 3900.23.0 | | `jwksUrl` | string | No | — | The JWKS URL of the tool, if specified. It is optional and can be null **Since**: 3800.17.0 | | `key` | string | No | — | The key value | | `name` | string | No | — | The name of the domain configuration **Since**: 3900.23.0 | | `primaryDomain` | string | No | — | The primary domain name associated with this configuration. | | `publicKey` | string | No | — | The public key of the tool, if specified. It is optional and can be null **Since**: 3800.17.0 | | `secret` | string | No | — | The secret value | | `sendEmail` | boolean | No | — | Whether the user's email address can be sent to the LTI tool provider. | | `sendName` | boolean | No | — | Whether the user's name can be sent to the LTI tool provider. | | `sendRole` | boolean | No | — | Whether the user's role can be sent to the LTI tool provider. | | `sendUserDataType` | string | No | — | Enum indicating when user data can be sent to the LTI tool provider. \| Type \| Description \| --------- \| --------- \| \| Never \| \| \| Sslonly \| \| \| Always \| **Since**: 3300.9.0 \| | | `status` | string | No | — | Enum that indicates if the set of domains associated with this config can or cannot be linked to. \| Type \| Description \| --------- \| --------- \| \| Approved \| \| \| Excluded \| \| \| NeedsApproval \| **Since**: 3300.9.0 \| | | `useSplashScreen` | boolean | No | — | Whether a splash screen is shown before launching the LTI link. Cannot be set to true if allowMembershipService is true. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allowGradesService": { "type": "boolean", "description": "Whether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. **Since**: 3600.0.0" }, "allowMembershipService": { "type": "boolean", "description": "Whether the Tool is allowed to call the LTI Names and Roles service and get the course memberships." }, "clientId": { "type": "string", "description": "The client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 **Since**: 3600.0.0" }, "customParameters": { "type": "object", "description": "The custom parameters for the given domain." }, "description": { "type": "string", "description": "The description of the domain configuration **Since**: 3900.23.0" }, "jwksUrl": { "type": "string", "description": "The JWKS URL of the tool, if specified. It is optional and can be null **Since**: 3800.17.0" }, "key": { "type": "string", "description": "The key value" }, "name": { "type": "string", "description": "The name of the domain configuration **Since**: 3900.23.0" }, "primaryDomain": { "type": "string", "description": "The primary domain name associated with this configuration." }, "publicKey": { "type": "string", "description": "The public key of the tool, if specified. It is optional and can be null **Since**: 3800.17.0" }, "secret": { "type": "string", "description": "The secret value" }, "sendEmail": { "type": "boolean", "description": "Whether the user's email address can be sent to the LTI tool provider." }, "sendName": { "type": "boolean", "description": "Whether the user's name can be sent to the LTI tool provider." }, "sendRole": { "type": "boolean", "description": "Whether the user's role can be sent to the LTI tool provider." }, "sendUserDataType": { "type": "string", "description": "Enum indicating when user data can be sent to the LTI tool provider. | Type | Description | --------- | --------- | | Never | | | Sslonly | | | Always | **Since**: 3300.9.0 |", "enum": [ "Never", "Sslonly", "Always" ] }, "status": { "type": "string", "description": "Enum that indicates if the set of domains associated with this config can or cannot be linked to. | Type | Description | --------- | --------- | | Approved | | | Excluded | | | NeedsApproval | **Since**: 3300.9.0 |", "enum": [ "Approved", "Excluded", "NeedsApproval" ] }, "useSplashScreen": { "type": "boolean", "description": "Whether a splash screen is shown before launching the LTI link. Cannot be set to true if allowMembershipService is true." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_post\_learn\_api\_public\_lti\_placements Create Placement **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `allowGrading` | boolean | No | — | Whether this placement can accept grades from the tool provider and a grade column can be created for it. This only applies to Enum\[Type]#`ContentHandler` types. All others don't support grading and will be set to false. | | `allowStudents` | boolean | No | — | Whether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool. | | `authorId` | string | No | — | Id of the creator of the placement **Deprecated**: since 3900.0 not used | | `availability` | object | No | — | Settings controlling availability of the placement. | | `customParameters` | object | No | — | Custom launch parameters for the tool. | | `description` | string | No | — | The description of the placement. Not required to be unique. Maximum length is 1000 characters, BAD\_REQUEST error with message is returned if greater than 1000 characters. | | `handle` | string | Yes | — | The handle that uniquely identifies this placement. Required to be unique. Maximum length is 32 characters, BAD\_REQUEST error with message is returned if greater than 32 characters. | | `iconUrl` | string | No | — | The URL of the icon for this placement, if any. Not required to be unique, must be a complete and valid URL. Maximum length is 255 characters, BAD\_REQUEST error with message is returned if greater than 255 characters or incomplete URL. | | `instructorCreated` | boolean | No | — | Whether an instructor created the placement or not (otherwise admin) **Deprecated**: since 3900.0 not used | | `key` | string | No | — | The key value | | `launchInNewWindow` | boolean | No | — | Whether this placement link should be opened in a new window or not. | | `name` | string | Yes | — | The name of the placement. Not required to be unique. Maximum length of 50 characters, BAD\_REQUEST error with message is returned if greater than 50 characters. | | `secret` | string | No | — | The secret value | | `type` | string | Yes | — | The type of placement. \| Type \| Description \| --------- \| --------- \| \| Application \| Application or Student Tool Placement \| \| ContentHandler \| Content Type placement \| \| ContentItemMessage \| Content-item Message placement (see IMSGlobal spec) **Since**: 3300.5.0 \| \| System \| System-level Tools \| \| Administrator \| Administrator-level Tools **Since**: 3400.1.0 \| \| UltraUI \| Ultra-UI Extensions **Since**: 3700.6.0 \| \| BaseNavigation \| Base Navigation \| \| CourseNavigation \| Course Navigation \| \| Proctoring \| Proctoring **Since**: 3900.10.0 \| | | `url` | string | Yes | — | The URL of the tool provider. Not required to be unique, must be a complete and valid URL. Maximum length is 1024 characters, BAD\_REQUEST error with message is returned if greater than 1024 characters or incomplete URL. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allowGrading": { "type": "boolean", "description": "Whether this placement can accept grades from the tool provider and a grade column can be created for it. This only applies to Enum[Type]#`ContentHandler` types. All others don't support grading and will be set to false." }, "allowStudents": { "type": "boolean", "description": "Whether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool." }, "authorId": { "type": "string", "description": "Id of the creator of the placement **Deprecated**: since 3900.0 not used" }, "availability": { "type": "object", "description": "Settings controlling availability of the placement.", "properties": { "available": { "type": "string", "description": "Whether the placement is available within the system. | Type | Description | --------- | --------- | | Yes | | | No | |", "enum": [ "Yes", "No" ] } } }, "customParameters": { "type": "object", "description": "Custom launch parameters for the tool." }, "description": { "type": "string", "description": "The description of the placement. Not required to be unique. Maximum length is 1000 characters, BAD_REQUEST error with message is returned if greater than 1000 characters." }, "handle": { "type": "string", "description": "The handle that uniquely identifies this placement. Required to be unique. Maximum length is 32 characters, BAD_REQUEST error with message is returned if greater than 32 characters." }, "iconUrl": { "type": "string", "description": "The URL of the icon for this placement, if any. Not required to be unique, must be a complete and valid URL. Maximum length is 255 characters, BAD_REQUEST error with message is returned if greater than 255 characters or incomplete URL." }, "instructorCreated": { "type": "boolean", "description": "Whether an instructor created the placement or not (otherwise admin) **Deprecated**: since 3900.0 not used" }, "key": { "type": "string", "description": "The key value" }, "launchInNewWindow": { "type": "boolean", "description": "Whether this placement link should be opened in a new window or not." }, "name": { "type": "string", "description": "The name of the placement. Not required to be unique. Maximum length of 50 characters, BAD_REQUEST error with message is returned if greater than 50 characters." }, "secret": { "type": "string", "description": "The secret value" }, "type": { "type": "string", "description": "The type of placement. | Type | Description | --------- | --------- | | Application | Application or Student Tool Placement | | ContentHandler | Content Type placement | | ContentItemMessage | Content-item Message placement (see IMSGlobal spec) **Since**: 3300.5.0 | | System | System-level Tools | | Administrator | Administrator-level Tools **Since**: 3400.1.0 | | UltraUI | Ultra-UI Extensions **Since**: 3700.6.0 | | BaseNavigation | Base Navigation | | CourseNavigation | Course Navigation | | Proctoring | Proctoring **Since**: 3900.10.0 |", "enum": [ "Application", "ContentHandler", "ContentItemMessage", "System", "Administrator", "UltraUI", "BaseNavigation", "CourseNavigation", "Proctoring" ] }, "url": { "type": "string", "description": "The URL of the tool provider. Not required to be unique, must be a complete and valid URL. Maximum length is 1024 characters, BAD_REQUEST error with message is returned if greater than 1024 characters or incomplete URL." } }, "required": [ "PCID", "handle", "name", "type", "url" ] } ``` *** ## blackboard\_system\_post\_learn\_api\_public\_uploads Upload **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` # blackboard-users Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/blackboard/blackboard-users Blackboard Users - user management, roles, sessions, OAuth, and data sources **Server path:** `/blackboard-users` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`blackboard_users_delete_learn_api_public_datasources_by_datasourceid`](#blackboard_users_delete_learn_api_public_datasources_by_datasourceid) | Delete Data Source | | [`blackboard_users_delete_learn_api_public_users_by_userid`](#blackboard_users_delete_learn_api_public_users_by_userid) | Delete User | | [`blackboard_users_delete_learn_api_public_users_by_userid_observers_by_observerid`](#blackboard_users_delete_learn_api_public_users_by_userid_observers_by_observerid) | Delete Observer | | [`blackboard_users_get_learn_api_public_courseroles`](#blackboard_users_get_learn_api_public_courseroles) | Get Course Roles | | [`blackboard_users_get_learn_api_public_courseroles_by_roleid`](#blackboard_users_get_learn_api_public_courseroles_by_roleid) | Get Course Role | | [`blackboard_users_get_learn_api_public_datasources`](#blackboard_users_get_learn_api_public_datasources) | Get Data Sources | | [`blackboard_users_get_learn_api_public_datasources_by_datasourceid`](#blackboard_users_get_learn_api_public_datasources_by_datasourceid) | Get Data Source | | [`blackboard_users_get_learn_api_public_institutionroles`](#blackboard_users_get_learn_api_public_institutionroles) | Get Institution Roles | | [`blackboard_users_get_learn_api_public_institutionroles_by_roleid`](#blackboard_users_get_learn_api_public_institutionroles_by_roleid) | Get Institution Role | | [`blackboard_users_get_learn_api_public_oauth2_authorizationcode`](#blackboard_users_get_learn_api_public_oauth2_authorizationcode) | Authorization Code | | [`blackboard_users_get_learn_api_public_oauth2_tokeninfo`](#blackboard_users_get_learn_api_public_oauth2_tokeninfo) | Get Token Info | | [`blackboard_users_get_learn_api_public_sessions`](#blackboard_users_get_learn_api_public_sessions) | Get Active Sessions | | [`blackboard_users_get_learn_api_public_systemroles`](#blackboard_users_get_learn_api_public_systemroles) | Get System Roles | | [`blackboard_users_get_learn_api_public_systemroles_by_roleid`](#blackboard_users_get_learn_api_public_systemroles_by_roleid) | Get System Role | | [`blackboard_users_get_learn_api_public_users`](#blackboard_users_get_learn_api_public_users) | Get Users | | [`blackboard_users_get_learn_api_public_users_by_userid`](#blackboard_users_get_learn_api_public_users_by_userid) | Get User | | [`blackboard_users_get_learn_api_public_users_by_userid_avatar`](#blackboard_users_get_learn_api_public_users_by_userid_avatar) | Get User Avatar | | [`blackboard_users_get_learn_api_public_users_by_userid_observees`](#blackboard_users_get_learn_api_public_users_by_userid_observees) | Get Observees | | [`blackboard_users_get_learn_api_public_users_by_userid_observers`](#blackboard_users_get_learn_api_public_users_by_userid_observers) | Get Observers | | [`blackboard_users_get_learn_api_public_users_by_userid_sessions`](#blackboard_users_get_learn_api_public_users_by_userid_sessions) | Get Current Active User By Id | | [`blackboard_users_patch_learn_api_public_datasources_by_datasourceid`](#blackboard_users_patch_learn_api_public_datasources_by_datasourceid) | Update Data Source | | [`blackboard_users_patch_learn_api_public_users_by_userid`](#blackboard_users_patch_learn_api_public_users_by_userid) | Update User | | [`blackboard_users_post_learn_api_public_datasources`](#blackboard_users_post_learn_api_public_datasources) | Create Data Source | | [`blackboard_users_post_learn_api_public_oauth2_token`](#blackboard_users_post_learn_api_public_oauth2_token) | Request Token | | [`blackboard_users_post_learn_api_public_users`](#blackboard_users_post_learn_api_public_users) | Create User | | [`blackboard_users_put_learn_api_public_users_by_userid_observers_by_observerid`](#blackboard_users_put_learn_api_public_users_by_userid_observers_by_observerid) | Create Observer | *** ## blackboard\_users\_delete\_learn\_api\_public\_datasources\_by\_datasourceid Delete Data Source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dataSourceId` | string | Yes | — | The data source ID. This may be the primary ID, or the secondary ID prefixed with the ID type. \| ID type \| Example \| \|------------\|--------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dataSourceId": { "type": "string", "description": "The data source ID. This may be the primary ID, or the secondary ID prefixed with the ID type. | ID type | Example | |------------|--------------------| | primary | _123_1 | | externalId | externalId:math101 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "dataSourceId" ] } ``` *** ## blackboard\_users\_delete\_learn\_api\_public\_users\_by\_userid Delete User **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "userId" ] } ``` *** ## blackboard\_users\_delete\_learn\_api\_public\_users\_by\_userid\_observers\_by\_observerid Delete Observer **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `observerId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| **Since**: 3500.5.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "observerId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 | **Since**: 3500.5.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "userId", "observerId" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_courseroles Get Course Roles **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "name.family(desc),created" **Since**: 3100.0.0 | | `custom` | boolean | No | — | Search course roles by whether they are a custom or system generated course role. **Since**: 3300.5.0 | | `roleId` | string | No | — | Search course roles using their roleId's. Any course role with a roleId that contains the given string will be returned. The search is case insensitive. **Since**: 3300.5.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"name.family(desc),created\" **Since**: 3100.0.0" }, "custom": { "type": "boolean", "description": "Search course roles by whether they are a custom or system generated course role. **Since**: 3300.5.0" }, "roleId": { "type": "string", "description": "Search course roles using their roleId's. Any course role with a roleId that contains the given string will be returned. The search is case insensitive. **Since**: 3300.5.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_courseroles\_by\_roleid Get Course Role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `roleId` | string | Yes | — | The course role ID. This may be the primary ID, or the roleId. The suffix ":custom" will be appended to the roleId of a custom course role if that roleId conflicts with the roleId of a system generated course role. For example, if a custom role roleId is specified as "Student" then the roleId will actually be "Student:custom" since there is already a system generated course role with the roleId of "Student". \| ID type \| Examples \| \|------------\|------------------------------------------------------------\| \| primary \| \_123\_1 \| \| roleId \| roleId:Student, roleId:MyCustomRole, roleId:Student:custom \| **Since**: 3300.5.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "roleId": { "type": "string", "description": "The course role ID. This may be the primary ID, or the roleId. The suffix \":custom\" will be appended to the roleId of a custom course role if that roleId conflicts with the roleId of a system generated course role. For example, if a custom role roleId is specified as \"Student\" then the roleId will actually be \"Student:custom\" since there is already a system generated course role with the roleId of \"Student\". | ID type | Examples | |------------|------------------------------------------------------------| | primary | _123_1 | | roleId | roleId:Student, roleId:MyCustomRole, roleId:Student:custom | **Since**: 3300.5.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "roleId" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_datasources Get Data Sources **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `externalId` | string | No | — | The 'batchUid' value to use as search criteria. Currently only supports 'contains' searches. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "externalId": { "type": "string", "description": "The 'batchUid' value to use as search criteria. Currently only supports 'contains' searches." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_datasources\_by\_datasourceid Get Data Source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dataSourceId` | string | Yes | — | The data source ID. This may be the primary ID, or the secondary ID prefixed with the ID type. \| ID type \| Example \| \|------------\|--------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dataSourceId": { "type": "string", "description": "The data source ID. This may be the primary ID, or the secondary ID prefixed with the ID type. | ID type | Example | |------------|--------------------| | primary | _123_1 | | externalId | externalId:math101 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "dataSourceId" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_institutionroles Get Institution Roles **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "roleId(desc)" Supported fields are: - roleId - custom **Since**: 3300.4.0 | | `roleId` | string | No | — | Search for institution roles with roleId properties that contain this value. **Since**: 3300.4.0 | | `custom` | boolean | No | — | Search for institution roles by custom flag. A value of 'true' indicates that search results should be limited to only custom roles. A value of 'false' indicates results should be limited to built-in roles. Not setting this field indicates that all institution roles should be returned. **Since**: 3300.4.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"roleId(desc)\" Supported fields are: - roleId - custom **Since**: 3300.4.0" }, "roleId": { "type": "string", "description": "Search for institution roles with roleId properties that contain this value. **Since**: 3300.4.0" }, "custom": { "type": "boolean", "description": "Search for institution roles by custom flag. A value of 'true' indicates that search results should be limited to only custom roles. A value of 'false' indicates results should be limited to built-in roles. Not setting this field indicates that all institution roles should be returned. **Since**: 3300.4.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_institutionroles\_by\_roleid Get Institution Role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `roleId` | string | Yes | — | The institution role ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| roleId \| roleId:STUDENT \| **Since**: 3300.5.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "roleId": { "type": "string", "description": "The institution role ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | roleId | roleId:STUDENT | **Since**: 3300.5.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "roleId" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_oauth2\_authorizationcode Authorization Code **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `redirect_uri` | string | No | — | the redirectUri to send the end user to once an authorization code response is made in Oauth2 Authorization Code Workflow | | `response_type` | string | No | — | Required. The response\_type expected which must to be set to "code" | | `client_id` | string | No | — | Required. The client identifier for the registered application. | | `scope` | string | No | — | the space delimited scope(s) being requested for this authorization. Example value: "read write offline" | | `state` | string | No | — | Opaque value used by client to maintain state between request and callback. Used to prevent cross-site request forgery. | | `code_challenge` | string | No | — | A code challenge to verify credentials along with the granted authorization code. It is used with the PKCE standard. **Since**: 3700.4.0 | | `code_challenge_method` | string | No | — | This is the method used to verify the code challenge using the PKCE standard. Blackboard only supports s256 as the code challenge method. **Since**: 3700.4.0 | | `one_time_session_token` | string | No | — | Token used to retrieve the session that generated this Oauth2 Code request. Used when session cookies are not sent due to privacy settings of the browser. **Since**: 3900.13.0 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "redirect_uri": { "type": "string", "description": "the redirectUri to send the end user to once an authorization code response is made in Oauth2 Authorization Code Workflow" }, "response_type": { "type": "string", "description": "Required. The response_type expected which must to be set to \"code\"" }, "client_id": { "type": "string", "description": "Required. The client identifier for the registered application." }, "scope": { "type": "string", "description": "the space delimited scope(s) being requested for this authorization. Example value: \"read write offline\"" }, "state": { "type": "string", "description": "Opaque value used by client to maintain state between request and callback. Used to prevent cross-site request forgery." }, "code_challenge": { "type": "string", "description": "A code challenge to verify credentials along with the granted authorization code. It is used with the PKCE standard. **Since**: 3700.4.0" }, "code_challenge_method": { "type": "string", "description": "This is the method used to verify the code challenge using the PKCE standard. Blackboard only supports s256 as the code challenge method. **Since**: 3700.4.0" }, "one_time_session_token": { "type": "string", "description": "Token used to retrieve the session that generated this Oauth2 Code request. Used when session cookies are not sent due to privacy settings of the browser. **Since**: 3900.13.0" } }, "required": [ "PCID" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_oauth2\_tokeninfo Get Token Info **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `access_token` | string | Yes | — | The application key and secret, encoded using RFC 2617 Basic authentication. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "access_token": { "type": "string", "description": "The application key and secret, encoded using RFC 2617 Basic authentication." } }, "required": [ "PCID", "access_token" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_sessions Get Active Sessions **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\
    \
  • user\
    • \
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "expand": { "type": "string", "description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
  • user
" } }, "required": [ "PCID" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_systemroles Get System Roles **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `roleId` | string | No | — | Search for system roles with roleId **Since**: 3300.5.0 | | `custom` | boolean | No | — | Search for system roles by custom flag. A value of 'true' indicates that search results should be limited to only custom roles. A value of 'false' indicates results should be limited to built-in roles. Not setting this field indicates that all system roles should be returned. **Since**: 3300.5.0 | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "roleId(desc)" Supported fields are: \
    ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "roleId": { "type": "string", "description": "Search for system roles with roleId **Since**: 3300.5.0" }, "custom": { "type": "boolean", "description": "Search for system roles by custom flag. A value of 'true' indicates that search results should be limited to only custom roles. A value of 'false' indicates results should be limited to built-in roles. Not setting this field indicates that all system roles should be returned. **Since**: 3300.5.0" }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"roleId(desc)\" Supported fields are:
      *** ## blackboard\_users\_get\_learn\_api\_public\_systemroles\_by\_roleid Get System Role **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `roleId` | string | Yes | — | The System Role ID. This may be the primary ID, or the secondary roleId type. The suffix ":custom" will be appended to the roleId of a custom system role if that roleId conflicts with the roleId of a system generated role. For example, if a custom role roleId is specified as "Guest" then the roleId will actually be "Guest:custom" since there is already a system generated role with the roleId of "Guest". \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| roleId \| roleId:column1 \| **Since**: 3300.5.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "roleId": { "type": "string", "description": "The System Role ID. This may be the primary ID, or the secondary roleId type. The suffix \":custom\" will be appended to the roleId of a custom system role if that roleId conflicts with the roleId of a system generated role. For example, if a custom role roleId is specified as \"Guest\" then the roleId will actually be \"Guest:custom\" since there is already a system generated role with the roleId of \"Guest\". | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | roleId | roleId:column1 | **Since**: 3300.5.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "roleId" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_users Get Users **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `userName` | string | No | — | Search for users with userName properties that contain this value. **Since**: 3000.11.0 | | `externalId` | string | No | — | Search for users with externalId properties that contain this value. **Since**: 3000.11.0 | | `created` | string | No | — | Search for users with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3000.11.0 | | `modified` | string | No | — | Search for users with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3700.1.0 | | `lastLogin` | string | No | — | Search for users with a last login date relative to this value. 'lastLoginCompare' may also be sent to control search behavior. A user who has never logged in would have a null last login date. This is not considered to be greater than, less than, or equal to a valid date. Such users will be filtered out any time this filter is used. **Since**: 3900.9.0 | | `createdCompare` | string | No | — | Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3000.11.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `modifiedCompare` | string | No | — | Used alongside the 'modifiedDate' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `lastLoginCompare` | string | No | — | Used alongside the 'lastLoginDate' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3900.9.0 \| Type \| Description \| --------- \| --------- \| \| lessThan \| \| \| greaterOrEqual \| \| | | `dataSourceId` | string | No | — | Search for users with this dataSourceId. This may optionally be the data source's externalId using the syntax "externalId:math101". **Since**: 3000.11.0 | | `name.family` | string | No | — | Search for users with name.family properties that contain this value. **Since**: 3000.11.0 | | `availability.available` | string | No | — | Search for users with availability.available properties that contain this value. **Since**: 3100.0.0 \| Type \| Description \| --------- \| --------- \| \| Yes \| \| \| No \| \| \| Disabled \| **Since**: 3100.0.0 \| | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "name.family(desc),created" Supported fields are: - userName - name.family - externalId - dataSourceId - created **Since**: 3100.0.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "userName": { "type": "string", "description": "Search for users with userName properties that contain this value. **Since**: 3000.11.0" }, "externalId": { "type": "string", "description": "Search for users with externalId properties that contain this value. **Since**: 3000.11.0" }, "created": { "type": "string", "description": "Search for users with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3000.11.0" }, "modified": { "type": "string", "description": "Search for users with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3700.1.0" }, "lastLogin": { "type": "string", "description": "Search for users with a last login date relative to this value. 'lastLoginCompare' may also be sent to control search behavior. A user who has never logged in would have a null last login date. This is not considered to be greater than, less than, or equal to a valid date. Such users will be filtered out any time this filter is used. **Since**: 3900.9.0" }, "createdCompare": { "type": "string", "description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3000.11.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "modifiedCompare": { "type": "string", "description": "Used alongside the 'modifiedDate' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "lastLoginCompare": { "type": "string", "description": "Used alongside the 'lastLoginDate' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3900.9.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |", "enum": [ "lessThan", "greaterOrEqual" ] }, "dataSourceId": { "type": "string", "description": "Search for users with this dataSourceId. This may optionally be the data source's externalId using the syntax \"externalId:math101\". **Since**: 3000.11.0" }, "name.family": { "type": "string", "description": "Search for users with name.family properties that contain this value. **Since**: 3000.11.0" }, "availability.available": { "type": "string", "description": "Search for users with availability.available properties that contain this value. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |", "enum": [ "Yes", "No", "Disabled" ] }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"name.family(desc),created\" Supported fields are: - userName - name.family - externalId - dataSourceId - created **Since**: 3100.0.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_users\_by\_userid Get User **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "userId" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_users\_by\_userid\_avatar Get User Avatar **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" } }, "required": [ "PCID", "userId" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_users\_by\_userid\_observees Get Observees **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "userId" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_users\_by\_userid\_observers Get Observers **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "userId" ] } ``` *** ## blackboard\_users\_get\_learn\_api\_public\_users\_by\_userid\_sessions Get Current Active User By Id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "userId" ] } ``` *** ## blackboard\_users\_patch\_learn\_api\_public\_datasources\_by\_datasourceid Update Data Source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `dataSourceId` | string | Yes | — | The data source ID. This may be the primary ID, or the secondary ID prefixed with the ID type. \| ID type \| Example \| \|------------\|--------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `description` | string | No | — | The description of the data source. | | `externalId` | string | No | — | An externally-defined unique ID for the data source. Formerly known as 'batchUid'. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dataSourceId": { "type": "string", "description": "The data source ID. This may be the primary ID, or the secondary ID prefixed with the ID type. | ID type | Example | |------------|--------------------| | primary | _123_1 | | externalId | externalId:math101 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "description": { "type": "string", "description": "The description of the data source." }, "externalId": { "type": "string", "description": "An externally-defined unique ID for the data source. Formerly known as 'batchUid'." } }, "required": [ "PCID", "dataSourceId" ] } ``` *** ## blackboard\_users\_patch\_learn\_api\_public\_users\_by\_userid Update User **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `address` | object | No | — | The user's mailing address. | | `availability` | object | No | — | Settings controlling availability of the user account. | | `avatar` | object | No | — | The user's avatar metadata **Since**: 3800.13.0 | | `birthDate` | string | No | — | The birth date of this user. Only the date portion of this value has significance, since a person's birthdate represents a full day and not a moment in time. Take care to ignore the zeroed time portion when deserializing this value to ensure it's not converted to the previous calendar day if your local time zone has a negative UTC offset. | | `contact` | object | No | — | The user's contact information. | | `dataSourceId` | string | No | — | The ID of the data source associated with this user. This may optionally be the data source's externalId using the syntax "externalId:math101". | | `educationLevel` | string | No | — | The education level of this user. \| Type \| Description \| --------- \| --------- \| \| K8 \| Kindergarten through 8th grade \| \| HighSchool \| Grades 9 through 12. \| \| Freshman \| College or university freshman. \| \| Sophomore \| College or university sophomore. \| \| Junior \| College or university junior. \| \| Senior \| College or university senior. \| \| GraduateSchool \| Graduate school student. \| \| PostGraduateSchool \| Post-graduate school student. \| \| Unknown \| Education Level is not known, or not specified. \| | | `externalId` | string | No | — | An optional externally-defined unique ID for the user. Defaults to the userName. Formerly known as 'batchUid'. | | `gender` | string | No | — | The gender of this user. \| Type \| Description \| --------- \| --------- \| \| Female \| Female \| \| Male \| Male \| \| Unknown \| Gender is not known, or not specified. \| | | `institutionRoleIds` | string\[] | No | — | The primary and secondary institution roles assigned to this user. The primary institution role is the first item in the list, followed by all secondary institution roles sorted alphabetically. **Since**: 3300.3.0 | | `job` | object | No | — | The user's job information. | | `locale` | object | No | — | The user's localization settings. | | `name` | object | No | — | Properties used to build the user's display name. | | `password` | string | No | — | The user's login password. | | `studentId` | string | No | — | The user's student ID name or number as defined by the school or institution. | | `systemRoleIds` | string\[] | No | — | The system roles (the administrative user roles in the UI) for this user. The first role in this list is the user's primary system role, while the remaining are secondary system roles. | | `userName` | string | No | — | The userName property, shown in the UI. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "address": { "type": "object", "description": "The user's mailing address.", "properties": { "street1": { "type": "string", "description": "The street address of the user." }, "street2": { "type": "string", "description": "An additional field to store the street address of the user." }, "city": { "type": "string", "description": "The city the user resides in." }, "state": { "type": "string", "description": "The state or province the user resides in." }, "zipCode": { "type": "string", "description": "The zip code or postal code the user resides in." }, "country": { "type": "string", "description": "The country the user resides in." } } }, "availability": { "type": "object", "description": "Settings controlling availability of the user account.", "properties": { "available": { "type": "string", "description": "Whether the user is available within the system. Unavailable users cannot log in. | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |", "enum": [ "Yes", "No", "Disabled" ] } } }, "avatar": { "type": "object", "description": "The user's avatar metadata **Since**: 3800.13.0", "properties": { "source": { "type": "string", "description": "The source of the user's avatar **Since**: 3800.13.0 | Type | Description | --------- | --------- | | Default | The server default avatar | | User | The user set his/her own avatar | | System | A privileged user set the user's avatar to something other than default |", "enum": [ "Default", "User", "System" ] }, "uploadId": { "type": "string", "description": "The upload id of the avatar image file **Since**: 3800.13.0" } } }, "birthDate": { "type": "string", "description": "The birth date of this user. Only the date portion of this value has significance, since a person's birthdate represents a full day and not a moment in time. Take care to ignore the zeroed time portion when deserializing this value to ensure it's not converted to the previous calendar day if your local time zone has a negative UTC offset." }, "contact": { "type": "object", "description": "The user's contact information.", "properties": { "homePhone": { "type": "string", "description": "The user's home phone number." }, "mobilePhone": { "type": "string", "description": "The user's mobile phone number." }, "businessPhone": { "type": "string", "description": "The user's business phone number." }, "businessFax": { "type": "string", "description": "The user's business fax number." }, "email": { "type": "string", "description": "The user's email address." }, "institutionEmail": { "type": "string", "description": "The user's institutional email address. **Since**: 3900.19.0" }, "webPage": { "type": "string", "description": "The URL of the user's personal website." } } }, "dataSourceId": { "type": "string", "description": "The ID of the data source associated with this user. This may optionally be the data source's externalId using the syntax \"externalId:math101\"." }, "educationLevel": { "type": "string", "description": "The education level of this user. | Type | Description | --------- | --------- | | K8 | Kindergarten through 8th grade | | HighSchool | Grades 9 through 12. | | Freshman | College or university freshman. | | Sophomore | College or university sophomore. | | Junior | College or university junior. | | Senior | College or university senior. | | GraduateSchool | Graduate school student. | | PostGraduateSchool | Post-graduate school student. | | Unknown | Education Level is not known, or not specified. |", "enum": [ "K8", "HighSchool", "Freshman", "Sophomore", "Junior", "Senior", "GraduateSchool", "PostGraduateSchool", "Unknown" ] }, "externalId": { "type": "string", "description": "An optional externally-defined unique ID for the user. Defaults to the userName. Formerly known as 'batchUid'." }, "gender": { "type": "string", "description": "The gender of this user. | Type | Description | --------- | --------- | | Female | Female | | Male | Male | | Unknown | Gender is not known, or not specified. |", "enum": [ "Female", "Male", "Unknown" ] }, "institutionRoleIds": { "type": "array", "items": { "type": "string" }, "description": "The primary and secondary institution roles assigned to this user. The primary institution role is the first item in the list, followed by all secondary institution roles sorted alphabetically. **Since**: 3300.3.0" }, "job": { "type": "object", "description": "The user's job information.", "properties": { "title": { "type": "string", "description": "The user's job title." }, "department": { "type": "string", "description": "The department the user belongs to." }, "company": { "type": "string", "description": "The company the user works for." } } }, "locale": { "type": "object", "description": "The user's localization settings.", "properties": { "id": { "type": "string", "description": "The locale specified by the user. This locale will be used anywhere the user is allowed to customize their locale; courses may force a specific locale, overriding the user's locale preference." }, "calendar": { "type": "string", "description": "The calendar type specified by the user. | Type | Description | --------- | --------- | | Gregorian | Gregorian | | GregorianHijri | Gregorian & Hijri | | Hijri | Hijri | | HijriGregorian | Hijri & Gregorian |", "enum": [ "Gregorian", "GregorianHijri", "Hijri", "HijriGregorian" ] }, "firstDayOfWeek": { "type": "string", "description": "The user's preferred first day of the week. | Type | Description | --------- | --------- | | Sunday | Sunday | | Monday | Monday | | Saturday | Saturday |", "enum": [ "Sunday", "Monday", "Saturday" ] } } }, "name": { "type": "object", "description": "Properties used to build the user's display name.", "properties": { "given": { "type": "string", "description": "The given (first) name of this user." }, "family": { "type": "string", "description": "The family (last) name of this user." }, "middle": { "type": "string", "description": "The middle name of this user." }, "other": { "type": "string", "description": "The other name (nickname) of this user." }, "suffix": { "type": "string", "description": "The suffix of this user's name. Examples: Jr., III, PhD." }, "title": { "type": "string", "description": "The title of this user. Examples: Mr., Ms., Dr." } } }, "password": { "type": "string", "description": "The user's login password." }, "studentId": { "type": "string", "description": "The user's student ID name or number as defined by the school or institution." }, "systemRoleIds": { "type": "array", "items": { "type": "string", "enum": [ "SystemAdmin", "SystemSupport", "CourseCreator", "CourseSupport", "AccountAdmin", "Guest", "User", "Observer", "Integration", "Portal" ] }, "description": "The system roles (the administrative user roles in the UI) for this user. The first role in this list is the user's primary system role, while the remaining are secondary system roles." }, "userName": { "type": "string", "description": "The userName property, shown in the UI." } }, "required": [ "PCID", "userId" ] } ``` *** ## blackboard\_users\_post\_learn\_api\_public\_datasources Create Data Source **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `description` | string | No | — | The description of the data source. | | `externalId` | string | Yes | — | An externally-defined unique ID for the data source. Formerly known as 'batchUid'. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "description": { "type": "string", "description": "The description of the data source." }, "externalId": { "type": "string", "description": "An externally-defined unique ID for the data source. Formerly known as 'batchUid'." } }, "required": [ "PCID", "externalId" ] } ``` *** ## blackboard\_users\_post\_learn\_api\_public\_oauth2\_token Request Token **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `grant_type` | string | No | — | The Grant Type. Acceptable values include: 'client\_credentials', 'authorization\_code' (since 3200.7.0), or 'refresh\_token' (since 3200.7.0). | | `code` | string | No | — | The authorization code granted by an end user for use by an application in Oauth2 Authorization Code Workflow | | `redirect_uri` | string | No | — | The redirectUri to send the end user to once an access token response is made in Oauth2 Authorization Code Workflow **Since**: 3200.7.0 | | `refresh_token` | string | No | — | The refresh token granted for use by an application in Oauth2 Refresh Token Workflow **Since**: 3200.7.0 | | `code_verifier` | string | No | — | The code\_verifier to be passed along with authorization code if PKCE standard was used to grant the authorization code. **Since**: 3700.4.0 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "grant_type": { "type": "string", "description": "The Grant Type. Acceptable values include: 'client_credentials', 'authorization_code' (since 3200.7.0), or 'refresh_token' (since 3200.7.0).", "enum": [ "client_credentials", "authorization_code", "refresh_token" ] }, "code": { "type": "string", "description": "The authorization code granted by an end user for use by an application in Oauth2 Authorization Code Workflow" }, "redirect_uri": { "type": "string", "description": "The redirectUri to send the end user to once an access token response is made in Oauth2 Authorization Code Workflow **Since**: 3200.7.0" }, "refresh_token": { "type": "string", "description": "The refresh token granted for use by an application in Oauth2 Refresh Token Workflow **Since**: 3200.7.0" }, "code_verifier": { "type": "string", "description": "The code_verifier to be passed along with authorization code if PKCE standard was used to grant the authorization code. **Since**: 3700.4.0" } }, "required": [ "PCID" ] } ``` *** ## blackboard\_users\_post\_learn\_api\_public\_users Create User **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `address` | object | No | — | The user's mailing address. | | `availability` | object | No | — | Settings controlling availability of the user account. | | `avatar` | object | No | — | The user's avatar metadata **Since**: 3800.13.0 | | `birthDate` | string | No | — | The birth date of this user. Only the date portion of this value has significance, since a person's birthdate represents a full day and not a moment in time. Take care to ignore the zeroed time portion when deserializing this value to ensure it's not converted to the previous calendar day if your local time zone has a negative UTC offset. | | `contact` | object | No | — | The user's contact information. | | `dataSourceId` | string | No | — | The ID of the data source associated with this user. This may optionally be the data source's externalId using the syntax "externalId:math101". | | `educationLevel` | string | No | — | The education level of this user. \| Type \| Description \| --------- \| --------- \| \| K8 \| Kindergarten through 8th grade \| \| HighSchool \| Grades 9 through 12. \| \| Freshman \| College or university freshman. \| \| Sophomore \| College or university sophomore. \| \| Junior \| College or university junior. \| \| Senior \| College or university senior. \| \| GraduateSchool \| Graduate school student. \| \| PostGraduateSchool \| Post-graduate school student. \| \| Unknown \| Education Level is not known, or not specified. \| | | `externalId` | string | No | — | An optional externally-defined unique ID for the user. Defaults to the userName. Formerly known as 'batchUid'. | | `gender` | string | No | — | The gender of this user. \| Type \| Description \| --------- \| --------- \| \| Female \| Female \| \| Male \| Male \| \| Unknown \| Gender is not known, or not specified. \| | | `institutionRoleIds` | string\[] | No | — | The primary and secondary institution roles assigned to this user. The primary institution role is the first item in the list, followed by all secondary institution roles sorted alphabetically. **Since**: 3300.3.0 | | `job` | object | No | — | The user's job information. | | `locale` | object | No | — | The user's localization settings. | | `name` | object | Yes | — | Properties used to build the user's display name. | | `password` | string | Yes | — | The user's login password. | | `studentId` | string | No | — | The user's student ID name or number as defined by the school or institution. | | `systemRoleIds` | string\[] | No | — | The system roles (the administrative user roles in the UI) for this user. The first role in this list is the user's primary system role, while the remaining are secondary system roles. | | `userName` | string | Yes | — | The userName property, shown in the UI. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "address": { "type": "object", "description": "The user's mailing address.", "properties": { "street1": { "type": "string", "description": "The street address of the user." }, "street2": { "type": "string", "description": "An additional field to store the street address of the user." }, "city": { "type": "string", "description": "The city the user resides in." }, "state": { "type": "string", "description": "The state or province the user resides in." }, "zipCode": { "type": "string", "description": "The zip code or postal code the user resides in." }, "country": { "type": "string", "description": "The country the user resides in." } } }, "availability": { "type": "object", "description": "Settings controlling availability of the user account.", "properties": { "available": { "type": "string", "description": "Whether the user is available within the system. Unavailable users cannot log in. | Type | Description | --------- | --------- | | Yes | | | No | | | Disabled | **Since**: 3100.0.0 |", "enum": [ "Yes", "No", "Disabled" ] } } }, "avatar": { "type": "object", "description": "The user's avatar metadata **Since**: 3800.13.0", "properties": { "source": { "type": "string", "description": "The source of the user's avatar **Since**: 3800.13.0 | Type | Description | --------- | --------- | | Default | The server default avatar | | User | The user set his/her own avatar | | System | A privileged user set the user's avatar to something other than default |", "enum": [ "Default", "User", "System" ] }, "uploadId": { "type": "string", "description": "The upload id of the avatar image file **Since**: 3800.13.0" } } }, "birthDate": { "type": "string", "description": "The birth date of this user. Only the date portion of this value has significance, since a person's birthdate represents a full day and not a moment in time. Take care to ignore the zeroed time portion when deserializing this value to ensure it's not converted to the previous calendar day if your local time zone has a negative UTC offset." }, "contact": { "type": "object", "description": "The user's contact information.", "properties": { "homePhone": { "type": "string", "description": "The user's home phone number." }, "mobilePhone": { "type": "string", "description": "The user's mobile phone number." }, "businessPhone": { "type": "string", "description": "The user's business phone number." }, "businessFax": { "type": "string", "description": "The user's business fax number." }, "email": { "type": "string", "description": "The user's email address." }, "institutionEmail": { "type": "string", "description": "The user's institutional email address. **Since**: 3900.19.0" }, "webPage": { "type": "string", "description": "The URL of the user's personal website." } } }, "dataSourceId": { "type": "string", "description": "The ID of the data source associated with this user. This may optionally be the data source's externalId using the syntax \"externalId:math101\"." }, "educationLevel": { "type": "string", "description": "The education level of this user. | Type | Description | --------- | --------- | | K8 | Kindergarten through 8th grade | | HighSchool | Grades 9 through 12. | | Freshman | College or university freshman. | | Sophomore | College or university sophomore. | | Junior | College or university junior. | | Senior | College or university senior. | | GraduateSchool | Graduate school student. | | PostGraduateSchool | Post-graduate school student. | | Unknown | Education Level is not known, or not specified. |", "enum": [ "K8", "HighSchool", "Freshman", "Sophomore", "Junior", "Senior", "GraduateSchool", "PostGraduateSchool", "Unknown" ] }, "externalId": { "type": "string", "description": "An optional externally-defined unique ID for the user. Defaults to the userName. Formerly known as 'batchUid'." }, "gender": { "type": "string", "description": "The gender of this user. | Type | Description | --------- | --------- | | Female | Female | | Male | Male | | Unknown | Gender is not known, or not specified. |", "enum": [ "Female", "Male", "Unknown" ] }, "institutionRoleIds": { "type": "array", "items": { "type": "string" }, "description": "The primary and secondary institution roles assigned to this user. The primary institution role is the first item in the list, followed by all secondary institution roles sorted alphabetically. **Since**: 3300.3.0" }, "job": { "type": "object", "description": "The user's job information.", "properties": { "title": { "type": "string", "description": "The user's job title." }, "department": { "type": "string", "description": "The department the user belongs to." }, "company": { "type": "string", "description": "The company the user works for." } } }, "locale": { "type": "object", "description": "The user's localization settings.", "properties": { "id": { "type": "string", "description": "The locale specified by the user. This locale will be used anywhere the user is allowed to customize their locale; courses may force a specific locale, overriding the user's locale preference." }, "calendar": { "type": "string", "description": "The calendar type specified by the user. | Type | Description | --------- | --------- | | Gregorian | Gregorian | | GregorianHijri | Gregorian & Hijri | | Hijri | Hijri | | HijriGregorian | Hijri & Gregorian |", "enum": [ "Gregorian", "GregorianHijri", "Hijri", "HijriGregorian" ] }, "firstDayOfWeek": { "type": "string", "description": "The user's preferred first day of the week. | Type | Description | --------- | --------- | | Sunday | Sunday | | Monday | Monday | | Saturday | Saturday |", "enum": [ "Sunday", "Monday", "Saturday" ] } } }, "name": { "type": "object", "description": "Properties used to build the user's display name.", "properties": { "given": { "type": "string", "description": "The given (first) name of this user." }, "family": { "type": "string", "description": "The family (last) name of this user." }, "middle": { "type": "string", "description": "The middle name of this user." }, "other": { "type": "string", "description": "The other name (nickname) of this user." }, "suffix": { "type": "string", "description": "The suffix of this user's name. Examples: Jr., III, PhD." }, "title": { "type": "string", "description": "The title of this user. Examples: Mr., Ms., Dr." } }, "required": [ "family", "given" ] }, "password": { "type": "string", "description": "The user's login password." }, "studentId": { "type": "string", "description": "The user's student ID name or number as defined by the school or institution." }, "systemRoleIds": { "type": "array", "items": { "type": "string", "enum": [ "SystemAdmin", "SystemSupport", "CourseCreator", "CourseSupport", "AccountAdmin", "Guest", "User", "Observer", "Integration", "Portal" ] }, "description": "The system roles (the administrative user roles in the UI) for this user. The first role in this list is the user's primary system role, while the remaining are secondary system roles." }, "userName": { "type": "string", "description": "The userName property, shown in the UI." } }, "required": [ "PCID", "name", "password", "userName" ] } ``` *** ## blackboard\_users\_put\_learn\_api\_public\_users\_by\_userid\_observers\_by\_observerid Create Observer **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `userId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `observerId` | string | Yes | — | The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| **Since**: 3500.5.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "observerId": { "type": "string", "description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 | **Since**: 3500.5.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "userId", "observerId" ] } ``` # bluesky Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/bluesky Bluesky Social **Server path:** `/bluesky` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`bluesky_create_record`](#bluesky_create_record) | Create a record in a user's repository (post, like, follow, repost, block) | | [`bluesky_delete_record`](#bluesky_delete_record) | Delete a record from a user's repository (unlike, unfollow, unblock, delete post/repost) | | [`bluesky_get_author_feed`](#bluesky_get_author_feed) | Get posts by a specific user | | [`bluesky_get_blocks`](#bluesky_get_blocks) | Get the authenticated user's block list | | [`bluesky_get_followers`](#bluesky_get_followers) | Get a user's followers | | [`bluesky_get_follows`](#bluesky_get_follows) | Get the accounts a user follows | | [`bluesky_get_likes`](#bluesky_get_likes) | Get the list of users who liked a post | | [`bluesky_get_post_thread`](#bluesky_get_post_thread) | Get a post and its reply thread | | [`bluesky_get_profile`](#bluesky_get_profile) | Get a user's profile by handle or DID | | [`bluesky_get_timeline`](#bluesky_get_timeline) | Get the authenticated user's home timeline | | [`bluesky_get_unread_count`](#bluesky_get_unread_count) | Get the count of unread notifications | | [`bluesky_list_notifications`](#bluesky_list_notifications) | List the authenticated user's notifications | | [`bluesky_mute_actor`](#bluesky_mute_actor) | Mute a user | | [`bluesky_search_actors`](#bluesky_search_actors) | Search for Bluesky users by name or handle | | [`bluesky_search_posts`](#bluesky_search_posts) | Search for posts on Bluesky | | [`bluesky_unmute_actor`](#bluesky_unmute_actor) | Unmute a user | | [`bluesky_update_seen`](#bluesky_update_seen) | Mark notifications as seen up to a timestamp | *** ## bluesky\_create\_record Create a record in a user's repository (post, like, follow, repost, block) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `collection` | string | Yes | — | The NSID of the record collection. Common values: app.bsky.feed.post (posts), app.bsky.feed.like (likes), app.bsky.feed.repost (reposts), app.bsky.graph.follow (follows), app.bsky.graph.block (blocks). | | `record` | object | Yes | — | The record to create. Must include \$type matching the collection. Structure depends on the collection type — see the tool description for examples of each record type. | | `repo` | string | Yes | — | The handle or DID of the authenticated user (the repo owner). Use the user's own handle or DID. | | `rkey` | string | No | — | Record key (TID). Omit to auto-generate. | | `validate` | boolean | No | — | Whether to validate the record against its lexicon schema | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "collection": { "type": "string", "description": "The NSID of the record collection. Common values: app.bsky.feed.post (posts), app.bsky.feed.like (likes), app.bsky.feed.repost (reposts), app.bsky.graph.follow (follows), app.bsky.graph.block (blocks)." }, "record": { "type": "object", "description": "The record to create. Must include $type matching the collection. Structure depends on the collection type — see the tool description for examples of each record type." }, "repo": { "type": "string", "description": "The handle or DID of the authenticated user (the repo owner). Use the user's own handle or DID." }, "rkey": { "type": "string", "description": "Record key (TID). Omit to auto-generate." }, "validate": { "type": "boolean", "description": "Whether to validate the record against its lexicon schema" } }, "required": [ "PCID", "collection", "record", "repo" ] } ``` *** ## bluesky\_delete\_record Delete a record from a user's repository (unlike, unfollow, unblock, delete post/repost) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `collection` | string | Yes | — | The NSID of the record collection. Common values: app.bsky.feed.post (delete post), app.bsky.feed.like (unlike), app.bsky.feed.repost (unrepost), app.bsky.graph.follow (unfollow), app.bsky.graph.block (unblock). | | `repo` | string | Yes | — | The handle or DID of the authenticated user (the repo owner) | | `rkey` | string | Yes | — | The record key (TID) to delete — the last segment of the record's AT-URI | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "collection": { "type": "string", "description": "The NSID of the record collection. Common values: app.bsky.feed.post (delete post), app.bsky.feed.like (unlike), app.bsky.feed.repost (unrepost), app.bsky.graph.follow (unfollow), app.bsky.graph.block (unblock)." }, "repo": { "type": "string", "description": "The handle or DID of the authenticated user (the repo owner)" }, "rkey": { "type": "string", "description": "The record key (TID) to delete — the last segment of the record's AT-URI" } }, "required": [ "PCID", "collection", "repo", "rkey" ] } ``` *** ## bluesky\_get\_author\_feed Get posts by a specific user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `actor` | string | Yes | — | Bluesky handle or DID of the author | | `limit` | integer | No | — | Maximum number of posts (1-100, default 50) | | `cursor` | string | No | — | Pagination cursor from a previous response | | `filter` | string | No | — | Filter type for the feed | | `includePins` | boolean | No | — | Whether to include pinned posts | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "actor": { "type": "string", "description": "Bluesky handle or DID of the author" }, "limit": { "type": "integer", "description": "Maximum number of posts (1-100, default 50)" }, "cursor": { "type": "string", "description": "Pagination cursor from a previous response" }, "filter": { "type": "string", "description": "Filter type for the feed", "enum": [ "posts_with_replies", "posts_no_replies", "posts_with_media", "posts_and_author_threads", "posts_with_video" ] }, "includePins": { "type": "boolean", "description": "Whether to include pinned posts" } }, "required": [ "PCID", "actor" ] } ``` *** ## bluesky\_get\_blocks Get the authenticated user's block list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Maximum number of results (1-100, default 50) | | `cursor` | string | No | — | Pagination cursor from a previous response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Maximum number of results (1-100, default 50)" }, "cursor": { "type": "string", "description": "Pagination cursor from a previous response" } }, "required": [ "PCID" ] } ``` *** ## bluesky\_get\_followers Get a user's followers **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `actor` | string | Yes | — | Bluesky handle or DID of the user | | `limit` | integer | No | — | Maximum number of results (1-100, default 50) | | `cursor` | string | No | — | Pagination cursor from a previous response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "actor": { "type": "string", "description": "Bluesky handle or DID of the user" }, "limit": { "type": "integer", "description": "Maximum number of results (1-100, default 50)" }, "cursor": { "type": "string", "description": "Pagination cursor from a previous response" } }, "required": [ "PCID", "actor" ] } ``` *** ## bluesky\_get\_follows Get the accounts a user follows **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `actor` | string | Yes | — | Bluesky handle or DID of the user | | `limit` | integer | No | — | Maximum number of results (1-100, default 50) | | `cursor` | string | No | — | Pagination cursor from a previous response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "actor": { "type": "string", "description": "Bluesky handle or DID of the user" }, "limit": { "type": "integer", "description": "Maximum number of results (1-100, default 50)" }, "cursor": { "type": "string", "description": "Pagination cursor from a previous response" } }, "required": [ "PCID", "actor" ] } ``` *** ## bluesky\_get\_likes Get the list of users who liked a post **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uri` | string | Yes | — | AT-URI of the post to get likes for | | `cid` | string | No | — | CID of a specific version of the post | | `limit` | integer | No | — | Maximum number of results (1-100, default 50) | | `cursor` | string | No | — | Pagination cursor from a previous response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uri": { "type": "string", "description": "AT-URI of the post to get likes for" }, "cid": { "type": "string", "description": "CID of a specific version of the post" }, "limit": { "type": "integer", "description": "Maximum number of results (1-100, default 50)" }, "cursor": { "type": "string", "description": "Pagination cursor from a previous response" } }, "required": [ "PCID", "uri" ] } ``` *** ## bluesky\_get\_post\_thread Get a post and its reply thread **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uri` | string | Yes | — | AT-URI of the post (e.g. at://did:plc:abc123/app.bsky.feed.post/3abc123) | | `depth` | integer | No | — | Number of reply levels to include (0-1000, default 6) | | `parentHeight` | integer | No | — | Number of parent/ancestor levels to include (0-1000, default 80) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uri": { "type": "string", "description": "AT-URI of the post (e.g. at://did:plc:abc123/app.bsky.feed.post/3abc123)" }, "depth": { "type": "integer", "description": "Number of reply levels to include (0-1000, default 6)" }, "parentHeight": { "type": "integer", "description": "Number of parent/ancestor levels to include (0-1000, default 80)" } }, "required": [ "PCID", "uri" ] } ``` *** ## bluesky\_get\_profile Get a user's profile by handle or DID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `actor` | string | Yes | — | Bluesky handle (e.g. alice.bsky.social) or DID (e.g. did:plc:abc123) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "actor": { "type": "string", "description": "Bluesky handle (e.g. alice.bsky.social) or DID (e.g. did:plc:abc123)" } }, "required": [ "PCID", "actor" ] } ``` *** ## bluesky\_get\_timeline Get the authenticated user's home timeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `algorithm` | string | No | — | Algorithm variant for timeline composition (implementation-specific) | | `limit` | integer | No | — | Maximum number of posts (1-100, default 50) | | `cursor` | string | No | — | Pagination cursor from a previous response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "algorithm": { "type": "string", "description": "Algorithm variant for timeline composition (implementation-specific)" }, "limit": { "type": "integer", "description": "Maximum number of posts (1-100, default 50)" }, "cursor": { "type": "string", "description": "Pagination cursor from a previous response" } }, "required": [ "PCID" ] } ``` *** ## bluesky\_get\_unread\_count Get the count of unread notifications **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `priority` | boolean | No | — | Count only priority notifications | | `seenAt` | string | No | — | Override seen-at timestamp for unread calculation (ISO 8601) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "priority": { "type": "boolean", "description": "Count only priority notifications" }, "seenAt": { "type": "string", "description": "Override seen-at timestamp for unread calculation (ISO 8601)" } }, "required": [ "PCID" ] } ``` *** ## bluesky\_list\_notifications List the authenticated user's notifications **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Maximum number of notifications (1-100, default 50) | | `cursor` | string | No | — | Pagination cursor from a previous response | | `seenAt` | string | No | — | Timestamp to compare for read/unread status (ISO 8601) | | `priority` | boolean | No | — | Filter to priority notifications only | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Maximum number of notifications (1-100, default 50)" }, "cursor": { "type": "string", "description": "Pagination cursor from a previous response" }, "seenAt": { "type": "string", "description": "Timestamp to compare for read/unread status (ISO 8601)" }, "priority": { "type": "boolean", "description": "Filter to priority notifications only" } }, "required": [ "PCID" ] } ``` *** ## bluesky\_mute\_actor Mute a user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `actor` | string | Yes | — | Bluesky handle or DID of the account to mute | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "actor": { "type": "string", "description": "Bluesky handle or DID of the account to mute" } }, "required": [ "PCID", "actor" ] } ``` *** ## bluesky\_search\_actors Search for Bluesky users by name or handle **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `q` | string | Yes | — | Search query string. Lucene syntax supported. | | `limit` | integer | No | — | Maximum number of results (1-100, default 25) | | `cursor` | string | No | — | Pagination cursor from a previous response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "q": { "type": "string", "description": "Search query string. Lucene syntax supported." }, "limit": { "type": "integer", "description": "Maximum number of results (1-100, default 25)" }, "cursor": { "type": "string", "description": "Pagination cursor from a previous response" } }, "required": [ "PCID", "q" ] } ``` *** ## bluesky\_search\_posts Search for posts on Bluesky **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `q` | string | Yes | — | Search query string. Lucene syntax supported. | | `sort` | string | No | — | Sort order for results | | `since` | string | No | — | Filter posts after this datetime (ISO 8601) or date (YYYY-MM-DD) | | `until` | string | No | — | Filter posts before this datetime (ISO 8601) or date (YYYY-MM-DD) | | `author` | string | No | — | Filter to posts by this author (handle or DID) | | `mentions` | string | No | — | Filter to posts mentioning this account (handle or DID) | | `lang` | string | No | — | Filter by language (BCP-47 code, e.g. 'en') | | `domain` | string | No | — | Filter to posts linking to this hostname | | `url` | string | No | — | Filter to posts linking to this specific URL | | `tag` | string\[] | No | — | Filter by hashtag (without # prefix). Multiple tags use AND logic. | | `limit` | integer | No | — | Maximum number of results (1-100, default 25) | | `cursor` | string | No | — | Pagination cursor from a previous response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "q": { "type": "string", "description": "Search query string. Lucene syntax supported." }, "sort": { "type": "string", "description": "Sort order for results", "enum": [ "top", "latest" ] }, "since": { "type": "string", "description": "Filter posts after this datetime (ISO 8601) or date (YYYY-MM-DD)" }, "until": { "type": "string", "description": "Filter posts before this datetime (ISO 8601) or date (YYYY-MM-DD)" }, "author": { "type": "string", "description": "Filter to posts by this author (handle or DID)" }, "mentions": { "type": "string", "description": "Filter to posts mentioning this account (handle or DID)" }, "lang": { "type": "string", "description": "Filter by language (BCP-47 code, e.g. 'en')" }, "domain": { "type": "string", "description": "Filter to posts linking to this hostname" }, "url": { "type": "string", "description": "Filter to posts linking to this specific URL" }, "tag": { "type": "array", "items": { "type": "string" }, "description": "Filter by hashtag (without # prefix). Multiple tags use AND logic." }, "limit": { "type": "integer", "description": "Maximum number of results (1-100, default 25)" }, "cursor": { "type": "string", "description": "Pagination cursor from a previous response" } }, "required": [ "PCID", "q" ] } ``` *** ## bluesky\_unmute\_actor Unmute a user **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `actor` | string | Yes | — | Bluesky handle or DID of the account to unmute | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "actor": { "type": "string", "description": "Bluesky handle or DID of the account to unmute" } }, "required": [ "PCID", "actor" ] } ``` *** ## bluesky\_update\_seen Mark notifications as seen up to a timestamp **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `seenAt` | string | Yes | — | ISO 8601 datetime marking notifications as seen up to this point | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "seenAt": { "type": "string", "description": "ISO 8601 datetime marking notifications as seen up to this point" } }, "required": [ "PCID", "seenAt" ] } ``` # box Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/box Files, folders, and collaborations **Server path:** `/box` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`box_create_folder`](#box_create_folder) | Create a new folder within a specified parent folder | | [`box_delete_file`](#box_delete_file) | Delete a file from Box by its ID | | [`box_delete_folder`](#box_delete_folder) | Delete a folder from Box by its ID | | [`box_get_file_info`](#box_get_file_info) | Retrieve file metadata and information about a file using its ID | | [`box_get_folder_info`](#box_get_folder_info) | Retrieve information about a folder using its ID | | [`box_get_user_info`](#box_get_user_info) | Get information about the current authenticated user | | [`box_list_folder_items`](#box_list_folder_items) | List items (files and folders) in a specified folder | | [`box_move_folder`](#box_move_folder) | Move a folder to a different parent folder | | [`box_search`](#box_search) | Search for files, folders, and web links across Box content with advanced filtering options. If no query is provided, returns all items from root folder | | [`box_search_folders`](#box_search_folders) | Search for folders that contain the specified query in their name. If no query is provided, returns all folders from root folder | | [`box_upload_file`](#box_upload_file) | Upload a file to Box from a URL. | *** ## box\_create\_folder Create a new folder within a specified parent folder **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | Yes | — | Name of the folder to create | | `parentId` | string | Yes | — | ID of the parent folder (use "0" for root folder) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" }, "name": { "type": "string", "description": "Name of the folder to create" }, "parentId": { "type": "string", "description": "ID of the parent folder (use \"0\" for root folder)" } }, "required": [ "PCID", "name", "parentId" ] } ``` *** ## box\_delete\_file Delete a file from Box by its ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fileId` | string | Yes | — | The unique identifier of the file to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" }, "fileId": { "type": "string", "description": "The unique identifier of the file to delete" } }, "required": [ "PCID", "fileId" ] } ``` *** ## box\_delete\_folder Delete a folder from Box by its ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | string | Yes | — | The unique identifier of the folder to delete | | `recursive` | boolean | No | `false` | Whether to delete folder contents recursively | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" }, "folderId": { "type": "string", "description": "The unique identifier of the folder to delete" }, "recursive": { "type": "boolean", "default": false, "description": "Whether to delete folder contents recursively" } }, "required": [ "PCID", "folderId" ] } ``` *** ## box\_get\_file\_info Retrieve file metadata and information about a file using its ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fileId` | string | Yes | — | The unique identifier of the file to retrieve information for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" }, "fileId": { "type": "string", "description": "The unique identifier of the file to retrieve information for" } }, "required": [ "PCID", "fileId" ] } ``` *** ## box\_get\_folder\_info Retrieve information about a folder using its ID **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | string | Yes | — | The unique identifier of the folder to retrieve information for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" }, "folderId": { "type": "string", "description": "The unique identifier of the folder to retrieve information for" } }, "required": [ "PCID", "folderId" ] } ``` *** ## box\_get\_user\_info Get information about the current authenticated user ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" } }, "required": [ "PCID" ] } ``` *** ## box\_list\_folder\_items List items (files and folders) in a specified folder **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | string | Yes | — | The unique identifier of the folder to list items from | | `limit` | number | No | — | Maximum number of items to return | | `offset` | number | No | — | Number of items to skip for pagination | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" }, "folderId": { "type": "string", "description": "The unique identifier of the folder to list items from" }, "limit": { "type": "number", "description": "Maximum number of items to return" }, "offset": { "type": "number", "description": "Number of items to skip for pagination" } }, "required": [ "PCID", "folderId" ] } ``` *** ## box\_move\_folder Move a folder to a different parent folder **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | string | Yes | — | The unique identifier of the folder to move | | `newParentId` | string | Yes | — | ID of the new parent folder | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" }, "folderId": { "type": "string", "description": "The unique identifier of the folder to move" }, "newParentId": { "type": "string", "description": "ID of the new parent folder" } }, "required": [ "PCID", "folderId", "newParentId" ] } ``` *** ## box\_search Search for files, folders, and web links across Box content with advanced filtering options. If no query is provided, returns all items from root folder **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `query` | string | No | — | Search query string to find items. If not provided, returns all items | | `type` | string | No | — | Filter search results by item type | | `limit` | number | No | — | Maximum number of results to return | | `offset` | number | No | — | Number of results to skip for pagination | | `ancestor_folder_ids` | string\[] | No | — | Limit results to items in specified folders and subfolders | | `file_extensions` | string\[] | No | — | Filter by file extension | | `content_types` | string\[] | No | — | Filter by specific content fields | | `created_at_range` | string | No | — | Limit results by creation date range | | `updated_at_range` | string | No | — | Limit results by update date range | | `size_range` | string | No | — | Filter by file size range | | `owner_user_ids` | string\[] | No | — | Limit results by owners | | `recent_updater_user_ids` | string\[] | No | — | Filter by users who updated items | | `trash_content` | string | No | — | Determine whether to search in trash | | `mdfilters` | string | No | — | Filter results based on metadata | | `sort` | string | No | — | Order results by relevance or modification date | | `direction` | string | No | — | Specify result order direction | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" }, "query": { "type": "string", "description": "Search query string to find items. If not provided, returns all items" }, "type": { "type": "string", "enum": [ "file", "folder", "web_link" ], "description": "Filter search results by item type" }, "limit": { "type": "number", "description": "Maximum number of results to return" }, "offset": { "type": "number", "description": "Number of results to skip for pagination" }, "ancestor_folder_ids": { "type": "array", "items": { "type": "string" }, "description": "Limit results to items in specified folders and subfolders" }, "file_extensions": { "type": "array", "items": { "type": "string" }, "description": "Filter by file extension" }, "content_types": { "type": "array", "items": { "type": "string" }, "description": "Filter by specific content fields" }, "created_at_range": { "type": "string", "description": "Limit results by creation date range" }, "updated_at_range": { "type": "string", "description": "Limit results by update date range" }, "size_range": { "type": "string", "description": "Filter by file size range" }, "owner_user_ids": { "type": "array", "items": { "type": "string" }, "description": "Limit results by owners" }, "recent_updater_user_ids": { "type": "array", "items": { "type": "string" }, "description": "Filter by users who updated items" }, "trash_content": { "type": "string", "description": "Determine whether to search in trash" }, "mdfilters": { "type": "string", "description": "Filter results based on metadata" }, "sort": { "type": "string", "description": "Order results by relevance or modification date" }, "direction": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "Specify result order direction" } }, "required": [ "PCID" ] } ``` *** ## box\_search\_folders Search for folders that contain the specified query in their name. If no query is provided, returns all folders from root folder **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `query` | string | No | — | Search query to find folders by name. If not provided, returns all folders | | `limit` | number | No | — | Maximum number of folder results to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" }, "query": { "type": "string", "description": "Search query to find folders by name. If not provided, returns all folders" }, "limit": { "type": "number", "description": "Maximum number of folder results to return" } }, "required": [ "PCID" ] } ``` *** ## box\_upload\_file Upload a file to Box from a URL. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `fileUrl` | string | Yes | — | URL of the file to upload to Box | | `parentId` | string | Yes | — | ID of the parent folder (use "0" for root folder) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "The PinkConnect ID for authentication" }, "fileUrl": { "type": "string", "description": "URL of the file to upload to Box" }, "parentId": { "type": "string", "description": "ID of the parent folder (use \"0\" for root folder)" } }, "required": [ "PCID", "fileUrl", "parentId" ] } ``` # brevo Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/brevo Brevo API **PinkConnect service:** `brevo` | **Type:** Application (parent with child servers) | **PCID required:** Yes brevo is exposed as multiple MCP server IDs (one per area below). Each child server has its own server path and tool names. ## Child servers | Child server | Server path | Tools | Description | | - | - | - | - | | [brevo-contacts](/api-reference/mcp-servers/application/brevo/brevo-contacts) | `/brevo-contacts` | 41 | Brevo Contacts | | [brevo-crm](/api-reference/mcp-servers/application/brevo/brevo-crm) | `/brevo-crm` | 37 | Brevo CRM | | [brevo-ecommerce](/api-reference/mcp-servers/application/brevo/brevo-ecommerce) | `/brevo-ecommerce` | 26 | Brevo Ecommerce | | [brevo-email](/api-reference/mcp-servers/application/brevo/brevo-email) | `/brevo-email` | 46 | Brevo Email | | [brevo-loyalty](/api-reference/mcp-servers/application/brevo/brevo-loyalty) | `/brevo-loyalty` | 51 | Brevo Loyalty | | [brevo-messaging](/api-reference/mcp-servers/application/brevo/brevo-messaging) | `/brevo-messaging` | 36 | Brevo Messaging | | [brevo-settings](/api-reference/mcp-servers/application/brevo/brevo-settings) | `/brevo-settings` | 19 | Brevo Settings | # brevo-contacts Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/brevo/brevo-contacts Brevo Contacts **Server path:** `/brevo-contacts` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`brevo_contacts_add_contact_to_list`](#brevo_contacts_add_contact_to_list) | Add existing contacts to a list | | [`brevo_contacts_batch_delete_object_records`](#brevo_contacts_batch_delete_object_records) | Delete multiple object records (up to 1000) asynchronously | | [`brevo_contacts_create_attribute`](#brevo_contacts_create_attribute) | Create contact attribute | | [`brevo_contacts_create_batch_events`](#brevo_contacts_create_batch_events) | Create events in batch | | [`brevo_contacts_create_contact`](#brevo_contacts_create_contact) | Create a contact | | [`brevo_contacts_create_doi_contact`](#brevo_contacts_create_doi_contact) | Create Contact via DOI (Double-Opt-In) Flow | | [`brevo_contacts_create_event`](#brevo_contacts_create_event) | Create an event | | [`brevo_contacts_create_folder`](#brevo_contacts_create_folder) | Create a folder | | [`brevo_contacts_create_list`](#brevo_contacts_create_list) | Create a list | | [`brevo_contacts_delete_attribute`](#brevo_contacts_delete_attribute) | Delete an attribute | | [`brevo_contacts_delete_contact`](#brevo_contacts_delete_contact) | Delete a contact | | [`brevo_contacts_delete_folder`](#brevo_contacts_delete_folder) | Delete a folder (and all its lists) | | [`brevo_contacts_delete_list`](#brevo_contacts_delete_list) | Delete a list | | [`brevo_contacts_delete_multi_attribute_options`](#brevo_contacts_delete_multi_attribute_options) | Delete a multiple-choice attribute option | | [`brevo_contacts_get_attributes`](#brevo_contacts_get_attributes) | List all attributes | | [`brevo_contacts_get_contact_info`](#brevo_contacts_get_contact_info) | Get a contact's details | | [`brevo_contacts_get_contact_stats`](#brevo_contacts_get_contact_stats) | Get email campaigns' statistics for a contact | | [`brevo_contacts_get_contacts`](#brevo_contacts_get_contacts) | Get all the contacts | | [`brevo_contacts_get_events`](#brevo_contacts_get_events) | Get events | | [`brevo_contacts_get_folder`](#brevo_contacts_get_folder) | Returns a folder's details | | [`brevo_contacts_get_folder_lists`](#brevo_contacts_get_folder_lists) | Get lists in a folder | | [`brevo_contacts_get_folders`](#brevo_contacts_get_folders) | Get all folders | | [`brevo_contacts_get_from_list`](#brevo_contacts_get_from_list) | Get contacts in a list | | [`brevo_contacts_get_list`](#brevo_contacts_get_list) | Get a list's details | | [`brevo_contacts_get_lists`](#brevo_contacts_get_lists) | Get all the lists | | [`brevo_contacts_get_segments`](#brevo_contacts_get_segments) | Get all the segments | | [`brevo_contacts_getrecords`](#brevo_contacts_getrecords) | Get the list of object records and total records count for an object. | | [`brevo_contacts_import_contacts`](#brevo_contacts_import_contacts) | Import contacts | | [`brevo_contacts_remove_contact_from_list`](#brevo_contacts_remove_contact_from_list) | Delete a contact from a list | | [`brevo_contacts_request_contact_export`](#brevo_contacts_request_contact_export) | Export contacts | | [`brevo_contacts_update_attribute`](#brevo_contacts_update_attribute) | Update contact attribute | | [`brevo_contacts_update_batch_contacts`](#brevo_contacts_update_batch_contacts) | Update multiple contacts | | [`brevo_contacts_update_contact`](#brevo_contacts_update_contact) | Update a contact | | [`brevo_contacts_update_folder`](#brevo_contacts_update_folder) | Update a folder | | [`brevo_contacts_update_list`](#brevo_contacts_update_list) | Update a list | | [`brevo_contacts_upsertrecords`](#brevo_contacts_upsertrecords) | Create/Update object records in bulk | | [`brevo-contacts_create_consent_group`](#brevo-contacts_create_consent_group) | Create a consent group | | [`brevo-contacts_delete_consent_group`](#brevo-contacts_delete_consent_group) | Delete a consent group | | [`brevo-contacts_get_consent_group`](#brevo-contacts_get_consent_group) | Get a consent group | | [`brevo-contacts_get_consent_groups`](#brevo-contacts_get_consent_groups) | List all consent groups | | [`brevo-contacts_update_consent_group`](#brevo-contacts_update_consent_group) | Update a consent group | *** ## brevo\_contacts\_add\_contact\_to\_list Add existing contacts to a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `listId` | integer | Yes | — | Id of the list | | `body` | object | Yes | — | Emails addresses OR IDs OR EXT\_ID attributes of the contacts | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "listId": { "type": "integer", "description": "Id of the list" }, "body": { "description": "Emails addresses OR IDs OR EXT_ID attributes of the contacts" } }, "required": [ "PCID", "listId", "body" ] } ``` *** ## brevo\_contacts\_batch\_delete\_object\_records Delete multiple object records (up to 1000) asynchronously **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object_type` | string | Yes | — | Object type for the records to delete | | `identifiers` | object | No | — | Either `ids` or `ext_ids` must be provided, but not both in the same request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object_type": { "type": "string", "description": "Object type for the records to delete" }, "identifiers": { "description": "Either `ids` or `ext_ids` must be provided, but not both in the same request." } }, "required": [ "PCID", "object_type" ] } ``` *** ## brevo\_contacts\_create\_attribute Create contact attribute **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attributeCategory` | string | Yes | — | Category of the attribute | | `attributeName` | string | Yes | — | Name of the attribute | | `enumeration` | object\[] | No | — | List of values and labels that the attribute can take. **Use only if the attribute's category is "category"**. None of the category options can exceed max 200 characters. For example: **\[\{"value":1, "label":"male"}, \{"value":2, "label":"female"}]** | | `isRecurring` | boolean | No | — | Type of the attribute. **Use only if the attribute's category is 'calculated' or 'global'** | | `multiCategoryOptions` | string\[] | No | — | List of options you want to add for multiple-choice attribute. **Use only if the attribute's category is "normal" and attribute's type is "multiple-choice". None of the multicategory options can exceed max 200 characters.** For example: **\["USA","INDIA"]** | | `type` | string | No | — | Type of the attribute. **Use only if the attribute's category is 'normal', 'category' or 'transactional'** Type **user and multiple-choice** is only available if the category is **normal** attribute Type **id** is only available if the category is **transactional** attribute Type **category** is only available if the category is **category** attribute | | `value` | string | No | — | Value of the attribute. **Use only if the attribute's category is 'calculated' or 'global'** | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributeCategory": { "type": "string", "description": "Category of the attribute", "enum": [ "normal", "transactional", "category", "calculated", "global" ] }, "attributeName": { "type": "string", "description": "Name of the attribute" }, "enumeration": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "Label of the value" }, "value": { "type": "integer", "description": "Id of the value" } }, "required": [ "label", "value" ] }, "description": "List of values and labels that the attribute can take. **Use only if the attribute's category is \"category\"**. None of the category options can exceed max 200 characters. For example: **[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]**" }, "isRecurring": { "type": "boolean", "description": "Type of the attribute. **Use only if the attribute's category is 'calculated' or 'global'**" }, "multiCategoryOptions": { "type": "array", "items": { "type": "string" }, "description": "List of options you want to add for multiple-choice attribute. **Use only if the attribute's category is \"normal\" and attribute's type is \"multiple-choice\". None of the multicategory options can exceed max 200 characters.** For example: **[\"USA\",\"INDIA\"]**" }, "type": { "type": "string", "description": "Type of the attribute. **Use only if the attribute's category is 'normal', 'category' or 'transactional'** Type **user and multiple-choice** is only available if the category is **normal** attribute Type **id** is only available if the category is **transactional** attribute Type **category** is only available if the category is **category** attribute", "enum": [ "text", "date", "float", "boolean", "id", "category", "multiple-choice", "user" ] }, "value": { "type": "string", "description": "Value of the attribute. **Use only if the attribute's category is 'calculated' or 'global'**" } }, "required": [ "PCID", "attributeCategory", "attributeName" ] } ``` *** ## brevo\_contacts\_create\_batch\_events Create events in batch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `events` | object\[] | Yes | — | The events value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "events": { "type": "array", "items": { "type": "object", "properties": { "contact_properties": { "type": "object", "description": "Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: **\"FIRSTNAME\": \"Jane\" , \"AGE\": 37**" }, "event_date": { "type": "string", "description": "Timestamp of when the event occurred (e.g. \"2024-01-24T17:39:57+01:00\"). If no value is passed, the timestamp of the event creation is used." }, "event_name": { "type": "string", "description": "The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters, alphanumerical characters and - _ only." }, "event_properties": { "type": "object", "description": "Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field type are supported: string, number, boolean (true/false), date (Timestamp e.g. \"2024-01-24T17:39:57+01:00\"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50Kb." }, "identifiers": { "type": "object", "description": "Identifies the contact associated with the event. At least one identifier is required." }, "object": { "type": "object", "description": "Identifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account." } }, "required": [ "event_name", "identifiers" ] }, "description": "The events value" } }, "required": [ "PCID", "events" ] } ``` *** ## brevo\_contacts\_create\_contact Create a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attributes` | object | No | — | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored. **These attributes must be present in your Brevo account**. For eg: **\{"FNAME":"Elly", "LNAME":"Roger", "COUNTRIES": \["India","China"]}** | | `email` | string | No | — | Email address of the user. **Mandatory if "ext\_id" & "SMS" field is not passed.** | | `emailBlacklisted` | boolean | No | — | Set this field to blacklist the contact for emails (emailBlacklisted = true) | | `ext_id` | string | No | — | Pass your own Id to create a contact. | | `forceMerge` | boolean | No | — | When true, if the contact being created shares an identifier (email, SMS, ext\_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent `last_modified` timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict. | | `getId` | boolean | No | — | When true, the response returns the `id` of the surviving contact after merge. | | `listIds` | integer\[] | No | — | Ids of the lists to add the contact to | | `smsBlacklisted` | boolean | No | — | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | | `smtpBlacklistSender` | string\[] | No | — | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | | `updateEnabled` | boolean | No | — | Facilitate to update the existing contact in the same request (updateEnabled = true) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributes": { "type": "object", "description": "Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored. **These attributes must be present in your Brevo account**. For eg: **{\"FNAME\":\"Elly\", \"LNAME\":\"Roger\", \"COUNTRIES\": [\"India\",\"China\"]}**" }, "email": { "type": "string", "description": "Email address of the user. **Mandatory if \"ext_id\" & \"SMS\" field is not passed.**" }, "emailBlacklisted": { "type": "boolean", "description": "Set this field to blacklist the contact for emails (emailBlacklisted = true)" }, "ext_id": { "type": "string", "description": "Pass your own Id to create a contact." }, "forceMerge": { "type": "boolean", "description": "When true, if the contact being created shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent `last_modified` timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict." }, "getId": { "type": "boolean", "description": "When true, the response returns the `id` of the surviving contact after merge." }, "listIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Ids of the lists to add the contact to" }, "smsBlacklisted": { "type": "boolean", "description": "Set this field to blacklist the contact for SMS (smsBlacklisted = true)" }, "smtpBlacklistSender": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )" }, "updateEnabled": { "type": "boolean", "description": "Facilitate to update the existing contact in the same request (updateEnabled = true)" } }, "required": [ "PCID" ] } ``` *** ## brevo\_contacts\_create\_doi\_contact Create Contact via DOI (Double-Opt-In) Flow **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attributes` | object | No | — | Pass the set of attributes and their values. **These attributes must be present in your Brevo account**. For eg. **\{'FNAME':'Elly', 'LNAME':'Roger', 'COUNTRIES': \['India','China']}** | | `email` | string | Yes | — | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. | | `excludeListIds` | integer\[] | No | — | Lists under user account where contact should not be added | | `includeListIds` | integer\[] | Yes | — | Lists under user account where contact should be added | | `redirectionUrl` | string | Yes | — | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag **\{\{ params.DOIurl }}**. | | `templateId` | integer | Yes | — | Id of the Double opt-in (DOI) template | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributes": { "type": "object", "description": "Pass the set of attributes and their values. **These attributes must be present in your Brevo account**. For eg. **{'FNAME':'Elly', 'LNAME':'Roger', 'COUNTRIES': ['India','China']}**" }, "email": { "type": "string", "description": "Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes." }, "excludeListIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Lists under user account where contact should not be added" }, "includeListIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Lists under user account where contact should be added" }, "redirectionUrl": { "type": "string", "description": "URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag **{{ params.DOIurl }}**." }, "templateId": { "type": "integer", "description": "Id of the Double opt-in (DOI) template" } }, "required": [ "PCID", "email", "includeListIds", "redirectionUrl", "templateId" ] } ``` *** ## brevo\_contacts\_create\_event Create an event **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contact_properties` | object | No | — | Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: **"FIRSTNAME": "Jane" , "AGE": 37** | | `event_date` | string | No | — | ISO 8601 timestamp of when the event occurred (e.g. "2024-01-24T17:39:57+01:00"). If no value is passed, the timestamp of the event creation is used. | | `event_name` | string | Yes | — | The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters; only alphanumeric characters, hyphens (-), and underscores (\_) are allowed. | | `event_properties` | object | No | — | Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field types are supported: string, number, boolean (true/false), date (Timestamp e.g. "2024-01-24T17:39:57+01:00"). Keys are limited to 255 characters, alphanumerical characters and - \_ only. Size is limited to 50KB. | | `identifiers` | object | Yes | — | Identifies the contact associated with the event. At least one identifier is required. | | `object` | object | No | — | Identifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contact_properties": { "type": "object", "description": "Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: **\"FIRSTNAME\": \"Jane\" , \"AGE\": 37**" }, "event_date": { "type": "string", "description": "ISO 8601 timestamp of when the event occurred (e.g. \"2024-01-24T17:39:57+01:00\"). If no value is passed, the timestamp of the event creation is used." }, "event_name": { "type": "string", "description": "The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters; only alphanumeric characters, hyphens (-), and underscores (_) are allowed." }, "event_properties": { "type": "object", "description": "Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field types are supported: string, number, boolean (true/false), date (Timestamp e.g. \"2024-01-24T17:39:57+01:00\"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50KB." }, "identifiers": { "type": "object", "description": "Identifies the contact associated with the event. At least one identifier is required.", "properties": { "contact_id": { "type": "integer", "description": "Internal unique contact ID. When present, this takes priority over all other identifiers for event attribution and contact resolution." }, "email_id": { "type": "string", "description": "Email Id associated with the event" }, "ext_id": { "type": "string", "description": "ext_id associated with the event" }, "landline_number_id": { "type": "string", "description": "landline_number associated with the event" }, "phone_id": { "type": "string", "description": "SMS associated with the event" }, "whatsapp_id": { "type": "string", "description": "whatsapp associated with the event" } } }, "object": { "type": "object", "description": "Identifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account.", "properties": { "identifiers": { "type": "object", "description": "Identifiers for the object." }, "type": { "type": "string", "description": "Type of object (e.g., subscription, vehicle, etc.)" } } } }, "required": [ "PCID", "event_name", "identifiers" ] } ``` *** ## brevo\_contacts\_create\_folder Create a folder **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `name` | string | No | — | Name of the folder | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Name of the folder" } }, "required": [ "PCID" ] } ``` *** ## brevo\_contacts\_create\_list Create a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | integer | Yes | — | Id of the parent folder in which this list is to be created | | `name` | string | Yes | — | Name of the list | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "folderId": { "type": "integer", "description": "Id of the parent folder in which this list is to be created" }, "name": { "type": "string", "description": "Name of the list" } }, "required": [ "PCID", "folderId", "name" ] } ``` *** ## brevo\_contacts\_delete\_attribute Delete an attribute **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attributeCategory` | string | Yes | — | Category of the attribute | | `attributeName` | string | Yes | — | Name of the existing attribute | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributeCategory": { "type": "string", "description": "Category of the attribute", "enum": [ "normal", "transactional", "category", "calculated", "global" ] }, "attributeName": { "type": "string", "description": "Name of the existing attribute" } }, "required": [ "PCID", "attributeCategory", "attributeName" ] } ``` *** ## brevo\_contacts\_delete\_contact Delete a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | object | Yes | — | Email (urlencoded) OR ID of the contact OR EXT\_ID attribute (urlencoded) | | `identifierType` | string | No | — | email\_id for Email, contact\_id for ID of the contact, ext\_id for EXT\_ID attribute, phone\_id for SMS attribute, whatsapp\_id for WHATSAPP attribute, landline\_number\_id for LANDLINE\_NUMBER attribute | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "description": "Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded)" }, "identifierType": { "type": "string", "description": "email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute", "enum": [ "email_id", "contact_id", "ext_id", "phone_id", "whatsapp_id", "landline_number_id" ] } }, "required": [ "PCID", "identifier" ] } ``` *** ## brevo\_contacts\_delete\_folder Delete a folder (and all its lists) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | integer | Yes | — | Id of the folder | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "folderId": { "type": "integer", "description": "Id of the folder" } }, "required": [ "PCID", "folderId" ] } ``` *** ## brevo\_contacts\_delete\_list Delete a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `listId` | integer | Yes | — | Id of the list | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "listId": { "type": "integer", "description": "Id of the list" } }, "required": [ "PCID", "listId" ] } ``` *** ## brevo\_contacts\_delete\_multi\_attribute\_options Delete a multiple-choice attribute option **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attributeType` | string | Yes | — | Type of the attribute | | `multipleChoiceAttribute` | string | Yes | — | Name of the existing multiple-choice attribute | | `multipleChoiceAttributeOption` | string | Yes | — | Name of the existing multiple-choice attribute option that you want to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributeType": { "type": "string", "description": "Type of the attribute", "enum": [ "multiple-choice" ] }, "multipleChoiceAttribute": { "type": "string", "description": "Name of the existing multiple-choice attribute" }, "multipleChoiceAttributeOption": { "type": "string", "description": "Name of the existing multiple-choice attribute option that you want to delete" } }, "required": [ "PCID", "attributeType", "multipleChoiceAttribute", "multipleChoiceAttributeOption" ] } ``` *** ## brevo\_contacts\_get\_attributes List all attributes ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_contacts\_get\_contact\_info Get a contact's details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | object | Yes | — | Email (urlencoded) OR ID of the contact OR its SMS attribute value OR EXT\_ID attribute (urlencoded) | | `identifierType` | string | No | — | email\_id for Email, phone\_id for SMS attribute, contact\_id for ID of the contact, ext\_id for EXT\_ID attribute, whatsapp\_id for WHATSAPP attribute, landline\_number\_id for LANDLINE\_NUMBER attribute | | `startDate` | string | No | — | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. | | `endDate` | string | No | — | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "description": "Email (urlencoded) OR ID of the contact OR its SMS attribute value OR EXT_ID attribute (urlencoded)" }, "identifierType": { "type": "string", "description": "email_id for Email, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute", "enum": [ "email_id", "phone_id", "contact_id", "ext_id", "whatsapp_id", "landline_number_id" ] }, "startDate": { "type": "string", "description": "**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date." }, "endDate": { "type": "string", "description": "**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date." } }, "required": [ "PCID", "identifier" ] } ``` *** ## brevo\_contacts\_get\_contact\_stats Get email campaigns' statistics for a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | object | Yes | — | Email (urlencoded) OR ID of the contact | | `startDate` | string | No | — | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. | | `endDate` | string | No | — | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. Maximum difference between startDate and endDate should not be greater than 90 days. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "description": "Email (urlencoded) OR ID of the contact" }, "startDate": { "type": "string", "description": "**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date." }, "endDate": { "type": "string", "description": "**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. Maximum difference between startDate and endDate should not be greater than 90 days." } }, "required": [ "PCID", "identifier" ] } ``` *** ## brevo\_contacts\_get\_contacts Get all the contacts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of documents per page | | `offset` | integer | No | — | Index of the first document of the page | | `modifiedSince` | string | No | — | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | | `createdSince` | string | No | — | Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | | `ids` | integer\[] | No | — | Filter by a list of contact IDs. You can pass a **maximum of 20 IDs**. All elements must be integers. | | `segmentId` | integer | No | — | Id of the segment. **Either listIds or segmentId can be passed.** Must be a positive integer (minimum value of 1). | | `listIds` | integer\[] | No | — | Ids of the list. **Either listIds or segmentId can be passed.** | | `filter` | string | No | — | Filter the contacts on the basis of attributes. **Allowed operator: equals. For multiple-choice options, the filter will apply an AND condition between the options. For category attributes, the filter will work with both id and value. (e.g. filter=equals(FIRSTNAME,"Antoine"), filter=equals(B1, true), filter=equals(DOB, "1989-11-23"), filter=equals(GENDER, "1"), filter=equals(GENDER, "MALE"), filter=equals(COUNTRY,"USA, INDIA")** | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "modifiedSince": { "type": "string", "description": "Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**" }, "createdSince": { "type": "string", "description": "Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] }, "ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Filter by a list of contact IDs. You can pass a **maximum of 20 IDs**. All elements must be integers." }, "segmentId": { "type": "integer", "description": "Id of the segment. **Either listIds or segmentId can be passed.** Must be a positive integer (minimum value of 1)." }, "listIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Ids of the list. **Either listIds or segmentId can be passed.**" }, "filter": { "type": "string", "description": "Filter the contacts on the basis of attributes. **Allowed operator: equals. For multiple-choice options, the filter will apply an AND condition between the options. For category attributes, the filter will work with both id and value. (e.g. filter=equals(FIRSTNAME,\"Antoine\"), filter=equals(B1, true), filter=equals(DOB, \"1989-11-23\"), filter=equals(GENDER, \"1\"), filter=equals(GENDER, \"MALE\"), filter=equals(COUNTRY,\"USA, INDIA\")**" } }, "required": [ "PCID" ] } ``` *** ## brevo\_contacts\_get\_events Get events **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contact_id` | integer\[] | No | — | Filter by contact ID (repeatable) | | `event_name` | string\[] | No | — | Filter by event name (repeatable) | | `object_type` | string\[] | No | — | Filter by object type (repeatable) | | `startDate` | string | No | — | Mandatory if endDate is used. Start of date range (YYYY-MM-DD or RFC3339). Defaults to 6 months ago when omitted alongside endDate. Must be ≤ endDate. | | `endDate` | string | No | — | Mandatory if startDate is used. End of date range (YYYY-MM-DD or RFC3339). Must be ≥ startDate. | | `limit` | integer | No | — | Max events to return. Default 100, min 1, max 10000. | | `offset` | integer | No | — | Events to skip for pagination. Default 0, min 0. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contact_id": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Filter by contact ID (repeatable)" }, "event_name": { "type": "array", "items": { "type": "string" }, "description": "Filter by event name (repeatable)" }, "object_type": { "type": "array", "items": { "type": "string" }, "description": "Filter by object type (repeatable)" }, "startDate": { "type": "string", "description": "Mandatory if endDate is used. Start of date range (YYYY-MM-DD or RFC3339). Defaults to 6 months ago when omitted alongside endDate. Must be ≤ endDate." }, "endDate": { "type": "string", "description": "Mandatory if startDate is used. End of date range (YYYY-MM-DD or RFC3339). Must be ≥ startDate." }, "limit": { "type": "integer", "description": "Max events to return. Default 100, min 1, max 10000." }, "offset": { "type": "integer", "description": "Events to skip for pagination. Default 0, min 0." } }, "required": [ "PCID" ] } ``` *** ## brevo\_contacts\_get\_folder Returns a folder's details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | integer | Yes | — | id of the folder | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "folderId": { "type": "integer", "description": "id of the folder" } }, "required": [ "PCID", "folderId" ] } ``` *** ## brevo\_contacts\_get\_folder\_lists Get lists in a folder **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | integer | Yes | — | Id of the folder | | `limit` | integer | No | — | Number of documents per page | | `offset` | integer | No | — | Index of the first document of the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "folderId": { "type": "integer", "description": "Id of the folder" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID", "folderId" ] } ``` *** ## brevo\_contacts\_get\_folders Get all folders **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of documents per page | | `offset` | integer | No | — | Index of the first document of the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_contacts\_get\_from\_list Get contacts in a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `listId` | integer | Yes | — | Id of the list | | `modifiedSince` | string | No | — | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | | `limit` | integer | No | — | Number of documents per page | | `offset` | integer | No | — | Index of the first document of the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "listId": { "type": "integer", "description": "Id of the list" }, "modifiedSince": { "type": "string", "description": "Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID", "listId" ] } ``` *** ## brevo\_contacts\_get\_list Get a list's details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `listId` | integer | Yes | — | Id of the list | | `startDate` | string | No | — | **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** | | `endDate` | string | No | — | **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "listId": { "type": "integer", "description": "Id of the list" }, "startDate": { "type": "string", "description": "**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result**" }, "endDate": { "type": "string", "description": "**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result**" } }, "required": [ "PCID", "listId" ] } ``` *** ## brevo\_contacts\_get\_lists Get all the lists **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of documents per page | | `offset` | integer | No | — | Index of the first document of the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_contacts\_get\_segments Get all the segments **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of documents per page | | `offset` | integer | No | — | Index of the first document of the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_contacts\_getrecords Get the list of object records and total records count for an object. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object_type` | string | Yes | — | Object type for the records to retrieve. Must be a previously created custom object type. Contact as object type is not supported in this endpoint. | | `limit` | integer | Yes | — | Number of records returned per page | | `page_num` | integer | Yes | — | Page number for pagination. It's used to fetch the object records on a provided page number. Must be a valid positive integer. | | `sort` | string | No | — | Sort order, must be 'asc' or 'desc'. Default to 'desc' if not provided. | | `association` | string | No | — | Whether to include associations, must be 'true' or 'false'. Default to 'false' if not provided. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object_type": { "type": "string", "description": "Object type for the records to retrieve. Must be a previously created custom object type. Contact as object type is not supported in this endpoint." }, "limit": { "type": "integer", "description": "Number of records returned per page" }, "page_num": { "type": "integer", "description": "Page number for pagination. It's used to fetch the object records on a provided page number. Must be a valid positive integer." }, "sort": { "type": "string", "description": "Sort order, must be 'asc' or 'desc'. Default to 'desc' if not provided.", "enum": [ "asc", "desc" ] }, "association": { "type": "string", "description": "Whether to include associations, must be 'true' or 'false'. Default to 'false' if not provided.", "enum": [ "true", "false" ] } }, "required": [ "PCID", "object_type", "limit", "page_num" ] } ``` *** ## brevo\_contacts\_import\_contacts Import contacts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `consentGroupIds` | integer\[] | No | — | **Optional.** Ids of the consent groups to which all imported contacts will be added. Requires consent groups to be enabled for the organisation. For example, **\[1, 3]**. | | `disableNotification` | boolean | No | — | To disable email notification | | `emailBlacklist` | boolean | No | — | To blacklist all the contacts for email | | `emptyContactsAttributes` | boolean | No | — | To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in Brevo, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( \*\*only available if `updateExistingContacts` set to true \*\*) | | `fileBody` | string | No | — | **Mandatory if fileUrl and jsonBody is not defined.** CSV content to be imported. Use semicolon to separate multiple attributes. **Maximum allowed file body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | | `fileUrl` | string | No | — | **Mandatory if fileBody and jsonBody is not defined.** URL of the file to be imported (**no local file**). Possible file formats: #### .txt, .csv, .json | | `jsonBody` | object\[] | No | — | **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. | | `listIds` | integer\[] | No | — | **Mandatory if newList is not defined.** Ids of the lists in which the contacts shall be imported. For example, **\[2, 4, 7]**. | | `newList` | object | No | — | To create a new list and import the contacts into it, pass the listName and an optional folderId. | | `notifyUrl` | string | No | — | URL that will be called once the import process is finished. For reference, [https://help.brevo.com/hc/en-us/articles/360007666479](https://help.brevo.com/hc/en-us/articles/360007666479) | | `smsBlacklist` | boolean | No | — | To blacklist all the contacts for sms | | `updateExistingContacts` | boolean | No | — | To facilitate the choice to update the existing contacts | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "consentGroupIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "**Optional.** Ids of the consent groups to which all imported contacts will be added. Requires consent groups to be enabled for the organisation. For example, **[1, 3]**." }, "disableNotification": { "type": "boolean", "description": "To disable email notification" }, "emailBlacklist": { "type": "boolean", "description": "To blacklist all the contacts for email" }, "emptyContactsAttributes": { "type": "boolean", "description": "To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in Brevo, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( **only available if `updateExistingContacts` set to true **)" }, "fileBody": { "type": "string", "description": "**Mandatory if fileUrl and jsonBody is not defined.** CSV content to be imported. Use semicolon to separate multiple attributes. **Maximum allowed file body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files." }, "fileUrl": { "type": "string", "description": "**Mandatory if fileBody and jsonBody is not defined.** URL of the file to be imported (**no local file**). Possible file formats: #### .txt, .csv, .json" }, "jsonBody": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "description": "List of attributes to be imported" }, "email": { "type": "string", "description": "The email value" } } }, "description": "**Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files." }, "listIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "**Mandatory if newList is not defined.** Ids of the lists in which the contacts shall be imported. For example, **[2, 4, 7]**." }, "newList": { "type": "object", "description": "To create a new list and import the contacts into it, pass the listName and an optional folderId.", "properties": { "folderId": { "type": "integer", "description": "Id of the folder where this new list shall be created. **Mandatory if listName is not empty**" }, "listName": { "type": "string", "description": "List with listName will be created first and users will be imported in it. **Mandatory if listIds is empty**." } } }, "notifyUrl": { "type": "string", "description": "URL that will be called once the import process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479" }, "smsBlacklist": { "type": "boolean", "description": "To blacklist all the contacts for sms" }, "updateExistingContacts": { "type": "boolean", "description": "To facilitate the choice to update the existing contacts" } }, "required": [ "PCID" ] } ``` *** ## brevo\_contacts\_remove\_contact\_from\_list Delete a contact from a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `listId` | integer | Yes | — | Id of the list | | `body` | object | Yes | — | Emails adresses OR IDs OR EXT\_ID attributes of the contacts OR 'all' true | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "listId": { "type": "integer", "description": "Id of the list" }, "body": { "description": "Emails adresses OR IDs OR EXT_ID attributes of the contacts OR 'all' true" } }, "required": [ "PCID", "listId", "body" ] } ``` *** ## brevo\_contacts\_request\_contact\_export Export contacts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `customContactFilter` | object | Yes | — | Set the filter for the contacts to be exported. | | `disableNotification` | boolean | No | — | To avoid generating the email notification upon contact export, pass **true** | | `exportAttributes` | string\[] | No | — | List of all the attributes that you want to export. \*\*These attributes must be present in your contact database. It is required if exportMandatoryAttributes is set false. \*\* For example: **\['fname', 'lname', 'email']** | | `exportDateInUTC` | boolean | No | — | Specifies whether the date fields createdAt, modifiedAt in the exported data should be returned in UTC format. | | `exportMandatoryAttributes` | boolean | No | — | To export mandatory attributes like EMAIL, ADDED\_TIME, MODIFIED\_TIME | | `exportMetadata` | string\[] | No | — | Export metadata of contacts such as \_listIds, ADDED\_TIME, MODIFIED\_TIME. | | `exportSubscriptionStatus` | string\[] | No | — | Export subscription status of contacts for email & sms marketting. Pass email\_marketing to obtain the marketing email subscription status & sms\_marketing to retrieve the marketing SMS status of the contact. | | `notifyUrl` | string | No | — | Webhook that will be called once the export process is finished. For reference, [https://help.brevo.com/hc/en-us/articles/360007666479](https://help.brevo.com/hc/en-us/articles/360007666479) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "customContactFilter": { "type": "object", "description": "Set the filter for the contacts to be exported.", "properties": { "actionForContacts": { "type": "string", "description": "**Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on contacts as per the list id. * **allContacts** - Fetch the list of all contacts for a particular list. * **subscribed & unsubscribed** - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * **unsubscribedPerList** - Fetch the list of contacts that are unsubscribed from a particular list only.", "enum": [ "allContacts", "subscribed", "unsubscribed", "unsubscribedPerList" ] }, "actionForEmailCampaigns": { "type": "string", "description": "**Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on email campaigns. * **openers & nonOpeners** - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * **clickers & nonClickers** - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * **unsubscribed** - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * **hardBounces & softBounces** - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s).", "enum": [ "openers", "nonOpeners", "clickers", "nonClickers", "unsubscribed", "hardBounces", "softBounces" ] }, "actionForSmsCampaigns": { "type": "string", "description": "**Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.** This will export the contacts on the basis of provided action applied on sms campaigns. * **unsubscribed** - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * **hardBounces & softBounces** - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns.", "enum": [ "hardBounces", "softBounces", "unsubscribed" ] }, "emailCampaignId": { "type": "integer", "description": "Considered only if **actionForEmailCampaigns** is passed, ignored otherwise. **Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed.** The id of the email campaign for which the corresponding action shall be applied in the filter." }, "listId": { "type": "integer", "description": "ID of the list. This is mandatory if actionForContacts is specified and segmentId is not provided. Either segmentId or listId must be included." }, "segmentId": { "type": "integer", "description": "ID of the segment. This is mandatory if actionForContacts is specified and listId is not provided. Either segmentId or listId must be included." }, "smsCampaignId": { "type": "integer", "description": "Considered only if **actionForSmsCampaigns** is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter." } } }, "disableNotification": { "type": "boolean", "description": "To avoid generating the email notification upon contact export, pass **true**" }, "exportAttributes": { "type": "array", "items": { "type": "string" }, "description": "List of all the attributes that you want to export. **These attributes must be present in your contact database. It is required if exportMandatoryAttributes is set false. ** For example: **['fname', 'lname', 'email']**" }, "exportDateInUTC": { "type": "boolean", "description": "Specifies whether the date fields createdAt, modifiedAt in the exported data should be returned in UTC format." }, "exportMandatoryAttributes": { "type": "boolean", "description": "To export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME" }, "exportMetadata": { "type": "array", "items": { "type": "string" }, "description": "Export metadata of contacts such as _listIds, ADDED_TIME, MODIFIED_TIME." }, "exportSubscriptionStatus": { "type": "array", "items": { "type": "string" }, "description": "Export subscription status of contacts for email & sms marketting. Pass email_marketing to obtain the marketing email subscription status & sms_marketing to retrieve the marketing SMS status of the contact." }, "notifyUrl": { "type": "string", "description": "Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479" } }, "required": [ "PCID", "customContactFilter" ] } ``` *** ## brevo\_contacts\_update\_attribute Update contact attribute **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attributeCategory` | string | Yes | — | Category of the attribute | | `attributeName` | string | Yes | — | Name of the existing attribute | | `enumeration` | object\[] | No | — | List of the values and labels that the attribute can take. **Use only if the attribute's category is "category"** None of the category options can exceed max 200 characters. For example, **\[\{"value":1, "label":"male"}, \{"value":2, "label":"female"}]** | | `multiCategoryOptions` | string\[] | No | — | Use this option to add multiple-choice attributes options only if the attribute's category is "normal". **This option is specifically designed for updating multiple-choice attributes. None of the multicategory options can exceed max 200 characters.**. For example: **\["USA","INDIA"]** | | `value` | string | No | — | Value of the attribute to update. **Use only if the attribute's category is 'calculated' or 'global'** | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributeCategory": { "type": "string", "description": "Category of the attribute", "enum": [ "category", "calculated", "global", "normal" ] }, "attributeName": { "type": "string", "description": "Name of the existing attribute" }, "enumeration": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "Label of the value" }, "value": { "type": "integer", "description": "Id of the value" } }, "required": [ "label", "value" ] }, "description": "List of the values and labels that the attribute can take. **Use only if the attribute's category is \"category\"** None of the category options can exceed max 200 characters. For example, **[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]**" }, "multiCategoryOptions": { "type": "array", "items": { "type": "string" }, "description": "Use this option to add multiple-choice attributes options only if the attribute's category is \"normal\". **This option is specifically designed for updating multiple-choice attributes. None of the multicategory options can exceed max 200 characters.**. For example: **[\"USA\",\"INDIA\"]**" }, "value": { "type": "string", "description": "Value of the attribute to update. **Use only if the attribute's category is 'calculated' or 'global'**" } }, "required": [ "PCID", "attributeCategory", "attributeName" ] } ``` *** ## brevo\_contacts\_update\_batch\_contacts Update multiple contacts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contacts` | object\[] | No | — | List of contacts to be updated | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "attributes": { "type": "object", "description": "Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}**" }, "email": { "type": "string", "format": "email", "description": "Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)" }, "emailBlacklisted": { "type": "boolean", "description": "Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)" }, "ext_id": { "type": "string", "description": "Pass your own Id to update ext_id of a contact." }, "id": { "type": "integer", "format": "int64", "description": "id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)" }, "listIds": { "type": "array", "items": { "type": "integer" }, "description": "Ids of the lists to add the contact to" }, "sms": { "type": "string", "description": "SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)" }, "smsBlacklisted": { "type": "boolean", "description": "Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)" }, "smtpBlacklistSender": { "type": "array", "items": { "type": "string" }, "description": "transactional email forbidden sender for contact. Use only for email Contact" }, "unlinkListIds": { "type": "array", "items": { "type": "integer" }, "description": "Ids of the lists to remove the contact from" } } }, "description": "List of contacts to be updated" } }, "required": [ "PCID" ] } ``` *** ## brevo\_contacts\_update\_contact Update a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | object | Yes | — | Email (urlencoded) OR ID of the contact OR EXT\_ID attribute (urlencoded) OR its SMS attribute value OR its WHATSAPP attribute value OR its LANDLINE\_NUMBER attribute value | | `identifierType` | string | No | — | email\_id for Email, contact\_id for ID of the contact, ext\_id for EXT\_ID attribute, phone\_id for SMS attribute, whatsapp\_id for WHATSAPP attribute, landline\_number\_id for LANDLINE\_NUMBER attribute | | `attributes` | object | No | — | Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, **\{ "EMAIL":"[newemail@domain.com](mailto:newemail@domain.com)", "FNAME":"Ellie", "LNAME":"Roger", "COUNTRIES":\["India","China"]}**. The attribute's parameter should be passed in capital letter while updating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored .Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **\{"SMS":"+91xxxxxxxxxx"} or \{"SMS":"0091xxxxxxxxxx"}** | | `emailBlacklisted` | boolean | No | — | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | | `ext_id` | string | No | — | Pass your own Id to update ext\_id of a contact. | | `forceMerge` | boolean | No | — | When true, if the contact being updated shares an identifier (email, SMS, ext\_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent `last_modified` timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict. | | `listIds` | integer\[] | No | — | Ids of the lists to add the contact to | | `smsBlacklisted` | boolean | No | — | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | | `smtpBlacklistSender` | string\[] | No | — | transactional email forbidden sender for contact. Use only for email Contact | | `unlinkListIds` | integer\[] | No | — | Ids of the lists to remove the contact from | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "description": "Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded) OR its SMS attribute value OR its WHATSAPP attribute value OR its LANDLINE_NUMBER attribute value" }, "identifierType": { "type": "string", "description": "email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute", "enum": [ "email_id", "contact_id", "ext_id", "phone_id", "whatsapp_id", "landline_number_id" ] }, "attributes": { "type": "object", "description": "Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, **{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\", \"COUNTRIES\":[\"India\",\"China\"]}**. The attribute's parameter should be passed in capital letter while updating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored .Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}**" }, "emailBlacklisted": { "type": "boolean", "description": "Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)" }, "ext_id": { "type": "string", "description": "Pass your own Id to update ext_id of a contact." }, "forceMerge": { "type": "boolean", "description": "When true, if the contact being updated shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent `last_modified` timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict." }, "listIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Ids of the lists to add the contact to" }, "smsBlacklisted": { "type": "boolean", "description": "Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)" }, "smtpBlacklistSender": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "transactional email forbidden sender for contact. Use only for email Contact" }, "unlinkListIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Ids of the lists to remove the contact from" } }, "required": [ "PCID", "identifier" ] } ``` *** ## brevo\_contacts\_update\_folder Update a folder **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `folderId` | integer | Yes | — | Id of the folder | | `name` | string | No | — | Name of the folder | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "folderId": { "type": "integer", "description": "Id of the folder" }, "name": { "type": "string", "description": "Name of the folder" } }, "required": [ "PCID", "folderId" ] } ``` *** ## brevo\_contacts\_update\_list Update a list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `listId` | integer | Yes | — | Id of the list | | `folderId` | integer | No | — | Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time. | | `name` | string | No | — | Name of the list. Either of the two parameters (name, folderId) can be updated at a time. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "listId": { "type": "integer", "description": "Id of the list" }, "folderId": { "type": "integer", "description": "Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time." }, "name": { "type": "string", "description": "Name of the list. Either of the two parameters (name, folderId) can be updated at a time." } }, "required": [ "PCID", "listId" ] } ``` *** ## brevo\_contacts\_upsertrecords Create/Update object records in bulk **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `object_type` | string | Yes | — | Object type for the records to upsert. Must be a previously created custom object type. Only lowercase alphanumeric characters and underscores are allowed (max 32 characters). | | `records` | object\[] | Yes | — | List of object records to be upsert. Each record can have attributes, identifiers, and associations. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "object_type": { "type": "string", "description": "Object type for the records to upsert. Must be a previously created custom object type. Only lowercase alphanumeric characters and underscores are allowed (max 32 characters)." }, "records": { "type": "array", "items": { "type": "object", "properties": { "associations": { "type": "array", "items": { "type": "object", "properties": { "object_type": { "type": "string", "description": "Type of the associated object" }, "action": { "type": "string", "description": "Action to perform on the association. - `link`: Create association between records (default if not provided) - `unlink`: Remove association between records. Idempotent — unlinking a non-existing association is a no-op success. " }, "records": { "type": "array" } } }, "description": "List of associations for the object record. Maximum 20 total entries allowed, with a maximum of 10 link actions and 10 unlink actions. Each entry specifies an object_type and an action (link or unlink). Unlink is idempotent — removing a non-existing association does not return an error. Both associated records must already exist before creating a link." }, "attributes": { "type": "object", "description": "Key-value pairs of attribute data for the object record. Each key must be the attribute **key** (e.g., `company_name`, `engine_type`), not the attribute label (e.g., \"Company Name\", \"Engine Type\"). Only attributes that already exist in the object schema will be accepted — unknown keys are silently ignored. Minimum 1 attribute is required. For `category` or `multiple_category` attributes, set the value to the option **key** (not the option label or option ID). You can find available option keys in the `options` array returned by the GET attributes endpoint, or in the frontend under each attribute's settings. For example, use the option key \"hybrid\" not the label \"Hybrid\" — using the label will be silently ignored. For `multiple_choice` type, pass an **array of option keys** (not display labels). For example, if options have keys `\"sunroof\"` and `\"leather_seats\"`, pass `[\"sunroof\", \"leather_seats\"]`." }, "identifiers": { "type": "object", "description": "Identifiers for the object record. Supports `id` (singular, not `ids`) or `ext_id`. - `ext_id`: Your external system's identifier for this record. - `id`: Internal Brevo record ID — can only be used for **updating** existing records, not for creation. NOTE: - This is an optional field. If no identifier is provided, Brevo auto-generates an internal ID that you can use for future operations. - If both `ext_id` and `id` are provided, `id` takes precedence and the operation is treated as an update. It is recommended to provide only one identifier per record." } } }, "description": "List of object records to be upsert. Each record can have attributes, identifiers, and associations." } }, "required": [ "PCID", "object_type", "records" ] } ``` *** ## brevo-contacts\_create\_consent\_group Create a consent group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `description` | string | No | — | Optional description (max 500 characters) | | `listIds` | integer\[] | No | — | Optional list of contact list IDs. Contacts from these lists will be copied once into this consent group at creation time. | | `name` | string | Yes | — | Unique name for the consent group (max 255 characters) | | `signupMode` | string | Yes | — | Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "Optional description (max 500 characters)" }, "listIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Optional list of contact list IDs. Contacts from these lists will be copied once into this consent group at creation time." }, "name": { "type": "string", "description": "Unique name for the consent group (max 255 characters)" }, "signupMode": { "type": "string", "description": "Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup.", "enum": [ "manual", "automatic" ] } }, "required": [ "PCID", "name", "signupMode" ] } ``` *** ## brevo-contacts\_delete\_consent\_group Delete a consent group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | ID of the consent group to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the consent group to delete" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo-contacts\_get\_consent\_group Get a consent group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | ID of the consent group | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the consent group" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo-contacts\_get\_consent\_groups List all consent groups **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Maximum number of results to return (default 10, max 50) | | `offset` | integer | No | — | Number of results to skip (default 0) | | `id` | integer | No | — | Filter by consent group ID | | `name` | string | No | — | Filter by name (case-insensitive partial match) | | `signupMode` | string | No | — | Filter by signup mode | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Maximum number of results to return (default 10, max 50)" }, "offset": { "type": "integer", "description": "Number of results to skip (default 0)" }, "id": { "type": "integer", "description": "Filter by consent group ID" }, "name": { "type": "string", "description": "Filter by name (case-insensitive partial match)" }, "signupMode": { "type": "string", "description": "Filter by signup mode", "enum": [ "manual", "automatic" ] } }, "required": [ "PCID" ] } ``` *** ## brevo-contacts\_update\_consent\_group Update a consent group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | integer | Yes | — | ID of the consent group to update | | `description` | string | No | — | New description (max 500 characters) | | `name` | string | No | — | New name for the consent group (max 255 characters) | | `signupMode` | string | No | — | New signup mode | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the consent group to update" }, "description": { "type": "string", "description": "New description (max 500 characters)" }, "name": { "type": "string", "description": "New name for the consent group (max 255 characters)" }, "signupMode": { "type": "string", "description": "New signup mode", "enum": [ "manual", "automatic" ] } }, "required": [ "PCID", "id" ] } ``` # brevo-crm Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/brevo/brevo-crm Brevo CRM **Server path:** `/brevo-crm` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`brevo_crm_create_companies`](#brevo_crm_create_companies) | Create a company | | [`brevo_crm_create_companies_import`](#brevo_crm_create_companies_import) | Import companies(creation and updation) | | [`brevo_crm_create_crm_attributes`](#brevo_crm_create_crm_attributes) | Create a company/deal attribute | | [`brevo_crm_create_crm_deals`](#brevo_crm_create_crm_deals) | Create a deal | | [`brevo_crm_create_crm_deals_import`](#brevo_crm_create_crm_deals_import) | Import deals(creation and updation) | | [`brevo_crm_create_crm_files`](#brevo_crm_create_crm_files) | Upload a file | | [`brevo_crm_create_crm_notes`](#brevo_crm_create_crm_notes) | Create a note | | [`brevo_crm_create_crm_tasks`](#brevo_crm_create_crm_tasks) | Create a task | | [`brevo_crm_delete_attributes_by_id`](#brevo_crm_delete_attributes_by_id) | Delete an attribute | | [`brevo_crm_delete_companies_by_id`](#brevo_crm_delete_companies_by_id) | Delete a company | | [`brevo_crm_delete_deals_by_id`](#brevo_crm_delete_deals_by_id) | Delete a deal | | [`brevo_crm_delete_files_by_id`](#brevo_crm_delete_files_by_id) | Delete a file | | [`brevo_crm_delete_notes_by_id`](#brevo_crm_delete_notes_by_id) | Delete a note | | [`brevo_crm_delete_tasks_by_id`](#brevo_crm_delete_tasks_by_id) | Delete a task | | [`brevo_crm_get_companies_by_id`](#brevo_crm_get_companies_by_id) | Get a company | | [`brevo_crm_get_deals_by_id`](#brevo_crm_get_deals_by_id) | Get a deal | | [`brevo_crm_get_files_by_id`](#brevo_crm_get_files_by_id) | Download a file | | [`brevo_crm_get_notes_by_id`](#brevo_crm_get_notes_by_id) | Get a note | | [`brevo_crm_get_pipeline_details_by_pipeline_id`](#brevo_crm_get_pipeline_details_by_pipeline_id) | Get a pipeline | | [`brevo_crm_get_tasks_by_id`](#brevo_crm_get_tasks_by_id) | Get a task | | [`brevo_crm_list_companies`](#brevo_crm_list_companies) | Get all Companies | | [`brevo_crm_list_crm_attributes_companies`](#brevo_crm_list_crm_attributes_companies) | Get company attributes | | [`brevo_crm_list_crm_attributes_deals`](#brevo_crm_list_crm_attributes_deals) | Get deal attributes | | [`brevo_crm_list_crm_deals`](#brevo_crm_list_crm_deals) | Get all deals | | [`brevo_crm_list_crm_files`](#brevo_crm_list_crm_files) | Get all files | | [`brevo_crm_list_crm_files_by_id_data`](#brevo_crm_list_crm_files_by_id_data) | Get file details | | [`brevo_crm_list_crm_notes`](#brevo_crm_list_crm_notes) | Get all notes | | [`brevo_crm_list_crm_pipeline_details_all`](#brevo_crm_list_crm_pipeline_details_all) | Get all pipelines | | [`brevo_crm_list_crm_tasks`](#brevo_crm_list_crm_tasks) | Get all tasks | | [`brevo_crm_list_crm_tasktypes`](#brevo_crm_list_crm_tasktypes) | Get all task types | | [`brevo_crm_update_companies_by_id`](#brevo_crm_update_companies_by_id) | Update a company | | [`brevo_crm_update_companies_link_unlink_by_id`](#brevo_crm_update_companies_link_unlink_by_id) | Link and Unlink company with contact and deal | | [`brevo_crm_update_crm_attributes_by_id`](#brevo_crm_update_crm_attributes_by_id) | Update an attribute | | [`brevo_crm_update_crm_deals_by_id`](#brevo_crm_update_crm_deals_by_id) | Update a deal | | [`brevo_crm_update_crm_deals_link_unlink_by_id`](#brevo_crm_update_crm_deals_link_unlink_by_id) | Link and Unlink a deal with contacts and companies | | [`brevo_crm_update_crm_notes_by_id`](#brevo_crm_update_crm_notes_by_id) | Update a note | | [`brevo_crm_update_crm_tasks_by_id`](#brevo_crm_update_crm_tasks_by_id) | Update a task | *** ## brevo\_crm\_create\_companies Create a company **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attributes` | object | No | — | Attributes for company creation | | `countryCode` | integer | No | — | Country code if phone\_number is passed in attributes. | | `linkedContactsIds` | integer\[] | No | — | Contact ids to be linked with company | | `linkedDealsIds` | string\[] | No | — | Deal ids to be linked with company | | `name` | string | Yes | — | Name of company | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributes": { "type": "object", "description": "Attributes for company creation" }, "countryCode": { "type": "integer", "description": "Country code if phone_number is passed in attributes." }, "linkedContactsIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids to be linked with company" }, "linkedDealsIds": { "type": "array", "items": { "type": "string", "format": "objectID" }, "description": "Deal ids to be linked with company" }, "name": { "type": "string", "description": "Name of company" } }, "required": [ "PCID", "name" ] } ``` *** ## brevo\_crm\_create\_companies\_import Import companies(creation and updation) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `file` | string | No | — | The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) company\_id \[brevo mongoID to update companies] (b) associated\_contact (c) associated\_deal (f) any other attribute with internal name | | `mapping` | object | No | — | The mapping options in JSON format. Here is an example of the JSON structure: `json { "link_entities": true, // Determines whether to link related entities during the import process "unlink_entities": false, // Determines whether to unlink related entities during the import process "update_existing_records": true, // Determines whether to update based on company ID or treat every row as create "unset_empty_attributes": false // Determines whether to unset a specific attribute during update if the values input is blank } ` | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file": { "type": "string", "description": "The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) company_id [brevo mongoID to update companies] (b) associated_contact (c) associated_deal (f) any other attribute with internal name" }, "mapping": { "type": "object", "description": "The mapping options in JSON format. Here is an example of the JSON structure: ```json { \"link_entities\": true, // Determines whether to link related entities during the import process \"unlink_entities\": false, // Determines whether to unlink related entities during the import process \"update_existing_records\": true, // Determines whether to update based on company ID or treat every row as create \"unset_empty_attributes\": false // Determines whether to unset a specific attribute during update if the values input is blank } ```" } }, "required": [ "PCID" ] } ```` *** ## brevo\_crm\_create\_crm\_attributes Create a company/deal attribute **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attributeType` | string | Yes | — | The type of attribute (must be one of the defined enums) | | `description` | string | No | — | A description of the attribute | | `label` | string | Yes | — | The label for the attribute (max 50 characters, cannot be empty) | | `objectType` | string | Yes | — | The type of object the attribute belongs to. Must be either `companies` or `deals`. | | `optionsLabels` | string\[] | No | — | Options for multi-choice or single-select attributes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributeType": { "type": "string", "description": "The type of attribute (must be one of the defined enums)", "enum": [ "text", "user", "number", "single-select", "date", "boolean", "multi-choice" ] }, "description": { "type": "string", "description": "A description of the attribute" }, "label": { "type": "string", "description": "The label for the attribute (max 50 characters, cannot be empty)" }, "objectType": { "type": "string", "description": "The type of object the attribute belongs to. Must be either `companies` or `deals`.", "enum": [ "companies", "deals" ] }, "optionsLabels": { "type": "array", "items": { "type": "string" }, "description": "Options for multi-choice or single-select attributes" } }, "required": [ "PCID", "attributeType", "label", "objectType" ] } ``` *** ## brevo\_crm\_create\_crm\_deals Create a deal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attributes` | object | No | — | Attributes for deal creation To assign owner of a Deal you can send attributes.deal\_owner and utilize the account email or ID. If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`. Pipeline and deal\_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | | `linkedCompaniesIds` | string\[] | No | — | Company ids to be linked with deal | | `linkedContactsIds` | integer\[] | No | — | Contact ids to be linked with deal | | `name` | string | Yes | — | Name of deal | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attributes": { "type": "object", "description": "Attributes for deal creation To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}`" }, "linkedCompaniesIds": { "type": "array", "items": { "type": "string", "format": "objectID" }, "description": "Company ids to be linked with deal" }, "linkedContactsIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids to be linked with deal" }, "name": { "type": "string", "description": "Name of deal" } }, "required": [ "PCID", "name" ] } ``` *** ## brevo\_crm\_create\_crm\_deals\_import Import deals(creation and updation) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `file` | string | No | — | The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) deal\_id \[brevo mongoID to update deals] (b) associated\_contact (c) associated\_company (f) any other attribute with internal name | | `mapping` | object | No | — | The mapping options in JSON format. Here is an example of the JSON structure: `json { "link_entities": true, // Determines whether to link related entities during the import process "unlink_entities": false, // Determines whether to unlink related entities during the import process "update_existing_records": true, // Determines whether to update based on deal ID or treat every row as create "unset_empty_attributes": false // Determines whether to unset a specific attribute during update if the values input is blank } ` | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "file": { "type": "string", "description": "The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) deal_id [brevo mongoID to update deals] (b) associated_contact (c) associated_company (f) any other attribute with internal name" }, "mapping": { "type": "object", "description": "The mapping options in JSON format. Here is an example of the JSON structure: ```json { \"link_entities\": true, // Determines whether to link related entities during the import process \"unlink_entities\": false, // Determines whether to unlink related entities during the import process \"update_existing_records\": true, // Determines whether to update based on deal ID or treat every row as create \"unset_empty_attributes\": false // Determines whether to unset a specific attribute during update if the values input is blank } ```" } }, "required": [ "PCID" ] } ```` *** ## brevo\_crm\_create\_crm\_files Upload a file **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyId` | string | No | — | Company Id | | `contactId` | integer | No | — | Contact Id | | `dealId` | string | No | — | Deal Id | | `file` | string | Yes | — | File data to create a file. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "contactId": { "type": "integer", "description": "Contact Id" }, "dealId": { "type": "string", "description": "Deal Id" }, "file": { "type": "string", "description": "File data to create a file." } }, "required": [ "PCID", "file" ] } ``` *** ## brevo\_crm\_create\_crm\_notes Create a note **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `companyIds` | string\[] | No | — | Company Ids linked to a note | | `contactIds` | integer\[] | No | — | Contact Ids linked to a note | | `dealIds` | string\[] | No | — | Deal Ids linked to a note | | `text` | string | Yes | — | Content of the note. Supports HTML for rich text formatting. Supported tags include: `<p>` (paragraph), `<b>` / `<strong>` (bold), `<i>` / `<em>` (italic), `<u>` (underline), `<br>` (line break), `<a href="...">` (labelled hyperlink). Example labelled link: `<a href="https://example.com">Link text</a>`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyIds": { "type": "array", "items": { "type": "string" }, "description": "Company Ids linked to a note" }, "contactIds": { "type": "array", "items": { "type": "integer" }, "description": "Contact Ids linked to a note" }, "dealIds": { "type": "array", "items": { "type": "string" }, "description": "Deal Ids linked to a note" }, "text": { "type": "string", "description": "Content of the note. Supports HTML for rich text formatting. Supported tags include: `

      ` (paragraph), `` / `` (bold), `` / `` (italic), `` (underline), `
      ` (line break), `` (labelled hyperlink). Example labelled link: `Link text`." } }, "required": [ "PCID", "text" ] } ``` *** ## brevo\_crm\_create\_crm\_tasks Create a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `assignToId` | string | No | — | To assign a task to a user you can use either the account email or ID. | | `companiesIds` | string\[] | No | — | Companies ids for companies a task is linked to | | `contactsIds` | integer\[] | No | — | Contact ids for contacts linked to this task | | `date` | string | Yes | — | Task due date and time | | `dealsIds` | string\[] | No | — | Deal ids for deals a task is linked to | | `done` | boolean | No | — | Task marked as done | | `duration` | integer | No | — | Duration of task in milliseconds \[1 minute = 60000 ms] | | `name` | string | Yes | — | Name of task | | `notes` | string | No | — | Notes added to a task | | `reminder` | object | No | — | Task reminder date/time for a task | | `taskTypeId` | string | Yes | — | Id for type of task e.g Call / Email / Meeting etc. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assignToId": { "type": "string", "description": "To assign a task to a user you can use either the account email or ID." }, "companiesIds": { "type": "array", "items": { "type": "string" }, "description": "Companies ids for companies a task is linked to" }, "contactsIds": { "type": "array", "items": { "type": "integer" }, "description": "Contact ids for contacts linked to this task" }, "date": { "type": "string", "description": "Task due date and time" }, "dealsIds": { "type": "array", "items": { "type": "string" }, "description": "Deal ids for deals a task is linked to" }, "done": { "type": "boolean", "description": "Task marked as done" }, "duration": { "type": "integer", "description": "Duration of task in milliseconds [1 minute = 60000 ms]" }, "name": { "type": "string", "description": "Name of task" }, "notes": { "type": "string", "description": "Notes added to a task" }, "reminder": { "type": "object", "description": "Task reminder date/time for a task", "properties": { "types": { "type": "array", "items": { "type": "string", "enum": [ "email", "push" ] }, "description": "Type of task reminder e.g email, push" }, "unit": { "type": "string", "description": "Unit of time before reminder is to be sent", "enum": [ "minutes", "hours", "weeks", "days" ] }, "value": { "type": "integer", "description": "Value of time unit before reminder is to be sent" } }, "required": [ "value", "unit", "types" ] }, "taskTypeId": { "type": "string", "description": "Id for type of task e.g Call / Email / Meeting etc." } }, "required": [ "PCID", "date", "name", "taskTypeId" ] } ``` *** ## brevo\_crm\_delete\_attributes\_by\_id Delete an attribute **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Attribute ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Attribute ID" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_delete\_companies\_by\_id Delete a company **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Company ID to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Company ID to delete" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_delete\_deals\_by\_id Delete a deal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_delete\_files\_by\_id Delete a file **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | File id to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "File id to delete." } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_delete\_notes\_by\_id Delete a note **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Note ID to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Note ID to delete" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_delete\_tasks\_by\_id Delete a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_get\_companies\_by\_id Get a company **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Get Company Details | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Get Company Details" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_get\_deals\_by\_id Get a deal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_get\_files\_by\_id Download a file **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | File id to download. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "File id to download." } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_get\_notes\_by\_id Get a note **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Note ID to get | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Note ID to get" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_get\_pipeline\_details\_by\_pipeline\_id Get a pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pipelineID` | string | Yes | — | Pipeline ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pipelineID": { "type": "string", "description": "Pipeline ID" } }, "required": [ "PCID", "pipelineID" ] } ``` *** ## brevo\_crm\_get\_tasks\_by\_id Get a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_list\_companies Get all Companies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filters[attributes.name]` | string | No | — | Filter by attributes. If you have a filter for the owner on your side please send it as filters\[attributes.owner] and utilize the account email for the filtering. | | `linkedContactsIds` | integer | No | — | Filter by linked contacts ids | | `linkedDealsIds` | string | No | — | Filter by linked Deals ids | | `modifiedSince` | string | No | — | Filter (urlencoded) the companies modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | | `createdSince` | string | No | — | Filter (urlencoded) the companies created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | | `page` | integer | No | — | Index of the first document of the page | | `limit` | integer | No | — | Number of documents per page | | `sort` | string | No | — | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | | `sortBy` | string | No | — | The field used to sort field names. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filters[attributes.name]": { "type": "string", "description": "Filter by attributes. If you have a filter for the owner on your side please send it as filters[attributes.owner] and utilize the account email for the filtering." }, "linkedContactsIds": { "type": "integer", "description": "Filter by linked contacts ids" }, "linkedDealsIds": { "type": "string", "description": "Filter by linked Deals ids" }, "modifiedSince": { "type": "string", "description": "Filter (urlencoded) the companies modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result." }, "createdSince": { "type": "string", "description": "Filter (urlencoded) the companies created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result." }, "page": { "type": "integer", "description": "Index of the first document of the page" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed", "enum": [ "asc", "desc" ] }, "sortBy": { "type": "string", "description": "The field used to sort field names." } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_attributes\_companies Get company attributes ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_attributes\_deals Get deal attributes ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_deals Get all deals **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filters[attributes.deal_name]` | string | No | — | Filter by attributes. If you have a filter for the owner on your end, please send it as filters\[attributes.deal\_owner] and utilize the account email for the filtering. | | `filters[linkedCompaniesIds]` | string | No | — | Filter by linked companies ids | | `filters[linkedContactsIds]` | string | No | — | Filter by linked contacts ids | | `modifiedSince` | string | No | — | Filter (urlencoded) the deals modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | | `createdSince` | string | No | — | Filter (urlencoded) the deals created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | | `offset` | integer | No | — | Index of the first document of the page | | `limit` | integer | No | — | Number of documents per page | | `sort` | string | No | — | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | | `sortBy` | string | No | — | The field used to sort field names. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filters[attributes.deal_name]": { "type": "string", "description": "Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the account email for the filtering." }, "filters[linkedCompaniesIds]": { "type": "string", "description": "Filter by linked companies ids" }, "filters[linkedContactsIds]": { "type": "string", "description": "Filter by linked contacts ids" }, "modifiedSince": { "type": "string", "description": "Filter (urlencoded) the deals modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result." }, "createdSince": { "type": "string", "description": "Filter (urlencoded) the deals created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result." }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed", "enum": [ "asc", "desc" ] }, "sortBy": { "type": "string", "description": "The field used to sort field names." } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_files Get all files **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `entity` | string | No | — | Filter by file entity type | | `entityIds` | string | No | — | Filter by file entity IDs | | `dateFrom` | integer | No | — | dateFrom to date range filter type (timestamp in milliseconds) | | `dateTo` | integer | No | — | dateTo to date range filter type (timestamp in milliseconds) | | `offset` | integer | No | — | Index of the first document of the page | | `limit` | integer | No | — | Number of documents per page | | `sort` | string | No | — | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entity": { "type": "string", "description": "Filter by file entity type", "enum": [ "companies", "deals", "contacts" ] }, "entityIds": { "type": "string", "description": "Filter by file entity IDs" }, "dateFrom": { "type": "integer", "description": "dateFrom to date range filter type (timestamp in milliseconds)" }, "dateTo": { "type": "integer", "description": "dateTo to date range filter type (timestamp in milliseconds)" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_files\_by\_id\_data Get file details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | File id to get file data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "File id to get file data." } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_list\_crm\_notes Get all notes **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `entity` | string | No | — | Filter by note entity type | | `entityIds` | string | No | — | Filter by note entity IDs | | `dateFrom` | integer | No | — | dateFrom to date range filter type (timestamp in milliseconds) | | `dateTo` | integer | No | — | dateTo to date range filter type (timestamp in milliseconds) | | `offset` | integer | No | — | Index of the first document of the page | | `limit` | integer | No | — | Number of documents per page | | `sort` | string | No | — | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entity": { "type": "string", "description": "Filter by note entity type", "enum": [ "companies", "deals", "contacts" ] }, "entityIds": { "type": "string", "description": "Filter by note entity IDs" }, "dateFrom": { "type": "integer", "description": "dateFrom to date range filter type (timestamp in milliseconds)" }, "dateTo": { "type": "integer", "description": "dateTo to date range filter type (timestamp in milliseconds)" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_pipeline\_details\_all Get all pipelines ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_tasks Get all tasks **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `filter[type]` | string | No | — | Filter by task type (ID) | | `filter[status]` | string | No | — | Filter by task status | | `filter[date]` | string | No | — | Filter by date | | `filter[assignTo]` | string | No | — | Filter by the "assignTo" ID. You can utilize account emails for the "assignTo" attribute. | | `filter[contacts]` | string | No | — | Filter by contact ids | | `filter[deals]` | string | No | — | Filter by deals ids | | `filter[companies]` | string | No | — | Filter by companies ids | | `dateFrom` | integer | No | — | dateFrom to date range filter type (timestamp in milliseconds) | | `dateTo` | integer | No | — | dateTo to date range filter type (timestamp in milliseconds) | | `offset` | integer | No | — | Index of the first document of the page | | `limit` | integer | No | — | Number of documents per page | | `sort` | string | No | — | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | | `sortBy` | string | No | — | The field used to sort field names. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter[type]": { "type": "string", "description": "Filter by task type (ID)" }, "filter[status]": { "type": "string", "description": "Filter by task status", "enum": [ "done", "undone" ] }, "filter[date]": { "type": "string", "description": "Filter by date", "enum": [ "overdue", "today", "tomorrow", "week", "range" ] }, "filter[assignTo]": { "type": "string", "description": "Filter by the \"assignTo\" ID. You can utilize account emails for the \"assignTo\" attribute." }, "filter[contacts]": { "type": "string", "description": "Filter by contact ids" }, "filter[deals]": { "type": "string", "description": "Filter by deals ids" }, "filter[companies]": { "type": "string", "description": "Filter by companies ids" }, "dateFrom": { "type": "integer", "description": "dateFrom to date range filter type (timestamp in milliseconds)" }, "dateTo": { "type": "integer", "description": "dateTo to date range filter type (timestamp in milliseconds)" }, "offset": { "type": "integer", "description": "Index of the first document of the page" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed", "enum": [ "asc", "desc" ] }, "sortBy": { "type": "string", "description": "The field used to sort field names." } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_list\_crm\_tasktypes Get all task types ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_crm\_update\_companies\_by\_id Update a company **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The id value | | `attributes` | object | No | — | Attributes for company update | | `countryCode` | integer | No | — | Country code if phone\_number is passed in attributes. | | `linkedContactsIds` | integer\[] | No | — | Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed. | | `linkedDealsIds` | string\[] | No | — | Warning - Using PATCH on linkedDealsIds replaces the list of linked deals. Omitted IDs will be removed. | | `name` | string | No | — | Name of company | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "attributes": { "type": "object", "description": "Attributes for company update" }, "countryCode": { "type": "integer", "description": "Country code if phone_number is passed in attributes." }, "linkedContactsIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed." }, "linkedDealsIds": { "type": "array", "items": { "type": "string", "format": "objectID" }, "description": "Warning - Using PATCH on linkedDealsIds replaces the list of linked deals. Omitted IDs will be removed." }, "name": { "type": "string", "description": "Name of company" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_update\_companies\_link\_unlink\_by\_id Link and Unlink company with contact and deal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The id value | | `linkContactIds` | integer\[] | No | — | Contact ids for contacts to be linked with company | | `linkDealsIds` | string\[] | No | — | Deal ids for deals to be linked with company | | `unlinkContactIds` | integer\[] | No | — | Contact ids for contacts to be unlinked from company | | `unlinkDealsIds` | string\[] | No | — | Deal ids for deals to be unlinked from company | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "linkContactIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids for contacts to be linked with company" }, "linkDealsIds": { "type": "array", "items": { "type": "string" }, "description": "Deal ids for deals to be linked with company" }, "unlinkContactIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids for contacts to be unlinked from company" }, "unlinkDealsIds": { "type": "array", "items": { "type": "string" }, "description": "Deal ids for deals to be unlinked from company" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_update\_crm\_attributes\_by\_id Update an attribute **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Attribute ID | | `label` | string | No | — | Attribute display label | | `objectType` | string | No | — | The type of object the attribute belongs to, it cannot be updated after creation | | `optionsLabels` | object\[] | No | — | Updated labels for selectable options | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Attribute ID" }, "label": { "type": "string", "description": "Attribute display label" }, "objectType": { "type": "string", "description": "The type of object the attribute belongs to, it cannot be updated after creation", "enum": [ "companies", "deals" ] }, "optionsLabels": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Internal option identifier" }, "value": { "type": "string", "description": "Display label for the option" } }, "required": [ "key", "value" ] }, "description": "Updated labels for selectable options" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_update\_crm\_deals\_by\_id Update a deal **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The id value | | `attributes` | object | No | — | Attributes for deal update To assign owner of a Deal you can send attributes.deal\_owner and utilize the account email or ID. If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage` Pipeline and deal\_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | | `linkedCompaniesIds` | string\[] | No | — | Warning - Using PATCH on linkedCompaniesIds replaces the list of linked companies. Omitted IDs will be removed. | | `linkedContactsIds` | integer\[] | No | — | Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed. | | `name` | string | No | — | Name of deal | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "attributes": { "type": "object", "description": "Attributes for deal update To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage` Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}`" }, "linkedCompaniesIds": { "type": "array", "items": { "type": "string", "format": "objectID" }, "description": "Warning - Using PATCH on linkedCompaniesIds replaces the list of linked companies. Omitted IDs will be removed." }, "linkedContactsIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed." }, "name": { "type": "string", "description": "Name of deal" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_update\_crm\_deals\_link\_unlink\_by\_id Link and Unlink a deal with contacts and companies **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The id value | | `linkCompanyIds` | string\[] | No | — | Company ids to be linked with deal | | `linkContactIds` | integer\[] | No | — | Contact ids for contacts to be linked with deal | | `unlinkCompanyIds` | string\[] | No | — | Company ids to be unlinked from deal | | `unlinkContactIds` | integer\[] | No | — | Contact ids for contacts to be unlinked from deal | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "linkCompanyIds": { "type": "array", "items": { "type": "string" }, "description": "Company ids to be linked with deal" }, "linkContactIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids for contacts to be linked with deal" }, "unlinkCompanyIds": { "type": "array", "items": { "type": "string" }, "description": "Company ids to be unlinked from deal" }, "unlinkContactIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Contact ids for contacts to be unlinked from deal" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_crm\_update\_crm\_notes\_by\_id Update a note **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Note ID to update | | `companyIds` | string\[] | No | — | Company Ids linked to a note | | `contactIds` | integer\[] | No | — | Contact Ids linked to a note | | `dealIds` | string\[] | No | — | Deal Ids linked to a note | | `text` | string | Yes | — | Content of the note. Supports HTML for rich text formatting. Supported tags include: `<p>` (paragraph), `<b>` / `<strong>` (bold), `<i>` / `<em>` (italic), `<u>` (underline), `<br>` (line break), `<a href="...">` (labelled hyperlink). Example labelled link: `<a href="https://example.com">Link text</a>`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Note ID to update" }, "companyIds": { "type": "array", "items": { "type": "string" }, "description": "Company Ids linked to a note" }, "contactIds": { "type": "array", "items": { "type": "integer" }, "description": "Contact Ids linked to a note" }, "dealIds": { "type": "array", "items": { "type": "string" }, "description": "Deal Ids linked to a note" }, "text": { "type": "string", "description": "Content of the note. Supports HTML for rich text formatting. Supported tags include: `

      ` (paragraph), `` / `` (bold), `` / `` (italic), `` (underline), `
      ` (line break), `` (labelled hyperlink). Example labelled link: `Link text`." } }, "required": [ "PCID", "id", "text" ] } ``` *** ## brevo\_crm\_update\_crm\_tasks\_by\_id Update a task **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | The id value | | `assignToId` | string | No | — | To assign a task to a user you can use either the account email or ID. | | `companiesIds` | string\[] | No | — | Companies ids for companies a task is linked to | | `contactsIds` | integer\[] | No | — | Contact ids for contacts linked to this task | | `date` | string | No | — | Task date/time | | `dealsIds` | string\[] | No | — | Deal ids for deals a task is linked to | | `done` | boolean | No | — | Task marked as done | | `duration` | integer | No | — | Duration of task in milliseconds \[1 minute = 60000 ms] | | `name` | string | No | — | Name of task | | `notes` | string | No | — | Notes added to a task | | `reminder` | object | No | — | Task reminder date/time for a task | | `taskTypeId` | string | No | — | Id for type of task e.g Call / Email / Meeting etc. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "assignToId": { "type": "string", "description": "To assign a task to a user you can use either the account email or ID." }, "companiesIds": { "type": "array", "items": { "type": "string" }, "description": "Companies ids for companies a task is linked to" }, "contactsIds": { "type": "array", "items": { "type": "integer" }, "description": "Contact ids for contacts linked to this task" }, "date": { "type": "string", "description": "Task date/time" }, "dealsIds": { "type": "array", "items": { "type": "string" }, "description": "Deal ids for deals a task is linked to" }, "done": { "type": "boolean", "description": "Task marked as done" }, "duration": { "type": "integer", "description": "Duration of task in milliseconds [1 minute = 60000 ms]" }, "name": { "type": "string", "description": "Name of task" }, "notes": { "type": "string", "description": "Notes added to a task" }, "reminder": { "type": "object", "description": "Task reminder date/time for a task", "properties": { "types": { "type": "array", "items": { "type": "string", "enum": [ "email", "push" ] }, "description": "Type of task reminder e.g email, push" }, "unit": { "type": "string", "description": "Unit of time before reminder is to be sent", "enum": [ "minutes", "hours", "weeks", "days" ] }, "value": { "type": "integer", "description": "Value of time unit before reminder is to be sent" } }, "required": [ "value", "unit", "types" ] }, "taskTypeId": { "type": "string", "description": "Id for type of task e.g Call / Email / Meeting etc." } }, "required": [ "PCID", "id" ] } ``` # brevo-ecommerce Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/brevo/brevo-ecommerce Brevo Ecommerce **Server path:** `/brevo-ecommerce` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`brevo_ecommerce_create_batch_order`](#brevo_ecommerce_create_batch_order) | Create orders in batch | | [`brevo_ecommerce_create_coupon_collection`](#brevo_ecommerce_create_coupon_collection) | Create а coupon collection | | [`brevo_ecommerce_create_coupons`](#brevo_ecommerce_create_coupons) | Create coupons for a coupon collection | | [`brevo_ecommerce_create_ecommerce_activate`](#brevo_ecommerce_create_ecommerce_activate) | Activate the eCommerce app | | [`brevo_ecommerce_create_order`](#brevo_ecommerce_create_order) | Managing the status of the order | | [`brevo_ecommerce_create_payment_request`](#brevo_ecommerce_create_payment_request) | Create a payment request | | [`brevo_ecommerce_create_product_alert`](#brevo_ecommerce_create_product_alert) | Create a product alert for a contact | | [`brevo_ecommerce_create_update_batch_category`](#brevo_ecommerce_create_update_batch_category) | Create categories in batch | | [`brevo_ecommerce_create_update_batch_products`](#brevo_ecommerce_create_update_batch_products) | Create products in batch | | [`brevo_ecommerce_create_update_category`](#brevo_ecommerce_create_update_category) | Create/Update a category | | [`brevo_ecommerce_create_update_product`](#brevo_ecommerce_create_update_product) | Create/Update a product | | [`brevo_ecommerce_delete_payment_request`](#brevo_ecommerce_delete_payment_request) | Delete a payment request. | | [`brevo_ecommerce_get_attribution_metrics_by_conversion_source_by_conversion_source_id`](#brevo_ecommerce_get_attribution_metrics_by_conversion_source_by_conversion_source_id) | Get detailed attribution metrics for a single Brevo campaign or workflow | | [`brevo_ecommerce_get_attribution_products_by_conversion_source_by_conversion_source_id`](#brevo_ecommerce_get_attribution_products_by_conversion_source_by_conversion_source_id) | Get attributed product sales for a single Brevo campaign or workflow | | [`brevo_ecommerce_get_categories`](#brevo_ecommerce_get_categories) | Return all your categories | | [`brevo_ecommerce_get_category_info`](#brevo_ecommerce_get_category_info) | Get a category details | | [`brevo_ecommerce_get_coupon_collection`](#brevo_ecommerce_get_coupon_collection) | Get a coupon collection by id | | [`brevo_ecommerce_get_coupon_collections`](#brevo_ecommerce_get_coupon_collections) | Get all your coupon collections | | [`brevo_ecommerce_get_orders`](#brevo_ecommerce_get_orders) | Get order details | | [`brevo_ecommerce_get_payment_request`](#brevo_ecommerce_get_payment_request) | Get payment request details | | [`brevo_ecommerce_get_product_info`](#brevo_ecommerce_get_product_info) | Get a product's details | | [`brevo_ecommerce_get_products`](#brevo_ecommerce_get_products) | Return all your products | | [`brevo_ecommerce_list_ecommerce_attribution_metrics`](#brevo_ecommerce_list_ecommerce_attribution_metrics) | Get attribution metrics for one or more Brevo campaigns or workflows | | [`brevo_ecommerce_list_ecommerce_config_display_currency`](#brevo_ecommerce_list_ecommerce_config_display_currency) | Get the ISO 4217 compliant display currency code for your Brevo account | | [`brevo_ecommerce_set_config_display_currency`](#brevo_ecommerce_set_config_display_currency) | Set the ISO 4217 compliant display currency code for your Brevo account | | [`brevo_ecommerce_update_coupon_collection`](#brevo_ecommerce_update_coupon_collection) | Update a coupon collection by id | *** ## brevo\_ecommerce\_create\_batch\_order Create orders in batch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `historical` | boolean | No | — | Defines whether you want your orders to be considered as live data or as historical data (import of past data, synchronising data). True: orders will not trigger any automation workflows. False: orders will trigger workflows as usual. | | `notifyUrl` | string | No | — | Webhook URL to receive the status of the batch request | | `orders` | object\[] | Yes | — | array of order objects | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "historical": { "type": "boolean", "description": "Defines whether you want your orders to be considered as live data or as historical data (import of past data, synchronising data). True: orders will not trigger any automation workflows. False: orders will trigger workflows as usual." }, "notifyUrl": { "type": "string", "description": "Webhook URL to receive the status of the batch request" }, "orders": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "description": "Total amount of the order, including all shipping expenses, tax and the price of items." }, "billing": { "type": "object", "description": "Billing details of an order." }, "coupons": { "type": "array", "items": { "type": "string" }, "description": "Coupons applied to the order. Stored case insensitive." }, "createdAt": { "type": "string", "description": "Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created." }, "id": { "type": "string", "description": "Unique ID of the order." }, "identifiers": { "type": "object", "description": "Identifies the contact associated with the order." }, "metaInfo": { "type": "object", "description": "Meta data of order to store additional detail such as custom message, customer type, source." }, "products": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "number", "description": "The price of a unit of product" }, "productId": { "type": "string", "description": "ID of the product." }, "variantId": { "type": "string", "description": "Product ID of the red color shirts." }, "quantity": { "type": "integer", "description": "**Required if quantityFloat is empty.** Number of product units added to the cart (whole numbers only, e.g., 10) " }, "quantityFloat": { "type": "number", "description": "**Required if quantity is empty.** Number of product units added to the cart(supports decimals, e.g., 20.52) " } } }, "description": "The products value" }, "status": { "type": "string", "description": "State of the order." }, "storeId": { "type": "string", "description": "ID of store where the order is placed" }, "updatedAt": { "type": "string", "description": "Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated." } }, "required": [ "id", "createdAt", "updatedAt", "status", "amount", "products" ] }, "description": "array of order objects" } }, "required": [ "PCID", "orders" ] } ``` *** ## brevo\_ecommerce\_create\_coupon\_collection Create а coupon collection **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `defaultCoupon` | string | Yes | — | Default coupons collection name | | `expirationDate` | string | No | — | Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date. | | `name` | string | Yes | — | Name of the coupons collection | | `remainingCouponsAlert` | integer | No | — | Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts. | | `remainingDaysAlert` | integer | No | — | Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "defaultCoupon": { "type": "string", "description": "Default coupons collection name" }, "expirationDate": { "type": "string", "description": "Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date." }, "name": { "type": "string", "description": "Name of the coupons collection" }, "remainingCouponsAlert": { "type": "integer", "description": "Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts." }, "remainingDaysAlert": { "type": "integer", "description": "Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts." } }, "required": [ "PCID", "defaultCoupon", "name" ] } ``` *** ## brevo\_ecommerce\_create\_coupons Create coupons for a coupon collection **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `collectionId` | string | Yes | — | The id of the coupon collection for which the coupons will be created | | `coupons` | string\[] | Yes | — | The coupons value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "collectionId": { "type": "string", "description": "The id of the coupon collection for which the coupons will be created" }, "coupons": { "type": "array", "items": { "type": "string" }, "description": "The coupons value" } }, "required": [ "PCID", "collectionId", "coupons" ] } ``` *** ## brevo\_ecommerce\_create\_ecommerce\_activate Activate the eCommerce app ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_ecommerce\_create\_order Managing the status of the order **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `amount` | number | Yes | — | Total amount of the order, including all shipping expenses, tax and the price of items. | | `billing` | object | No | — | Billing details of an order. | | `coupons` | string\[] | No | — | Coupons applied to the order. Stored case insensitive. | | `createdAt` | string | Yes | — | Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created. | | `id` | string | Yes | — | Unique ID of the order. | | `identifiers` | object | No | — | Identifies the contact associated with the order. | | `metaInfo` | object | No | — | Meta data of order to store additional detail such as custom message, customer type, source. | | `products` | object\[] | Yes | — | The products value | | `status` | string | Yes | — | State of the order. | | `storeId` | string | No | — | ID of store where the order is placed | | `updatedAt` | string | Yes | — | Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "amount": { "type": "number", "description": "Total amount of the order, including all shipping expenses, tax and the price of items." }, "billing": { "type": "object", "description": "Billing details of an order.", "properties": { "address": { "type": "string", "description": "Full billing address." }, "city": { "type": "string", "description": "Exact city of the address." }, "country": { "type": "string", "description": "Billing country name." }, "countryCode": { "type": "string", "description": "Billing country 2-letter ISO code." }, "paymentMethod": { "type": "string", "description": "How the visitor will pay for the item(s), e.g. paypal, check, etc." }, "phone": { "type": "string", "description": "Billing phone number." }, "postCode": { "type": "string", "description": "Postcode for delivery and billing." }, "region": { "type": "string", "description": "Exact region (state/province) for delivery and billing." } } }, "coupons": { "type": "array", "items": { "type": "string" }, "description": "Coupons applied to the order. Stored case insensitive." }, "createdAt": { "type": "string", "description": "Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created." }, "id": { "type": "string", "description": "Unique ID of the order." }, "identifiers": { "type": "object", "description": "Identifies the contact associated with the order.", "properties": { "email_id": { "type": "string", "description": "Email of the contact associated with the order" }, "ext_id": { "type": "string", "description": "ext_id associated with the order" }, "loyalty_subscription_id": { "type": "string", "description": "loyalty_subscription_id associated with the order" }, "phone_id": { "type": "string", "description": "Phone number of the contact associated with the order" } } }, "metaInfo": { "type": "object", "description": "Meta data of order to store additional detail such as custom message, customer type, source." }, "products": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "number", "description": "The price of a unit of product" }, "productId": { "type": "string", "description": "ID of the product." }, "variantId": { "type": "string", "description": "Product ID of the red color shirts." }, "quantity": { "type": "integer", "description": "**Required if quantityFloat is empty.** Number of product units added to the cart (whole numbers only, e.g., 10)" }, "quantityFloat": { "type": "number", "description": "**Required if quantity is empty.** Number of product units added to the cart(supports decimals, e.g., 20.52)" } }, "required": [ "productId", "price" ] }, "description": "The products value" }, "status": { "type": "string", "description": "State of the order." }, "storeId": { "type": "string", "description": "ID of store where the order is placed" }, "updatedAt": { "type": "string", "description": "Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated." } }, "required": [ "PCID", "amount", "createdAt", "id", "products", "status", "updatedAt" ] } ``` *** ## brevo\_ecommerce\_create\_payment\_request Create a payment request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `cart` | object | Yes | — | Specify the payment currency and amount. | | `configuration` | object | No | — | Optional. Redirect contact to a custom success page once payment is successful. If empty the default Brevo page will be displayed once a payment is validated | | `contactId` | integer | Yes | — | Brevo ID of the contact requested to pay. | | `description` | string | No | — | Description of payment request. | | `notification` | object | No | — | Optional. Use this object if you want to let Brevo send an email to the contact, with the payment request URL. If empty, no notifications (message and reminders) will be sent. | | `reference` | string | Yes | — | Reference of the payment request, it will appear on the payment page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cart": { "type": "object", "description": "Specify the payment currency and amount.", "properties": { "currency": { "type": "string", "description": "Currency code for the payment amount.", "enum": [ "EUR" ] }, "specificAmount": { "type": "integer", "description": "Payment amount, in cents. e.g. if you want to request €12.00, then the amount in cents is 1200." } }, "required": [ "currency", "specificAmount" ] }, "configuration": { "description": "Optional. Redirect contact to a custom success page once payment is successful. If empty the default Brevo page will be displayed once a payment is validated" }, "contactId": { "type": "integer", "description": "Brevo ID of the contact requested to pay." }, "description": { "type": "string", "description": "Description of payment request." }, "notification": { "type": "object", "description": "Optional. Use this object if you want to let Brevo send an email to the contact, with the payment request URL. If empty, no notifications (message and reminders) will be sent.", "properties": { "channel": { "type": "string", "description": "Channel used to send the notifications.", "enum": [ "email" ] }, "text": { "type": "string", "description": "Use this field if you want to give more context to your contact about the payment request." } }, "required": [ "channel", "text" ] }, "reference": { "type": "string", "description": "Reference of the payment request, it will appear on the payment page." } }, "required": [ "PCID", "cart", "contactId", "reference" ] } ``` *** ## brevo\_ecommerce\_create\_product\_alert Create a product alert for a contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Product ID | | `type` | string | Yes | — | Alert type | | `contactIdentifiers` | object | No | — | Contact Identifiers | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Product ID" }, "type": { "type": "string", "description": "Alert type", "enum": [ "back_in_stock" ] }, "contactIdentifiers": { "type": "object", "description": "Contact Identifiers", "properties": { "email": { "type": "string", "description": "Email address of the contact" }, "ext_id": { "type": "string", "description": "Contact ID in your system" }, "sms": { "type": "string", "description": "Sms of the contact" } } } }, "required": [ "PCID", "id", "type" ] } ``` *** ## brevo\_ecommerce\_create\_update\_batch\_category Create categories in batch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `categories` | object\[] | Yes | — | array of categories objects | | `updateEnabled` | boolean | No | — | Facilitate to update the existing categories in the same request (updateEnabled = true) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categories": { "type": "array", "items": { "type": "object", "properties": { "deletedAt": { "type": "string", "description": "UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database" }, "id": { "type": "string", "description": "Unique Category ID as saved in the shop" }, "isDeleted": { "type": "boolean", "description": "category deleted from the shop's database" }, "name": { "type": "string", "description": "**Mandatory in case of creation**. Name of the Category, as displayed in the shop" }, "url": { "type": "string", "description": "URL to the category" } }, "required": [ "id" ] }, "description": "array of categories objects" }, "updateEnabled": { "type": "boolean", "description": "Facilitate to update the existing categories in the same request (updateEnabled = true)" } }, "required": [ "PCID", "categories" ] } ``` *** ## brevo\_ecommerce\_create\_update\_batch\_products Create products in batch **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `products` | object\[] | Yes | — | array of products objects | | `updateEnabled` | boolean | No | — | Facilitate to update the existing products in the same request (updateEnabled = true) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "products": { "type": "array", "items": { "type": "object", "properties": { "brand": { "type": "string", "description": "Brand of the product" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Category ID-s of the product" }, "deletedAt": { "type": "string", "description": "UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database" }, "description": { "type": "string", "description": "Description of the product" }, "id": { "type": "string", "format": "string", "description": "Product ID for which you requested the details" }, "imageUrl": { "type": "string", "format": "string", "description": "Absolute URL to the cover image of the product" }, "isDeleted": { "type": "boolean", "description": "product deleted from the shop's database" }, "metaInfo": { "type": "object", "description": "Meta data of product such as description, vendor, producer, stock level. The total characters of cumulative metaInfo shall not exceed **20000 characters**." }, "name": { "type": "string", "description": "**Mandatory in case of creation**. Name of the product, as displayed in the shop" }, "parentId": { "type": "string", "format": "string", "description": "Parent product id of the product" }, "price": { "type": "number", "format": "float", "description": "Price of the product" }, "alternativePrice": { "type": "number", "format": "float", "description": "Alternative price of the product" }, "sku": { "type": "string", "format": "string", "description": "Product identifier from the shop" }, "stock": { "type": "number", "description": "Current stock value of the product from the shop's database" }, "url": { "type": "string", "format": "string", "description": "URL to the product" } }, "required": [ "id", "name" ] }, "description": "array of products objects" }, "updateEnabled": { "type": "boolean", "description": "Facilitate to update the existing products in the same request (updateEnabled = true)" } }, "required": [ "PCID", "products" ] } ``` *** ## brevo\_ecommerce\_create\_update\_category Create/Update a category **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `deletedAt` | string | No | — | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database | | `id` | string | Yes | — | Unique Category ID as saved in the shop | | `isDeleted` | boolean | No | — | category deleted from the shop's database | | `name` | string | No | — | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | | `updateEnabled` | boolean | No | — | Facilitate to update the existing category in the same request (updateEnabled = true) | | `url` | string | No | — | URL to the category | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deletedAt": { "type": "string", "description": "UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database" }, "id": { "type": "string", "description": "Unique Category ID as saved in the shop" }, "isDeleted": { "type": "boolean", "description": "category deleted from the shop's database" }, "name": { "type": "string", "description": "**Mandatory in case of creation**. Name of the Category, as displayed in the shop" }, "updateEnabled": { "type": "boolean", "description": "Facilitate to update the existing category in the same request (updateEnabled = true)" }, "url": { "type": "string", "description": "URL to the category" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_ecommerce\_create\_update\_product Create/Update a product **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `alternativePrice` | number | No | — | Alternative price of the product | | `brand` | string | No | — | Brand of the product | | `categories` | string\[] | No | — | Category ID-s of the product | | `deletedAt` | string | No | — | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database | | `description` | string | No | — | Description of the product | | `id` | string | Yes | — | Product ID for which you requested the details | | `imageUrl` | string | No | — | Absolute URL to the cover image of the product | | `isDeleted` | boolean | No | — | product deleted from the shop's database | | `metaInfo` | object | No | — | Meta data of product such as description, vendor, producer, stock level. The total characters of cumulative metaInfo shall not exceed **20000 characters**. | | `name` | string | Yes | — | **Mandatory in case of creation**. Name of the product, as displayed in the shop | | `parentId` | string | No | — | Parent product id of the product | | `price` | number | No | — | Price of the product | | `sku` | string | No | — | Product identifier from the shop | | `stock` | number | No | — | Current stock value of the product from the shop's database | | `updateEnabled` | boolean | No | — | Facilitate to update the existing product in the same request (updateEnabled = true) | | `url` | string | No | — | URL to the product | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "alternativePrice": { "type": "number", "description": "Alternative price of the product" }, "brand": { "type": "string", "description": "Brand of the product" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Category ID-s of the product" }, "deletedAt": { "type": "string", "description": "UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database" }, "description": { "type": "string", "description": "Description of the product" }, "id": { "type": "string", "description": "Product ID for which you requested the details" }, "imageUrl": { "type": "string", "description": "Absolute URL to the cover image of the product" }, "isDeleted": { "type": "boolean", "description": "product deleted from the shop's database" }, "metaInfo": { "type": "object", "description": "Meta data of product such as description, vendor, producer, stock level. The total characters of cumulative metaInfo shall not exceed **20000 characters**." }, "name": { "type": "string", "description": "**Mandatory in case of creation**. Name of the product, as displayed in the shop" }, "parentId": { "type": "string", "description": "Parent product id of the product" }, "price": { "type": "number", "description": "Price of the product" }, "sku": { "type": "string", "description": "Product identifier from the shop" }, "stock": { "type": "number", "description": "Current stock value of the product from the shop's database" }, "updateEnabled": { "type": "boolean", "description": "Facilitate to update the existing product in the same request (updateEnabled = true)" }, "url": { "type": "string", "description": "URL to the product" } }, "required": [ "PCID", "id", "name" ] } ``` *** ## brevo\_ecommerce\_delete\_payment\_request Delete a payment request. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | ID of the payment request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "ID of the payment request." } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_ecommerce\_get\_attribution\_metrics\_by\_conversion\_source\_by\_conversion\_source\_id Get detailed attribution metrics for a single Brevo campaign or workflow **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `conversionSource` | string | Yes | — | The Brevo campaign type or workflow type for which data will be retrieved | | `conversionSourceId` | string | Yes | — | The Brevo campaign or automation workflow id for which data will be retrieved | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "conversionSource": { "type": "string", "description": "The Brevo campaign type or workflow type for which data will be retrieved", "enum": [ "email_campaign", "sms_campaign", "automation_workflow_email", "automation_workflow_sms" ] }, "conversionSourceId": { "type": "string", "description": "The Brevo campaign or automation workflow id for which data will be retrieved" } }, "required": [ "PCID", "conversionSource", "conversionSourceId" ] } ``` *** ## brevo\_ecommerce\_get\_attribution\_products\_by\_conversion\_source\_by\_conversion\_source\_id Get attributed product sales for a single Brevo campaign or workflow **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `conversionSource` | string | Yes | — | The Brevo campaign or automation workflow type for which data will be retrieved | | `conversionSourceId` | string | Yes | — | The Brevo campaign or automation workflow id for which data will be retrieved | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "conversionSource": { "type": "string", "description": "The Brevo campaign or automation workflow type for which data will be retrieved", "enum": [ "email_campaign", "sms_campaign", "automation_workflow_email", "automation_workflow_sms" ] }, "conversionSourceId": { "type": "string", "description": "The Brevo campaign or automation workflow id for which data will be retrieved" } }, "required": [ "PCID", "conversionSource", "conversionSourceId" ] } ``` *** ## brevo\_ecommerce\_get\_categories Return all your categories **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of documents per page | | `offset` | integer | No | — | Index of the first document in the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | | `ids` | string\[] | No | — | Filter by category ids | | `name` | string | No | — | Filter by category name | | `modifiedSince` | string | No | — | Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | | `createdSince` | string | No | — | Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | | `isDeleted` | string | No | — | Filter categories by their deletion status. If `false` is passed, only categories that are not deleted will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "offset": { "type": "integer", "description": "Index of the first document in the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Filter by category ids" }, "name": { "type": "string", "description": "Filter by category name" }, "modifiedSince": { "type": "string", "description": "Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**" }, "createdSince": { "type": "string", "description": "Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**" }, "isDeleted": { "type": "string", "description": "Filter categories by their deletion status. If `false` is passed, only categories that are not deleted will be returned." } }, "required": [ "PCID" ] } ``` *** ## brevo\_ecommerce\_get\_category\_info Get a category details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Category ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Category ID" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_ecommerce\_get\_coupon\_collection Get a coupon collection by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Id of the collection to return | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Id of the collection to return" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_ecommerce\_get\_coupon\_collections Get all your coupon collections **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of documents returned per page | | `offset` | integer | No | — | Index of the first document on the page | | `sort` | string | No | — | Sort the results by creation time in ascending/descending order | | `sortBy` | string | No | — | The field used to sort coupon collections | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of documents returned per page" }, "offset": { "type": "integer", "description": "Index of the first document on the page" }, "sort": { "type": "string", "description": "Sort the results by creation time in ascending/descending order", "enum": [ "asc", "desc" ] }, "sortBy": { "type": "string", "description": "The field used to sort coupon collections", "enum": [ "createdAt", "remainingCoupons", "expirationDate" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_ecommerce\_get\_orders Get order details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of documents per page | | `offset` | integer | No | — | Index of the first document in the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | | `modifiedSince` | string | No | — | Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | | `createdSince` | string | No | — | Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "offset": { "type": "integer", "description": "Index of the first document in the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] }, "modifiedSince": { "type": "string", "description": "Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**" }, "createdSince": { "type": "string", "description": "Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**" } }, "required": [ "PCID" ] } ``` *** ## brevo\_ecommerce\_get\_payment\_request Get payment request details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Id of the payment Request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Id of the payment Request" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_ecommerce\_get\_product\_info Get a product's details **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Product ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Product ID" } }, "required": [ "PCID", "id" ] } ``` *** ## brevo\_ecommerce\_get\_products Return all your products **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of documents per page | | `offset` | integer | No | — | Index of the first document in the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | | `ids` | string\[] | No | — | Filter by product ids | | `search` | string | No | — | Search products simultaneously across SKU, name, and ID fields. Results are returned in the following priority order: **exact SKU match** > **SKU prefix match** > **name match** > **ID match**. For example, `?search=123` on products with `{sku: "123"}` and `{sku: "123456"}` returns the exact SKU match first. | | `name` | string | No | — | Filter by product name, minimum 3 characters should be present for search. | | `price[lte]` | number | No | — | Price filter for products less than and equals to particular amount | | `price[gte]` | number | No | — | Price filter for products greater than and equals to particular amount | | `price[lt]` | number | No | — | Price filter for products less than particular amount | | `price[gt]` | number | No | — | Price filter for products greater than particular amount | | `price[eq]` | number | No | — | Price filter for products equals to particular amount | | `price[ne]` | number | No | — | Price filter for products not equals to particular amount | | `alternativePrice[lte]` | number | No | — | Alternative price filter for products less than and equals to particular amount | | `alternativePrice[gte]` | number | No | — | Alternative price filter for products greater than and equals to particular amount | | `alternativePrice[lt]` | number | No | — | Alternative price filter for products less than particular amount | | `alternativePrice[gt]` | number | No | — | Alternative price filter for products greater than particular amount | | `alternativePrice[eq]` | number | No | — | Alternative price filter for products equals to particular amount | | `alternativePrice[ne]` | number | No | — | Alternative price filter for products not equals to particular amount | | `categories` | string\[] | No | — | Filter by categories ids | | `modifiedSince` | string | No | — | Filter (urlencoded) the products modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | | `createdSince` | string | No | — | Filter (urlencoded) the products created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** | | `sortByField` | string | No | — | Sort the results by a specific field. Default sort field is `created_at` when not passed. | | `isDeleted` | string | No | — | Filter products by their deletion status. If `false` is passed, only products that are not deleted will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of documents per page" }, "offset": { "type": "integer", "description": "Index of the first document in the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Filter by product ids" }, "search": { "type": "string", "description": "Search products simultaneously across SKU, name, and ID fields. Results are returned in the following priority order: **exact SKU match** > **SKU prefix match** > **name match** > **ID match**. For example, `?search=123` on products with `{sku: \"123\"}` and `{sku: \"123456\"}` returns the exact SKU match first." }, "name": { "type": "string", "description": "Filter by product name, minimum 3 characters should be present for search." }, "price[lte]": { "type": "number", "description": "Price filter for products less than and equals to particular amount" }, "price[gte]": { "type": "number", "description": "Price filter for products greater than and equals to particular amount" }, "price[lt]": { "type": "number", "description": "Price filter for products less than particular amount" }, "price[gt]": { "type": "number", "description": "Price filter for products greater than particular amount" }, "price[eq]": { "type": "number", "description": "Price filter for products equals to particular amount" }, "price[ne]": { "type": "number", "description": "Price filter for products not equals to particular amount" }, "alternativePrice[lte]": { "type": "number", "description": "Alternative price filter for products less than and equals to particular amount" }, "alternativePrice[gte]": { "type": "number", "description": "Alternative price filter for products greater than and equals to particular amount" }, "alternativePrice[lt]": { "type": "number", "description": "Alternative price filter for products less than particular amount" }, "alternativePrice[gt]": { "type": "number", "description": "Alternative price filter for products greater than particular amount" }, "alternativePrice[eq]": { "type": "number", "description": "Alternative price filter for products equals to particular amount" }, "alternativePrice[ne]": { "type": "number", "description": "Alternative price filter for products not equals to particular amount" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Filter by categories ids" }, "modifiedSince": { "type": "string", "description": "Filter (urlencoded) the products modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**" }, "createdSince": { "type": "string", "description": "Filter (urlencoded) the products created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**" }, "sortByField": { "type": "string", "description": "Sort the results by a specific field. Default sort field is `created_at` when not passed.", "enum": [ "created_at", "name", "price", "id" ] }, "isDeleted": { "type": "string", "description": "Filter products by their deletion status. If `false` is passed, only products that are not deleted will be returned." } }, "required": [ "PCID" ] } ``` *** ## brevo\_ecommerce\_list\_ecommerce\_attribution\_metrics Get attribution metrics for one or more Brevo campaigns or workflows **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `periodFrom` | string | No | — | When getting metrics for a specific period, define the starting datetime in RFC3339 format | | `periodTo` | string | No | — | When getting metrics for a specific period, define the end datetime in RFC3339 format | | `emailCampaignId[]` | string\[] | No | — | The email campaign ID(s) to get metrics for | | `smsCampaignId[]` | string\[] | No | — | The SMS campaign ID(s) to get metrics for | | `automationWorkflowEmailId[]` | string\[] | No | — | The automation workflow ID(s) to get email attribution metrics for | | `automationWorkflowSmsId[]` | string\[] | No | — | The automation workflow ID(s) to get SMS attribution metrics for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "periodFrom": { "type": "string", "description": "When getting metrics for a specific period, define the starting datetime in RFC3339 format" }, "periodTo": { "type": "string", "description": "When getting metrics for a specific period, define the end datetime in RFC3339 format" }, "emailCampaignId[]": { "type": "array", "items": { "type": "string" }, "description": "The email campaign ID(s) to get metrics for" }, "smsCampaignId[]": { "type": "array", "items": { "type": "string" }, "description": "The SMS campaign ID(s) to get metrics for" }, "automationWorkflowEmailId[]": { "type": "array", "items": { "type": "string" }, "description": "The automation workflow ID(s) to get email attribution metrics for" }, "automationWorkflowSmsId[]": { "type": "array", "items": { "type": "string" }, "description": "The automation workflow ID(s) to get SMS attribution metrics for" } }, "required": [ "PCID" ] } ``` *** ## brevo\_ecommerce\_list\_ecommerce\_config\_display\_currency Get the ISO 4217 compliant display currency code for your Brevo account ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_ecommerce\_set\_config\_display\_currency Set the ISO 4217 compliant display currency code for your Brevo account **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `code` | string | Yes | — | ISO 4217 compliant display currency code | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "code": { "type": "string", "description": "ISO 4217 compliant display currency code" } }, "required": [ "PCID", "code" ] } ``` *** ## brevo\_ecommerce\_update\_coupon\_collection Update a coupon collection by id **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `id` | string | Yes | — | Id of the collection to update | | `defaultCoupon` | string | No | — | A default coupon to be used in case there are no coupons left | | `expirationDate` | string | No | — | Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date. | | `remainingCouponsAlert` | integer | No | — | Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts. | | `remainingDaysAlert` | integer | No | — | Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "Id of the collection to update" }, "defaultCoupon": { "type": "string", "description": "A default coupon to be used in case there are no coupons left" }, "expirationDate": { "type": "string", "description": "Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date." }, "remainingCouponsAlert": { "type": "integer", "description": "Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts." }, "remainingDaysAlert": { "type": "integer", "description": "Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts." } }, "required": [ "PCID", "id" ] } ``` # brevo-email Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/brevo/brevo-email Brevo Email **Server path:** `/brevo-email` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`brevo_email_block_new_domain`](#brevo_email_block_new_domain) | Add a new domain to the list of blocked domains | | [`brevo_email_create_email_campaign`](#brevo_email_create_email_campaign) | Create an email campaign | | [`brevo_email_create_sender`](#brevo_email_create_sender) | Create email sender | | [`brevo_email_create_smtp_template`](#brevo_email_create_smtp_template) | Create an email template | | [`brevo_email_delete_blocked_domain`](#brevo_email_delete_blocked_domain) | Unblock an existing domain from the list of blocked domains | | [`brevo_email_delete_campaign`](#brevo_email_delete_campaign) | Delete an email campaign | | [`brevo_email_delete_hardbounces`](#brevo_email_delete_hardbounces) | Delete hardbounces | | [`brevo_email_delete_scheduled_email_by_id`](#brevo_email_delete_scheduled_email_by_id) | Delete scheduled emails by batchId or messageId | | [`brevo_email_delete_sender`](#brevo_email_delete_sender) | Delete a sender | | [`brevo_email_delete_smtp_blocked_contacts_by_email`](#brevo_email_delete_smtp_blocked_contacts_by_email) | Unblock or resubscribe a transactional contact | | [`brevo_email_delete_smtp_log_by_identifier`](#brevo_email_delete_smtp_log_by_identifier) | Delete an SMTP transactional log | | [`brevo_email_delete_smtp_template`](#brevo_email_delete_smtp_template) | Delete an inactive email template | | [`brevo_email_export_recipients`](#brevo_email_export_recipients) | Export the recipients of an email campaign | | [`brevo_email_get_ab_test_campaign_result`](#brevo_email_get_ab_test_campaign_result) | Get an A/B test email campaign results | | [`brevo_email_get_aggregated_smtp_report`](#brevo_email_get_aggregated_smtp_report) | Get your transactional email activity aggregated over a period of time | | [`brevo_email_get_blocked_domains`](#brevo_email_get_blocked_domains) | Get the list of blocked domains | | [`brevo_email_get_campaign`](#brevo_email_get_campaign) | Get an email campaign report | | [`brevo_email_get_campaigns`](#brevo_email_get_campaigns) | Return all your created email campaigns | | [`brevo_email_get_event_report`](#brevo_email_get_event_report) | Get all your transactional email activity (unaggregated events) | | [`brevo_email_get_inbound_email_attachment`](#brevo_email_get_inbound_email_attachment) | Retrieve inbound attachment with download token. | | [`brevo_email_get_inbound_email_events`](#brevo_email_get_inbound_email_events) | Get the list of all the events for the received emails. | | [`brevo_email_get_inbound_email_events_by_uuid`](#brevo_email_get_inbound_email_events_by_uuid) | Fetch all events history for one particular received email. | | [`brevo_email_get_ips`](#brevo_email_get_ips) | Get all the dedicated IPs for your account | | [`brevo_email_get_ips_from_sender`](#brevo_email_get_ips_from_sender) | Get all the dedicated IPs for a specific sender | | [`brevo_email_get_scheduled_email_by_id`](#brevo_email_get_scheduled_email_by_id) | Fetch scheduled emails by batchId or messageId | | [`brevo_email_get_senders`](#brevo_email_get_senders) | Get email senders | | [`brevo_email_get_shared_template_url`](#brevo_email_get_shared_template_url) | Get a shared template url | | [`brevo_email_get_smstemplates`](#brevo_email_get_smstemplates) | Return all your created SMS templates | | [`brevo_email_get_smtp_report`](#brevo_email_get_smtp_report) | Get your transactional email activity aggregated per day | | [`brevo_email_get_smtp_template`](#brevo_email_get_smtp_template) | Returns the template information | | [`brevo_email_get_smtp_templates`](#brevo_email_get_smtp_templates) | Get the list of email templates | | [`brevo_email_get_transac_blocked_contacts`](#brevo_email_get_transac_blocked_contacts) | Get the list of blocked or unsubscribed transactional contacts | | [`brevo_email_get_transac_email_content`](#brevo_email_get_transac_email_content) | Get the personalized content of a sent transactional email | | [`brevo_email_get_transac_emails_list`](#brevo_email_get_transac_emails_list) | Get the list of transactional emails on the basis of allowed filters | | [`brevo_email_post_preview_smtp_email_templates`](#brevo_email_post_preview_smtp_email_templates) | Generate the rendered preview of transactional template | | [`brevo_email_send_email_campaign_now`](#brevo_email_send_email_campaign_now) | Send an email campaign immediately, based on campaignId | | [`brevo_email_send_report`](#brevo_email_send_report) | Send the report of a campaign | | [`brevo_email_send_test_email`](#brevo_email_send_test_email) | Send an email campaign to your test list | | [`brevo_email_send_test_template`](#brevo_email_send_test_template) | Send a template to your test list | | [`brevo_email_send_transac_email`](#brevo_email_send_transac_email) | Send a transactional email | | [`brevo_email_update_campaign_status`](#brevo_email_update_campaign_status) | Update an email campaign status | | [`brevo_email_update_email_campaign`](#brevo_email_update_email_campaign) | Update an email campaign | | [`brevo_email_update_sender`](#brevo_email_update_sender) | Update a sender | | [`brevo_email_update_smtp_template`](#brevo_email_update_smtp_template) | Update an email template | | [`brevo_email_upload_image_to_gallery`](#brevo_email_upload_image_to_gallery) | Upload an image to your account's image gallery | | [`brevo_email_validate_sender_by_otp`](#brevo_email_validate_sender_by_otp) | Validate a sender using OTP | *** ## brevo\_email\_block\_new\_domain Add a new domain to the list of blocked domains **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `domain` | string | Yes | — | name of the domain to be blocked | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "domain": { "type": "string", "description": "name of the domain to be blocked" } }, "required": [ "PCID", "domain" ] } ``` *** ## brevo\_email\_create\_email\_campaign Create an email campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `abTesting` | boolean | No | — | Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. **subjectA, subjectB, splitRule, winnerCriteria & winnerDelay** will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. **Can be set to true only if sendAtBestTime is false**. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | | `attachmentUrl` | string | No | — | Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | | `emailExpirationDate` | object | No | — | To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. Learn more about setting an email expiration date. For reference , `https://help.brevo.com/hc/en-us/articles/4413566705298-Create-an-email-campaign` | | `footer` | string | No | — | Footer of the email campaign | | `header` | string | No | — | Header of the email campaign | | `htmlContent` | string | No | — | **Mandatory if htmlUrl and templateId are empty.** Body of the message (HTML). Must have more than 10 characters and be less than 1MB in size. Cannot be used together with `htmlUrl` or `templateId`. | | `htmlUrl` | string | No | — | **Mandatory if htmlContent and templateId are empty.** URL to the message (HTML). Cannot be used together with `htmlContent` or `templateId`. For example: **[https://html.domain.com](https://html.domain.com)** | | `increaseRate` | integer | No | — | **Mandatory if ipWarmupEnable is set to true**. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | | `initialQuota` | integer | No | — | **Mandatory if ipWarmupEnable is set to true**. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | | `inlineImageActivation` | boolean | No | — | Use true to embedded the images in your email. Final size of the email should be less than **4MB**. Campaigns with embedded images can *not be sent to more than 5000 contacts* | | `ipWarmupEnable` | boolean | No | — | **Available for dedicated ip clients**. Set this to true if you wish to warm up your ip. | | `mirrorActive` | boolean | No | — | Use true to enable the mirror link | | `name` | string | Yes | — | Name of the campaign | | `params` | object | No | — | Pass the set of attributes to customize the type classic campaign. For example: **\{"FNAME":"Joe", "LNAME":"Doe"}**. Only available if **type** is **classic**. It's considered only if campaign is in *New Template Language format*. The New Template Language is dependent on the values of **subject, htmlContent/htmlUrl, sender.name & toField** | | `previewText` | string | No | — | Preview text or preheader of the email campaign | | `recipients` | object | No | — | Segment ids and List ids to include/exclude from campaign | | `replyTo` | string | No | — | Email on which the campaign recipients will be able to reply to | | `scheduledAt` | string | No | — | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result**. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). For example: **2017-06-01T12:30:00+02:00** | | `sendAtBestTime` | boolean | No | — | Set this to true if you want to send your campaign at best time. | | `sender` | object | Yes | — | Sender details including id or email and name (optional). Only one of either Sender’s email or Sender’s ID shall be passed in one request at a time. Passing both `email` and `id` will result in an error. For example: **\{"name":"xyz", "email":"[example@abc.com](mailto:example@abc.com)"}** or **\{"name":"xyz", "id":123}** | | `splitRule` | integer | No | — | Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | | `subject` | string | No | — | Subject of the campaign. **Mandatory if abTesting is false**. Ignored if abTesting is true. | | `subjectA` | string | No | — | Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value | | `subjectB` | string | No | — | Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value | | `tag` | string | No | — | Tag of the campaign | | `templateId` | integer | No | — | **Mandatory if htmlContent and htmlUrl are empty.** Id of the transactional email template with status *active*. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. Cannot be used together with `htmlContent` or `htmlUrl`. | | `toField` | string | No | — | To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **\{FNAME} \{LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **\{\{contact.FNAME}} \{\{contact.LNAME}}** for personalization | | `unsubscriptionPageId` | string | No | — | Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used. | | `updateFormId` | string | No | — | **Mandatory if templateId is used containing the \{\{ update\_profile }} tag**. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used. | | `utmCampaign` | string | No | — | Customize the utm\_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | | `winnerCriteria` | string | No | — | Choose the metrics that will determinate the winning version. **Mandatory if *splitRule* >= 1 and \< 50**. If splitRule = 50, `winnerCriteria` is ignored if passed | | `winnerDelay` | integer | No | — | Choose the duration of the test in hours. Maximum is 7 days, pass 24\*7 = 168 hours. The winning version will be sent at the end of the test. **Mandatory if *splitRule* >= 1 and \< 50**. If splitRule = 50, `winnerDelay` is ignored if passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "abTesting": { "type": "boolean", "description": "Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. **subjectA, subjectB, splitRule, winnerCriteria & winnerDelay** will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. **Can be set to true only if sendAtBestTime is false**. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B" }, "attachmentUrl": { "type": "string", "description": "Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps" }, "emailExpirationDate": { "type": "object", "description": "To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. Learn more about setting an email expiration date. For reference , ``https://help.brevo.com/hc/en-us/articles/4413566705298-Create-an-email-campaign``", "properties": { "duration": { "type": "integer", "description": "Duration of the email expiry. maximum duration can be 3600 days or 480 weeks or 120 months." }, "unit": { "type": "string", "description": "unit of the duration", "enum": [ "days", "weeks", "months" ] } } }, "footer": { "type": "string", "description": "Footer of the email campaign" }, "header": { "type": "string", "description": "Header of the email campaign" }, "htmlContent": { "type": "string", "description": "**Mandatory if htmlUrl and templateId are empty.** Body of the message (HTML). Must have more than 10 characters and be less than 1MB in size. Cannot be used together with `htmlUrl` or `templateId`." }, "htmlUrl": { "type": "string", "description": "**Mandatory if htmlContent and templateId are empty.** URL to the message (HTML). Cannot be used together with `htmlContent` or `templateId`. For example: **https://html.domain.com**" }, "increaseRate": { "type": "integer", "description": "**Mandatory if ipWarmupEnable is set to true**. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%." }, "initialQuota": { "type": "integer", "description": "**Mandatory if ipWarmupEnable is set to true**. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000." }, "inlineImageActivation": { "type": "boolean", "description": "Use true to embedded the images in your email. Final size of the email should be less than **4MB**. Campaigns with embedded images can _not be sent to more than 5000 contacts_" }, "ipWarmupEnable": { "type": "boolean", "description": "**Available for dedicated ip clients**. Set this to true if you wish to warm up your ip." }, "mirrorActive": { "type": "boolean", "description": "Use true to enable the mirror link" }, "name": { "type": "string", "description": "Name of the campaign" }, "params": { "type": "object", "description": "Pass the set of attributes to customize the type classic campaign. For example: **{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}**. Only available if **type** is **classic**. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of **subject, htmlContent/htmlUrl, sender.name & toField**" }, "previewText": { "type": "string", "description": "Preview text or preheader of the email campaign" }, "recipients": { "type": "object", "description": "Segment ids and List ids to include/exclude from campaign", "properties": { "exclusionListIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "List ids to exclude from the campaign" }, "exclusionSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Segment ids which have to be excluded from a campaign." }, "listIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "**Mandatory if scheduledAt is not empty**. List Ids to send the campaign to" }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "**Mandatory if listIds are not used**. Segment ids to send the campaign to." } } }, "replyTo": { "type": "string", "description": "Email on which the campaign recipients will be able to reply to" }, "scheduledAt": { "type": "string", "description": "Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result**. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). For example: **2017-06-01T12:30:00+02:00**" }, "sendAtBestTime": { "type": "boolean", "description": "Set this to true if you want to send your campaign at best time." }, "sender": { "type": "object", "description": "Sender details including id or email and name (optional). Only one of either Sender’s email or Sender’s ID shall be passed in one request at a time. Passing both `email` and `id` will result in an error. For example: **{\"name\":\"xyz\", \"email\":\"example@abc.com\"}** or **{\"name\":\"xyz\", \"id\":123}**", "properties": { "email": { "type": "string", "description": "Sender email. Must be a valid email address. Cannot be used together with `id` in the same request." }, "id": { "type": "integer", "description": "Select the sender for the campaign on the basis of sender id. Cannot be used together with `email` in the same request. _In order to select a sender with a specific pool of IPs, dedicated IP users shall pass id (instead of email)._" }, "name": { "type": "string", "description": "Sender Name" } } }, "splitRule": { "type": "integer", "description": "Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else" }, "subject": { "type": "string", "description": "Subject of the campaign. **Mandatory if abTesting is false**. Ignored if abTesting is true." }, "subjectA": { "type": "string", "description": "Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value" }, "subjectB": { "type": "string", "description": "Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value" }, "tag": { "type": "string", "description": "Tag of the campaign" }, "templateId": { "type": "integer", "description": "**Mandatory if htmlContent and htmlUrl are empty.** Id of the transactional email template with status _active_. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. Cannot be used together with `htmlContent` or `htmlUrl`." }, "toField": { "type": "string", "description": "To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization" }, "unsubscriptionPageId": { "type": "string", "description": "Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used." }, "updateFormId": { "type": "string", "description": "**Mandatory if templateId is used containing the {{ update_profile }} tag**. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used." }, "utmCampaign": { "type": "string", "description": "Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed" }, "winnerCriteria": { "type": "string", "description": "Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed", "enum": [ "open", "click" ] }, "winnerDelay": { "type": "integer", "description": "Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerDelay` is ignored if passed" } }, "required": [ "PCID", "name", "sender" ] } ``` *** ## brevo\_email\_create\_sender Create email sender **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `email` | string | Yes | — | From email to use for the sender. A verification email will be sent to this address. | | `ips` | object\[] | No | — | **Mandatory in case of dedicated IP**. IPs to associate to the sender. Not required for standard accounts. | | `name` | string | Yes | — | From Name to use for the sender | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email": { "type": "string", "description": "From email to use for the sender. A verification email will be sent to this address." }, "ips": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain of the IP" }, "ip": { "type": "string", "description": "Dedicated IP available in your account" }, "weight": { "type": "integer", "format": "int64", "description": "Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs." } }, "required": [ "domain", "ip" ] }, "description": "**Mandatory in case of dedicated IP**. IPs to associate to the sender. Not required for standard accounts." }, "name": { "type": "string", "description": "From Name to use for the sender" } }, "required": [ "PCID", "email", "name" ] } ``` *** ## brevo\_email\_create\_smtp\_template Create an email template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attachmentUrl` | string | No | — | Absolute url of the attachment (**no local file**). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps' | | `htmlContent` | string | No | — | Body of the message (HTML version). The field must have more than 10 characters. **REQUIRED if htmlUrl is empty** | | `htmlUrl` | string | No | — | Url which contents the body of the email message. REQUIRED if htmlContent is empty | | `isActive` | boolean | No | — | Status of template. isActive = true means template is active and isActive = false means template is inactive | | `replyTo` | string | No | — | Email on which campaign recipients will be able to reply to | | `sender` | object | Yes | — | Sender details including id or email and name (*optional*). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **\{"name":"xyz", "email":"[example@abc.com](mailto:example@abc.com)"}** **\{"name":"xyz", "id":123}** | | `subject` | string | Yes | — | Subject of the template | | `tag` | string | No | — | Tag of the template | | `templateName` | string | Yes | — | Name of the template | | `toField` | string | No | — | To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **\{FNAME} \{LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **\{\{contact.FNAME}} \{\{contact.LNAME}}** for personalization | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attachmentUrl": { "type": "string", "description": "Absolute url of the attachment (**no local file**). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'" }, "htmlContent": { "type": "string", "description": "Body of the message (HTML version). The field must have more than 10 characters. **REQUIRED if htmlUrl is empty**" }, "htmlUrl": { "type": "string", "description": "Url which contents the body of the email message. REQUIRED if htmlContent is empty" }, "isActive": { "type": "boolean", "description": "Status of template. isActive = true means template is active and isActive = false means template is inactive" }, "replyTo": { "type": "string", "description": "Email on which campaign recipients will be able to reply to" }, "sender": { "type": "object", "description": "Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{\"name\":\"xyz\", \"email\":\"example@abc.com\"}** **{\"name\":\"xyz\", \"id\":123}**", "properties": { "email": { "type": "string", "description": "Email of the sender" }, "id": { "type": "integer", "description": "Select the sender for the template on the basis of sender id. _In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)_." }, "name": { "type": "string", "description": "Name of the sender. **If not passed, will be set to default**" } } }, "subject": { "type": "string", "description": "Subject of the template" }, "tag": { "type": "string", "description": "Tag of the template" }, "templateName": { "type": "string", "description": "Name of the template" }, "toField": { "type": "string", "description": "To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization" } }, "required": [ "PCID", "sender", "subject", "templateName" ] } ``` *** ## brevo\_email\_delete\_blocked\_domain Unblock an existing domain from the list of blocked domains **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `domain` | string | Yes | — | The name of the domain to be deleted | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "domain": { "type": "string", "description": "The name of the domain to be deleted" } }, "required": [ "PCID", "domain" ] } ``` *** ## brevo\_email\_delete\_campaign Delete an email campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campaignId` | integer | Yes | — | id of the campaign | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campaignId": { "type": "integer", "description": "id of the campaign" } }, "required": [ "PCID", "campaignId" ] } ``` *** ## brevo\_email\_delete\_hardbounces Delete hardbounces **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `contactEmail` | string | No | — | Target a specific email address | | `endDate` | string | No | — | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | | `startDate` | string | No | — | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contactEmail": { "type": "string", "description": "Target a specific email address" }, "endDate": { "type": "string", "description": "Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate" }, "startDate": { "type": "string", "description": "Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate" } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_delete\_scheduled\_email\_by\_id Delete scheduled emails by batchId or messageId **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`)." } }, "required": [ "PCID", "identifier" ] } ``` *** ## brevo\_email\_delete\_sender Delete a sender **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `senderId` | integer | Yes | — | Id of the sender | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "senderId": { "type": "integer", "description": "Id of the sender" } }, "required": [ "PCID", "senderId" ] } ``` *** ## brevo\_email\_delete\_smtp\_blocked\_contacts\_by\_email Unblock or resubscribe a transactional contact **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `email` | string | Yes | — | contact email (urlencoded) to unblock. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email": { "type": "string", "description": "contact email (urlencoded) to unblock." } }, "required": [ "PCID", "email" ] } ``` *** ## brevo\_email\_delete\_smtp\_log\_by\_identifier Delete an SMTP transactional log **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | MessageId or email address of the transactional log(s) to delete. Must be a valid message ID (enclosed in angle brackets with @ sign) or a valid email address. | | `from_date` | string | No | — | Starting date (YYYY-MM-DD) to narrow down logs for deletion | | `to_date` | string | No | — | Ending date (YYYY-MM-DD) to narrow down logs for deletion | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "MessageId or email address of the transactional log(s) to delete. Must be a valid message ID (enclosed in angle brackets with @ sign) or a valid email address." }, "from_date": { "type": "string", "description": "Starting date (YYYY-MM-DD) to narrow down logs for deletion" }, "to_date": { "type": "string", "description": "Ending date (YYYY-MM-DD) to narrow down logs for deletion" } }, "required": [ "PCID", "identifier" ] } ``` *** ## brevo\_email\_delete\_smtp\_template Delete an inactive email template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `templateId` | integer | Yes | — | id of the template | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateId": { "type": "integer", "description": "id of the template" } }, "required": [ "PCID", "templateId" ] } ``` *** ## brevo\_email\_export\_recipients Export the recipients of an email campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campaignId` | integer | Yes | — | Id of the campaign | | `notifyURL` | string | No | — | Webhook called once the export process is finished. For reference, [https://help.brevo.com/hc/en-us/articles/360007666479](https://help.brevo.com/hc/en-us/articles/360007666479) | | `recipientsType` | string | No | — | Type of recipients to export for a campaign | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campaignId": { "type": "integer", "description": "Id of the campaign" }, "notifyURL": { "type": "string", "description": "Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479" }, "recipientsType": { "type": "string", "description": "Type of recipients to export for a campaign", "enum": [ "all", "nonClickers", "nonOpeners", "clickers", "openers", "softBounces", "hardBounces", "unsubscribed" ] } }, "required": [ "PCID", "campaignId" ] } ``` *** ## brevo\_email\_get\_ab\_test\_campaign\_result Get an A/B test email campaign results **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campaignId` | integer | Yes | — | Id of the A/B test campaign | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campaignId": { "type": "integer", "description": "Id of the A/B test campaign" } }, "required": [ "PCID", "campaignId" ] } ``` *** ## brevo\_email\_get\_aggregated\_smtp\_report Get your transactional email activity aggregated over a period of time **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `startDate` | string | No | — | **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | | `endDate` | string | No | — | **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | | `days` | integer | No | — | Number of days in the past including today (positive integer, maximum 90). *Not compatible with 'startDate' and 'endDate'*. Defaults to 90 if neither dates nor days are provided. | | `tag` | string | No | — | Tag of the emails | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "startDate": { "type": "string", "description": "**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate" }, "endDate": { "type": "string", "description": "**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate" }, "days": { "type": "integer", "description": "Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 90 if neither dates nor days are provided." }, "tag": { "type": "string", "description": "Tag of the emails" } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_blocked\_domains Get the list of blocked domains ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_campaign Get an email campaign report **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campaignId` | integer | Yes | — | Id of the campaign | | `statistics` | string | No | — | Filter on the type of statistics required. Example: **globalStats** value will only fetch globalStats info of the campaign in the returned response. `statsByDevice` and `statsByBrowser` are only available when retrieving a single campaign (not in the list endpoint). | | `excludeHtmlContent` | boolean | No | — | Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campaignId": { "type": "integer", "description": "Id of the campaign" }, "statistics": { "type": "string", "description": "Filter on the type of statistics required. Example: **globalStats** value will only fetch globalStats info of the campaign in the returned response. `statsByDevice` and `statsByBrowser` are only available when retrieving a single campaign (not in the list endpoint).", "enum": [ "globalStats", "linksStats", "statsByDomain", "statsByDevice", "statsByBrowser" ] }, "excludeHtmlContent": { "type": "boolean", "description": "Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body", "enum": [ true, false ] } }, "required": [ "PCID", "campaignId" ] } ``` *** ## brevo\_email\_get\_campaigns Return all your created email campaigns **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `type` | string | No | — | Filter on the type of the campaigns | | `status` | string | No | — | Filter on the status of the campaign | | `statistics` | string | No | — | Filter on the type of statistics required. Example: **globalStats** value will only fetch globalStats info of the campaign in the returned response. This option only returns data for events that occurred in the last 6 months. For older campaigns, it is advisable to use the **Get Campaign Report** endpoint. | | `startDate` | string | No | — | **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `startDate` must not be in the future. | | `endDate` | string | No | — | **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `endDate` must not be in the future. | | `limit` | integer | No | — | Number of documents per page | | `offset` | integer | No | — | Index of the first document in the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | | `excludeHtmlContent` | boolean | No | — | Use this flag to exclude htmlContent from the response body. If set to **true**, the htmlContent field will be returned as an empty string in the response body. | | `excludePdfAttachment` | boolean | No | — | Use this flag to filter out campaigns that have a PDF attachment. If set to **true**, only campaigns without a PDF attachment (or with no attachment at all) will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "type": { "type": "string", "description": "Filter on the type of the campaigns", "enum": [ "classic", "trigger" ] }, "status": { "type": "string", "description": "Filter on the status of the campaign", "enum": [ "suspended", "archive", "sent", "queued", "draft", "inProcess", "inReview", "cancelling", "cancelled" ] }, "statistics": { "type": "string", "description": "Filter on the type of statistics required. Example: **globalStats** value will only fetch globalStats info of the campaign in the returned response. This option only returns data for events that occurred in the last 6 months. For older campaigns, it is advisable to use the **Get Campaign Report** endpoint.", "enum": [ "globalStats", "linksStats", "statsByDomain" ] }, "startDate": { "type": "string", "description": "**Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `startDate` must not be in the future." }, "endDate": { "type": "string", "description": "**Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `endDate` must not be in the future." }, "limit": { "type": "integer", "description": "Number of documents per page" }, "offset": { "type": "integer", "description": "Index of the first document in the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] }, "excludeHtmlContent": { "type": "boolean", "description": "Use this flag to exclude htmlContent from the response body. If set to **true**, the htmlContent field will be returned as an empty string in the response body.", "enum": [ true, false ] }, "excludePdfAttachment": { "type": "boolean", "description": "Use this flag to filter out campaigns that have a PDF attachment. If set to **true**, only campaigns without a PDF attachment (or with no attachment at all) will be returned.", "enum": [ true, false ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_event\_report Get all your transactional email activity (unaggregated events) **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number limitation for the result returned | | `offset` | integer | No | — | Beginning point in the list to retrieve from. | | `startDate` | string | No | — | **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | | `endDate` | string | No | — | **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | | `days` | integer | No | — | Number of days in the past including today (positive integer, maximum 90). *Not compatible with 'startDate' and 'endDate'*. Defaults to 30 if neither dates nor days are provided. | | `email` | string | No | — | Filter the report for a specific email addresses | | `event` | string | No | — | Filter the report for a specific event type | | `tags` | string | No | — | Filter the report for tags (serialized and urlencoded array) | | `messageId` | string | No | — | Filter on a specific message id | | `templateId` | integer | No | — | Filter on a specific template id | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number limitation for the result returned" }, "offset": { "type": "integer", "description": "Beginning point in the list to retrieve from." }, "startDate": { "type": "string", "description": "**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate" }, "endDate": { "type": "string", "description": "**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate" }, "days": { "type": "integer", "description": "Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 30 if neither dates nor days are provided." }, "email": { "type": "string", "description": "Filter the report for a specific email addresses" }, "event": { "type": "string", "description": "Filter the report for a specific event type", "enum": [ "bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked", "unsubscribed", "error", "loadedByProxy" ] }, "tags": { "type": "string", "description": "Filter the report for tags (serialized and urlencoded array)" }, "messageId": { "type": "string", "description": "Filter on a specific message id" }, "templateId": { "type": "integer", "description": "Filter on a specific template id" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_inbound\_email\_attachment Retrieve inbound attachment with download token. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `downloadToken` | string | Yes | — | Token to fetch a particular attachment | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "downloadToken": { "type": "string", "description": "Token to fetch a particular attachment" } }, "required": [ "PCID", "downloadToken" ] } ``` *** ## brevo\_email\_get\_inbound\_email\_events Get the list of all the events for the received emails. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `sender` | string | No | — | Email address of the sender. | | `startDate` | string | No | — | Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future. | | `endDate` | string | No | — | Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future. | | `limit` | integer | No | — | Number of documents returned per page | | `offset` | integer | No | — | Index of the first document on the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sender": { "type": "string", "description": "Email address of the sender." }, "startDate": { "type": "string", "description": "Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future." }, "endDate": { "type": "string", "description": "Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future." }, "limit": { "type": "integer", "description": "Number of documents returned per page" }, "offset": { "type": "integer", "description": "Index of the first document on the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_inbound\_email\_events\_by\_uuid Fetch all events history for one particular received email. **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uuid` | string | Yes | — | UUID to fetch events specific to received email | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uuid": { "type": "string", "description": "UUID to fetch events specific to received email" } }, "required": [ "PCID", "uuid" ] } ``` *** ## brevo\_email\_get\_ips Get all the dedicated IPs for your account ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_ips\_from\_sender Get all the dedicated IPs for a specific sender **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `senderId` | integer | Yes | — | Id of the sender | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "senderId": { "type": "integer", "description": "Id of the sender" } }, "required": [ "PCID", "senderId" ] } ``` *** ## brevo\_email\_get\_scheduled\_email\_by\_id Fetch scheduled emails by batchId or messageId **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `identifier` | string | Yes | — | The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`). When using `messageId`, the `limit`, `offset`, `sort`, and `status` query parameters are ignored. | | `startDate` | string | No | — | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the current date. | | `endDate` | string | No | — | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. Not valid when identifier is `messageId`. | | `status` | string | No | — | Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`. | | `limit` | integer | No | — | Number of documents returned per page. Not valid when identifier is `messageId`. | | `offset` | integer | No | — | Index of the first document on the page. Not valid when identifier is `messageId`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "identifier": { "type": "string", "description": "The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`). When using `messageId`, the `limit`, `offset`, `sort`, and `status` query parameters are ignored." }, "startDate": { "type": "string", "description": "Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the current date." }, "endDate": { "type": "string", "description": "Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month." }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. Not valid when identifier is `messageId`.", "enum": [ "asc", "desc" ] }, "status": { "type": "string", "description": "Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`.", "enum": [ "processed", "inProgress", "queued" ] }, "limit": { "type": "integer", "description": "Number of documents returned per page. Not valid when identifier is `messageId`." }, "offset": { "type": "integer", "description": "Index of the first document on the page. Not valid when identifier is `messageId`." } }, "required": [ "PCID", "identifier" ] } ``` *** ## brevo\_email\_get\_senders Get email senders **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `ip` | string | No | — | Filter your senders for a specific ip. **Available for dedicated IP usage only** | | `domain` | string | No | — | Filter your senders for a specific domain | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ip": { "type": "string", "description": "Filter your senders for a specific ip. **Available for dedicated IP usage only**" }, "domain": { "type": "string", "description": "Filter your senders for a specific domain" } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_shared\_template\_url Get a shared template url **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campaignId` | integer | Yes | — | Id of the campaign or template | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campaignId": { "type": "integer", "description": "Id of the campaign or template" } }, "required": [ "PCID", "campaignId" ] } ``` *** ## brevo\_email\_get\_smstemplates Return all your created SMS templates **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of documents returned per page | | `offset` | integer | No | — | Index of the first document in the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of documents returned per page" }, "offset": { "type": "integer", "description": "Index of the first document in the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_smtp\_report Get your transactional email activity aggregated per day **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `limit` | integer | No | — | Number of documents returned per page | | `offset` | integer | No | — | Index of the first document on the page | | `startDate` | string | No | — | **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD) | | `endDate` | string | No | — | **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD) | | `days` | integer | No | — | Number of days in the past including today (positive integer, maximum 30). *Not compatible with 'startDate' and 'endDate'* | | `tag` | string | No | — | Tag of the emails | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Number of documents returned per page" }, "offset": { "type": "integer", "description": "Index of the first document on the page" }, "startDate": { "type": "string", "description": "**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD)" }, "endDate": { "type": "string", "description": "**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD)" }, "days": { "type": "integer", "description": "Number of days in the past including today (positive integer, maximum 30). _Not compatible with 'startDate' and 'endDate'_" }, "tag": { "type": "string", "description": "Tag of the emails" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_smtp\_template Returns the template information **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `templateId` | object | Yes | — | ID of the template. Can be a numeric template ID or a custom template identifier string (alphanumeric, hyphens, and underscores only, max 64 characters, must start with a letter). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateId": { "description": "ID of the template. Can be a numeric template ID or a custom template identifier string (alphanumeric, hyphens, and underscores only, max 64 characters, must start with a letter)." } }, "required": [ "PCID", "templateId" ] } ``` *** ## brevo\_email\_get\_smtp\_templates Get the list of email templates **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `templateStatus` | boolean | No | — | Filter on the status of the template. Active = true, inactive = false | | `limit` | integer | No | — | Number of documents returned per page | | `offset` | integer | No | — | Index of the first document in the page | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | | `editorType` | string | No | — | Filter on the editor type used to create the template. Currently only `richTextEditor` is supported as a filter value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateStatus": { "type": "boolean", "description": "Filter on the status of the template. Active = true, inactive = false" }, "limit": { "type": "integer", "description": "Number of documents returned per page" }, "offset": { "type": "integer", "description": "Index of the first document in the page" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] }, "editorType": { "type": "string", "description": "Filter on the editor type used to create the template. Currently only `richTextEditor` is supported as a filter value.", "enum": [ "richTextEditor" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_transac\_blocked\_contacts Get the list of blocked or unsubscribed transactional contacts **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `startDate` | string | No | — | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts | | `endDate` | string | No | — | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts | | `limit` | integer | No | — | Number of documents returned per page | | `offset` | integer | No | — | Index of the first document on the page | | `senders` | string\[] | No | — | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "startDate": { "type": "string", "description": "**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts" }, "endDate": { "type": "string", "description": "**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts" }, "limit": { "type": "integer", "description": "Number of documents returned per page" }, "offset": { "type": "integer", "description": "Index of the first document on the page" }, "senders": { "type": "array", "items": { "type": "string" }, "description": "Comma separated list of emails of the senders from which contacts are blocked or unsubscribed" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_get\_transac\_email\_content Get the personalized content of a sent transactional email **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `uuid` | string | Yes | — | Unique id of the transactional email that has been sent to a particular contact | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "uuid": { "type": "string", "description": "Unique id of the transactional email that has been sent to a particular contact" } }, "required": [ "PCID", "uuid" ] } ``` *** ## brevo\_email\_get\_transac\_emails\_list Get the list of transactional emails on the basis of allowed filters **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `email` | string | No | — | **Mandatory if templateId and messageId are not passed in query filters.** Email address to which transactional email has been sent. | | `templateId` | integer | No | — | **Mandatory if email and messageId are not passed in query filters.** Id of the template that was used to compose transactional email. | | `messageId` | string | No | — | **Mandatory if templateId and email are not passed in query filters.** Message ID of the transactional email sent. | | `startDate` | string | No | — | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the list. **Maximum time period that can be selected is one month**. | | `endDate` | string | No | — | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the list. **Maximum time period that can be selected is one month.** | | `sort` | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | | `limit` | integer | No | — | Number of documents returned per page | | `offset` | integer | No | — | Index of the first document in the page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email": { "type": "string", "description": "**Mandatory if templateId and messageId are not passed in query filters.** Email address to which transactional email has been sent." }, "templateId": { "type": "integer", "description": "**Mandatory if email and messageId are not passed in query filters.** Id of the template that was used to compose transactional email." }, "messageId": { "type": "string", "description": "**Mandatory if templateId and email are not passed in query filters.** Message ID of the transactional email sent." }, "startDate": { "type": "string", "description": "**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the list. **Maximum time period that can be selected is one month**." }, "endDate": { "type": "string", "description": "**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the list. **Maximum time period that can be selected is one month.**" }, "sort": { "type": "string", "description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed", "enum": [ "asc", "desc" ] }, "limit": { "type": "integer", "description": "Number of documents returned per page" }, "offset": { "type": "integer", "description": "Index of the first document in the page" } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_post\_preview\_smtp\_email\_templates Generate the rendered preview of transactional template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `email` | string | No | — | Email of the contact.(Required if params not provided) | | `params` | object | No | — | Key-value pairs of dynamic parameters for template rendering.(Required if email not provided) For example: **\{"Firstname":"John", "Lastname":"Doe"}** | | `templateId` | integer | Yes | — | Id of the template. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "email": { "type": "string", "description": "Email of the contact.(Required if params not provided)" }, "params": { "type": "object", "description": "Key-value pairs of dynamic parameters for template rendering.(Required if email not provided) For example: **{\"Firstname\":\"John\", \"Lastname\":\"Doe\"}**", "properties": { "Firstname": { "type": "string", "description": "firstname of the contact. **Dynamic parameter**" }, "Lastname": { "type": "string", "description": "Lastname of the contact. **Dynamic parameter**" } } }, "templateId": { "type": "integer", "description": "Id of the template." } }, "required": [ "PCID", "templateId" ] } ``` *** ## brevo\_email\_send\_email\_campaign\_now Send an email campaign immediately, based on campaignId **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campaignId` | integer | Yes | — | Id of the campaign | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campaignId": { "type": "integer", "description": "Id of the campaign" } }, "required": [ "PCID", "campaignId" ] } ``` *** ## brevo\_email\_send\_report Send the report of a campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campaignId` | integer | Yes | — | Id of the campaign | | `email` | object | Yes | — | Custom attributes for the report email. | | `language` | string | No | — | Language of email content for campaign report sending. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campaignId": { "type": "integer", "description": "Id of the campaign" }, "email": { "type": "object", "description": "Custom attributes for the report email.", "properties": { "body": { "type": "string", "description": "Custom text message to be presented in the report email." }, "to": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Email addresses of the recipients" } }, "required": [ "body", "to" ] }, "language": { "type": "string", "description": "Language of email content for campaign report sending.", "enum": [ "fr", "es", "pt", "it", "de", "en" ] } }, "required": [ "PCID", "campaignId", "email" ] } ``` *** ## brevo\_email\_send\_test\_email Send an email campaign to your test list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campaignId` | integer | Yes | — | Id of the campaign | | `emailTo` | string\[] | No | — | List of the email addresses of the recipients whom you wish to send the test mail. *If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day*. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campaignId": { "type": "integer", "description": "Id of the campaign" }, "emailTo": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "List of the email addresses of the recipients whom you wish to send the test mail. _If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day_." } }, "required": [ "PCID", "campaignId" ] } ``` *** ## brevo\_email\_send\_test\_template Send a template to your test list **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `templateId` | integer | Yes | — | Id of the template | | `emailTo` | string\[] | No | — | List of the email addresses of the recipients whom you wish to send the test mail. *If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day*. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateId": { "type": "integer", "description": "Id of the template" }, "emailTo": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "List of the email addresses of the recipients whom you wish to send the test mail. _If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day_." } }, "required": [ "PCID", "templateId" ] } ``` *** ## brevo\_email\_send\_transac\_email Send a transactional email **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `attachment` | object\[] | No | — | Array of attachment objects. Each attachment must include either an absolute URL (no local file paths) or base64-encoded content, along with the attachment filename. The `name` field is required when `content` is provided. Supported file extensions: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass, xlsm. When `templateId` is specified: if the template uses the New Template Language format, both `url` and `content` attachment types are supported; if the template uses the Old Template Language format, the `attachment` parameter is ignored. | | `batchId` | string | No | — | UUIDv4 identifier for the scheduled batch of transactional emails. If omitted, a valid UUIDv4 batch identifier is automatically generated. | | `bcc` | object\[] | No | — | Array of BCC recipient objects. Each object contains an email address and an optional name. | | `cc` | object\[] | No | — | Array of CC recipient objects. Each object contains an email address and an optional name. | | `headers` | object | No | — | Custom email headers (non-standard headers) to include in the email. The `sender.ip` header can be set to specify the IP address used for sending transactional emails (dedicated IP users only). Header names must use Title-Case-Format (words separated by hyphens with the first letter of each word capitalized). Headers not in this format are automatically converted. Standard email headers are not supported. Example: `{"sender.ip":"1.2.3.4", "X-Mailin-custom":"some_custom_value", "Idempotency-Key":"abc-123"}` | | `htmlContent` | string | No | — | HTML body content of the email. Required when `templateId` is not provided. Ignored when `templateId` is provided. | | `messageVersions` | object\[] | No | — | Array of message version objects for sending customized email variants. The `templateId` can be customized per version only if a global `templateId` is provided. The `htmlContent` and `textContent` can be customized per version only if at least one of these is present in the global parameters. Global parameters such as `to` (required), `bcc`, `cc`, `replyTo`, and `subject` can be customized per version. Maximum total recipients per API request is 2000. Maximum recipients per message version is 99. Individual `params` objects must not exceed 100 KB. Cumulative `params` across all versions must not exceed 1000 KB. See [https://developers.brevo.com/docs/batch-send-transactional-emails](https://developers.brevo.com/docs/batch-send-transactional-emails) for detailed usage instructions. | | `params` | object | No | — | Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format. | | `replyTo` | object | No | — | Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email. | | `scheduledAt` | string | No | — | UTC date-time when the email should be sent (format: YYYY-MM-DDTHH:mm:ss.SSSZ). Include timezone information in the date-time value. Scheduled emails may be delayed by up to 5 minutes. | | `sender` | object | No | — | Sender information. Required when `templateId` is not provided. Specify either an email address (with optional name) or a sender ID. The `name` field is ignored when `id` is provided. | | `subject` | string | No | — | Email subject line. Required when `templateId` is not provided. | | `tags` | string\[] | No | — | Array of tags for categorizing and filtering emails | | `templateId` | integer | No | — | Template identifier | | `textContent` | string | No | — | Plain text body content of the email. Ignored when `templateId` is provided. | | `to` | object\[] | No | — | Array of recipient objects. Each object contains an email address and an optional display name. Required when `messageVersions` is not provided. Ignored when `messageVersions` is provided. Example: `[{"name":"Jimmy", "email":"jimmy@example.com"}, {"name":"Joe", "email":"joe@example.com"}]` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attachment": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string", "format": "byte", "description": "Base64-encoded attachment data" }, "name": { "type": "string", "description": "Attachment filename. Required when `content` is provided." }, "url": { "type": "string", "format": "url", "description": "Absolute URL of the attachment. Local file paths are not supported." } } }, "description": "Array of attachment objects. Each attachment must include either an absolute URL (no local file paths) or base64-encoded content, along with the attachment filename. The `name` field is required when `content` is provided. Supported file extensions: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass, xlsm. When `templateId` is specified: if the template uses the New Template Language format, both `url` and `content` attachment types are supported; if the template uses the Old Template Language format, the `attachment` parameter is ignored." }, "batchId": { "type": "string", "description": "UUIDv4 identifier for the scheduled batch of transactional emails. If omitted, a valid UUIDv4 batch identifier is automatically generated." }, "bcc": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "BCC recipient email address" }, "name": { "type": "string", "description": "Display name of the BCC recipient. Maximum length is 70 characters." } }, "required": [ "email" ] }, "description": "Array of BCC recipient objects. Each object contains an email address and an optional name." }, "cc": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "CC recipient email address" }, "name": { "type": "string", "description": "Display name of the CC recipient. Maximum length is 70 characters." } }, "required": [ "email" ] }, "description": "Array of CC recipient objects. Each object contains an email address and an optional name." }, "headers": { "type": "object", "description": "Custom email headers (non-standard headers) to include in the email. The `sender.ip` header can be set to specify the IP address used for sending transactional emails (dedicated IP users only). Header names must use Title-Case-Format (words separated by hyphens with the first letter of each word capitalized). Headers not in this format are automatically converted. Standard email headers are not supported. Example: `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_value\", \"Idempotency-Key\":\"abc-123\"}`" }, "htmlContent": { "type": "string", "description": "HTML body content of the email. Required when `templateId` is not provided. Ignored when `templateId` is provided." }, "messageVersions": { "type": "array", "items": { "type": "object", "properties": { "bcc": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "BCC recipient email address" }, "name": { "type": "string", "description": "Display name of the BCC recipient. Maximum length is 70 characters. " } } }, "description": "Array of BCC recipient objects. Each object contains an email address and an optional name." }, "cc": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "CC recipient email address" }, "name": { "type": "string", "description": "Display name of the CC recipient. Maximum length is 70 characters. " } } }, "description": "Array of CC recipient objects. Each object contains an email address and an optional name." }, "htmlContent": { "type": "string", "description": "HTML body content of the email. Required when `templateId` is not provided. Ignored when `templateId` is provided." }, "params": { "type": "object", "description": "Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format." }, "replyTo": { "type": "object", "description": "Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email." }, "subject": { "type": "string", "description": "Email subject line for this message version" }, "textContent": { "type": "string", "description": "Plain text body content of the email. Ignored when `templateId` is provided." }, "to": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address of the recipient" }, "name": { "type": "string", "description": "Display name of the recipient. Maximum length is 70 characters. " } } }, "description": "Array of recipient objects. Each object contains an email address and an optional display name." } }, "required": [ "to" ] }, "description": "Array of message version objects for sending customized email variants. The `templateId` can be customized per version only if a global `templateId` is provided. The `htmlContent` and `textContent` can be customized per version only if at least one of these is present in the global parameters. Global parameters such as `to` (required), `bcc`, `cc`, `replyTo`, and `subject` can be customized per version. Maximum total recipients per API request is 2000. Maximum recipients per message version is 99. Individual `params` objects must not exceed 100 KB. Cumulative `params` across all versions must not exceed 1000 KB. See https://developers.brevo.com/docs/batch-send-transactional-emails for detailed usage instructions." }, "params": { "type": "object", "description": "Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format." }, "replyTo": { "type": "object", "description": "Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email.", "properties": { "email": { "type": "string", "description": "Email address in reply to" }, "name": { "type": "string", "description": "Display name for the reply-to address. Maximum length is 70 characters." } }, "required": [ "email" ] }, "scheduledAt": { "type": "string", "description": "UTC date-time when the email should be sent (format: YYYY-MM-DDTHH:mm:ss.SSSZ). Include timezone information in the date-time value. Scheduled emails may be delayed by up to 5 minutes." }, "sender": { "type": "object", "description": "Sender information. Required when `templateId` is not provided. Specify either an email address (with optional name) or a sender ID. The `name` field is ignored when `id` is provided.", "properties": { "email": { "type": "string", "description": "Sender email address. Required when `id` is not provided." }, "id": { "type": "integer", "description": "Sender identifier. Required when `email` is not provided. Use this field to select a sender with a specific IP pool (dedicated IP users only)." }, "name": { "type": "string", "description": "Display name of the sender. Maximum length is 70 characters. Only applicable when `email` is provided." } } }, "subject": { "type": "string", "description": "Email subject line. Required when `templateId` is not provided." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of tags for categorizing and filtering emails" }, "templateId": { "type": "integer", "description": "Template identifier" }, "textContent": { "type": "string", "description": "Plain text body content of the email. Ignored when `templateId` is provided." }, "to": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Email address of the recipient" }, "name": { "type": "string", "description": "Display name of the recipient. Maximum length is 70 characters." } }, "required": [ "email" ] }, "description": "Array of recipient objects. Each object contains an email address and an optional display name. Required when `messageVersions` is not provided. Ignored when `messageVersions` is provided. Example: `[{\"name\":\"Jimmy\", \"email\":\"jimmy@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]`" } }, "required": [ "PCID" ] } ``` *** ## brevo\_email\_update\_campaign\_status Update an email campaign status **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campaignId` | integer | Yes | — | Id of the campaign | | `status` | string | No | — | Note:- **replicateTemplate** status will be available **only for template type campaigns.** | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campaignId": { "type": "integer", "description": "Id of the campaign" }, "status": { "type": "string", "description": "Note:- **replicateTemplate** status will be available **only for template type campaigns.**", "enum": [ "suspended", "archive", "darchive", "sent", "queued", "replicate", "replicateTemplate", "cancel", "draft" ] } }, "required": [ "PCID", "campaignId" ] } ``` *** ## brevo\_email\_update\_email\_campaign Update an email campaign **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `campaignId` | integer | Yes | — | Id of the campaign | | `abTesting` | boolean | No | — | Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. **subjectA, subjectB, splitRule, winnerCriteria & winnerDelay** will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. **Can be set to true only if sendAtBestTime is false**. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | | `attachmentUrl` | string | No | — | Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps' | | `emailExpirationDate` | object | No | — | To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. | | `footer` | string | No | — | Footer of the email campaign | | `header` | string | No | — | Header of the email campaign | | `htmlContent` | string | No | — | Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. **REQUIRED if htmlUrl is empty** | | `htmlUrl` | string | No | — | Url which contents the body of the email message. **REQUIRED if htmlContent is empty** | | `increaseRate` | integer | No | — | Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | | `initialQuota` | integer | No | — | Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | | `inlineImageActivation` | boolean | No | — | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than **4MB** with images embedded in the email. Campaigns with the images embedded in the email *must be sent to less than 5000 contacts*. | | `ipWarmupEnable` | boolean | No | — | **Available for dedicated ip clients**. Set this to true if you wish to warm up your ip. | | `mirrorActive` | boolean | No | — | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | | `name` | string | No | — | Name of the campaign | | `params` | object | No | — | Pass the set of attributes to customize the type classic campaign. For example: **\{"FNAME":"Joe", "LNAME":"Doe"}**. Only available if **type** is **classic**. It's considered only if campaign is in *New Template Language format*. The New Template Language is dependent on the values of **subject, htmlContent/htmlUrl, sender.name & toField** | | `previewText` | string | No | — | Preview text or preheader of the email campaign | | `recipients` | object | No | — | Segment ids and List ids to include/exclude from campaign | | `recurring` | boolean | No | — | **FOR TRIGGER ONLY !** Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | | `replyTo` | string | No | — | Email on which campaign recipients will be able to reply to | | `scheduledAt` | string | No | — | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | | `sendAtBestTime` | boolean | No | — | Set this to true if you want to send your campaign at best time. Note:- **if true, warmup ip will be disabled.** | | `sender` | object | No | — | Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **\{"name":"xyz", "email":"[example@abc.com](mailto:example@abc.com)"}** **\{"name":"xyz", "id":123}** | | `splitRule` | integer | No | — | Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | | `subject` | string | No | — | Subject of the campaign | | `subjectA` | string | No | — | Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value | | `subjectB` | string | No | — | Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value | | `tag` | string | No | — | Tag of the campaign | | `toField` | string | No | — | To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **\{FNAME} \{LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **\{\{contact.FNAME}} \{\{contact.LNAME}}** for personalization | | `unsubscriptionPageId` | string | No | — | Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. | | `updateFormId` | string | No | — | **Mandatory if templateId is used containing the \{\{ update\_profile }} tag**. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. | | `utmCampaign` | string | No | — | Customize the utm\_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | | `winnerCriteria` | string | No | — | Choose the metrics that will determinate the winning version. **Mandatory if *splitRule* >= 1 and \< 50**. If splitRule = 50, `winnerCriteria` is ignored if passed | | `winnerDelay` | integer | No | — | Choose the duration of the test in hours. Maximum is 7 days, pass 24\*7 = 168 hours. The winning version will be sent at the end of the test. **Mandatory if *splitRule* >= 1 and \< 50**. If splitRule = 50, `winnerDelay` is ignored if passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "campaignId": { "type": "integer", "description": "Id of the campaign" }, "abTesting": { "type": "boolean", "description": "Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. **subjectA, subjectB, splitRule, winnerCriteria & winnerDelay** will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. **Can be set to true only if sendAtBestTime is false**. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B" }, "attachmentUrl": { "type": "string", "description": "Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'" }, "emailExpirationDate": { "type": "object", "description": "To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy.", "properties": { "duration": { "type": "integer", "description": "Duration of the email expiry. maximum duration can be 3600 days or 480 weeks or 120 months." }, "unit": { "type": "string", "description": "unit of the duration", "enum": [ "days", "weeks", "months" ] } } }, "footer": { "type": "string", "description": "Footer of the email campaign" }, "header": { "type": "string", "description": "Header of the email campaign" }, "htmlContent": { "type": "string", "description": "Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. **REQUIRED if htmlUrl is empty**" }, "htmlUrl": { "type": "string", "description": "Url which contents the body of the email message. **REQUIRED if htmlContent is empty**" }, "increaseRate": { "type": "integer", "description": "Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%." }, "initialQuota": { "type": "integer", "description": "Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000." }, "inlineImageActivation": { "type": "boolean", "description": "Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than **4MB** with images embedded in the email. Campaigns with the images embedded in the email _must be sent to less than 5000 contacts_." }, "ipWarmupEnable": { "type": "boolean", "description": "**Available for dedicated ip clients**. Set this to true if you wish to warm up your ip." }, "mirrorActive": { "type": "boolean", "description": "Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign" }, "name": { "type": "string", "description": "Name of the campaign" }, "params": { "type": "object", "description": "Pass the set of attributes to customize the type classic campaign. For example: **{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}**. Only available if **type** is **classic**. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of **subject, htmlContent/htmlUrl, sender.name & toField**" }, "previewText": { "type": "string", "description": "Preview text or preheader of the email campaign" }, "recipients": { "type": "object", "description": "Segment ids and List ids to include/exclude from campaign", "properties": { "exclusionListIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "List ids which have to be excluded from a campaign" }, "exclusionSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Segment ids which have to be excluded from a campaign." }, "listIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Lists Ids to send the campaign to. **Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty**" }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "**Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it.** Segment ids to send the campaign to." } } }, "recurring": { "type": "boolean", "description": "**FOR TRIGGER ONLY !** Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times" }, "replyTo": { "type": "string", "description": "Email on which campaign recipients will be able to reply to" }, "scheduledAt": { "type": "string", "description": "UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part)." }, "sendAtBestTime": { "type": "boolean", "description": "Set this to true if you want to send your campaign at best time. Note:- **if true, warmup ip will be disabled.**" }, "sender": { "type": "object", "description": "Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{\"name\":\"xyz\", \"email\":\"example@abc.com\"}** **{\"name\":\"xyz\", \"id\":123}**", "properties": { "email": { "type": "string", "description": "Sender email from which the campaign emails are sent" }, "id": { "type": "integer", "description": "Select the sender for the campaign on the basis of sender id. **In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)**." }, "name": { "type": "string", "description": "Sender Name from which the campaign emails are sent" } } }, "splitRule": { "type": "integer", "description": "Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else" }, "subject": { "type": "string", "description": "Subject of the campaign" }, "subjectA": { "type": "string", "description": "Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value" }, "subjectB": { "type": "string", "description": "Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value" }, "tag": { "type": "string", "description": "Tag of the campaign" }, "toField": { "type": "string", "description": "To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization" }, "unsubscriptionPageId": { "type": "string", "description": "Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page." }, "updateFormId": { "type": "string", "description": "**Mandatory if templateId is used containing the {{ update_profile }} tag**. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form." }, "utmCampaign": { "type": "string", "description": "Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed" }, "winnerCriteria": { "type": "string", "description": "Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed", "enum": [ "open", "click" ] }, "winnerDelay": { "type": "integer", "description": "Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerDelay` is ignored if passed" } }, "required": [ "PCID", "campaignId" ] } ``` *** ## brevo\_email\_update\_sender Update a sender **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `senderId` | integer | Yes | — | Id of the sender | | `email` | string | No | — | From Email to update the sender | | `ips` | object\[] | No | — | **Only in case of dedicated IP**. IPs to associate to the sender. If passed, will replace all the existing IPs. Not required for standard accounts. | | `name` | string | No | — | From Name to update the sender | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "senderId": { "type": "integer", "description": "Id of the sender" }, "email": { "type": "string", "description": "From Email to update the sender" }, "ips": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain of the IP" }, "ip": { "type": "string", "description": "Dedicated IP available in your account" }, "weight": { "type": "integer", "format": "int64", "description": "Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs." } }, "required": [ "domain", "ip" ] }, "description": "**Only in case of dedicated IP**. IPs to associate to the sender. If passed, will replace all the existing IPs. Not required for standard accounts." }, "name": { "type": "string", "description": "From Name to update the sender" } }, "required": [ "PCID", "senderId" ] } ``` *** ## brevo\_email\_update\_smtp\_template Update an email template **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `templateId` | object | Yes | — | ID of the template. Can be a numeric template ID or a custom template identifier string. | | `attachmentUrl` | string | No | — | Absolute url of the attachment (**no local file**). Extensions allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | | `htmlContent` | string | No | — | **Required if htmlUrl is empty**. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) | | `htmlUrl` | string | No | — | **Required if htmlContent is empty**. URL to the body of the email (HTML) | | `isActive` | boolean | No | — | Status of the template. isActive = false means template is inactive, isActive = true means template is active | | `replyTo` | string | No | — | Email on which campaign recipients will be able to reply to | | `sender` | object | No | — | Sender details including id or email and name (*optional*). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **\{"name":"xyz", "email":"[example@abc.com](mailto:example@abc.com)"}** **\{"name":"xyz", "id":123}** | | `subject` | string | No | — | Subject of the email | | `tag` | string | No | — | Tag of the template | | `templateName` | string | No | — | Name of the template | | `toField` | string | No | — | To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **\{FNAME} \{LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **\{\{contact.FNAME}} \{\{contact.LNAME}}** for personalization | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateId": { "description": "ID of the template. Can be a numeric template ID or a custom template identifier string." }, "attachmentUrl": { "type": "string", "description": "Absolute url of the attachment (**no local file**). Extensions allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps" }, "htmlContent": { "type": "string", "description": "**Required if htmlUrl is empty**. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters)" }, "htmlUrl": { "type": "string", "description": "**Required if htmlContent is empty**. URL to the body of the email (HTML)" }, "isActive": { "type": "boolean", "description": "Status of the template. isActive = false means template is inactive, isActive = true means template is active" }, "replyTo": { "type": "string", "description": "Email on which campaign recipients will be able to reply to" }, "sender": { "type": "object", "description": "Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{\"name\":\"xyz\", \"email\":\"example@abc.com\"}** **{\"name\":\"xyz\", \"id\":123}**", "properties": { "email": { "type": "string", "description": "Email of the sender" }, "id": { "type": "integer", "description": "Select the sender for the template on the basis of sender id. _In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)_." }, "name": { "type": "string", "description": "Name of the sender" } } }, "subject": { "type": "string", "description": "Subject of the email" }, "tag": { "type": "string", "description": "Tag of the template" }, "templateName": { "type": "string", "description": "Name of the template" }, "toField": { "type": "string", "description": "To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization" } }, "required": [ "PCID", "templateId" ] } ``` *** ## brevo\_email\_upload\_image\_to\_gallery Upload an image to your account's image gallery **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `imageUrl` | string | Yes | — | The absolute url of the image (**no local file**). Maximum allowed size for image is **2MB**. Allowed extensions for images are: #### jpeg, jpg, png, bmp, gif. | | `name` | string | No | — | Name of the image. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "imageUrl": { "type": "string", "description": "The absolute url of the image (**no local file**). Maximum allowed size for image is **2MB**. Allowed extensions for images are: #### jpeg, jpg, png, bmp, gif." }, "name": { "type": "string", "description": "Name of the image." } }, "required": [ "PCID", "imageUrl" ] } ``` *** ## brevo\_email\_validate\_sender\_by\_otp Validate a sender using OTP **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `senderId` | integer | Yes | — | Id of the sender | | `otp` | integer | No | — | 6 digit OTP received on email | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "senderId": { "type": "integer", "description": "Id of the sender" }, "otp": { "type": "integer", "description": "6 digit OTP received on email" } }, "required": [ "PCID", "senderId" ] } ``` # brevo-loyalty Source: https://docs.pinkfish.ai/api-reference/mcp-servers/application/brevo/brevo-loyalty Brevo Loyalty **Server path:** `/brevo-loyalty` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | - | - | | [`brevo_loyalty_add_subscription_to_tier`](#brevo_loyalty_add_subscription_to_tier) | Assign a tier | | [`brevo_loyalty_begin_transaction`](#brevo_loyalty_begin_transaction) | Create new transaction | | [`brevo_loyalty_cancel_transaction`](#brevo_loyalty_cancel_transaction) | Cancel transaction | | [`brevo_loyalty_complete_redeem_transaction`](#brevo_loyalty_complete_redeem_transaction) | Complete redeem voucher request | | [`brevo_loyalty_complete_transaction`](#brevo_loyalty_complete_transaction) | Complete transaction | | [`brevo_loyalty_create_balance_limit`](#brevo_loyalty_create_balance_limit) | Create balance limits | | [`brevo_loyalty_create_balance_order`](#brevo_loyalty_create_balance_order) | Create balance order | | [`brevo_loyalty_create_loyalty_balance_programs_by_pid_balance_definitions`](#brevo_loyalty_create_loyalty_balance_programs_by_pid_balance_definitions) | Create balance definition | | [`brevo_loyalty_create_loyalty_balance_programs_by_pid_subscriptions_by_cid_balances`](#brevo_loyalty_create_loyalty_balance_programs_by_pid_subscriptions_by_cid_balances) | Create subscription balances | | [`brevo_loyalty_create_new_lp`](#brevo_loyalty_create_new_lp) | Create loyalty program | | [`brevo_loyalty_create_reward`](#brevo_loyalty_create_reward) | Create a reward | | [`brevo_loyalty_create_tier_for_tier_group`](#brevo_loyalty_create_tier_for_tier_group) | Create a tier | | [`brevo_loyalty_create_tier_group`](#brevo_loyalty_create_tier_group) | Create a tier group | | [`brevo_loyalty_create_voucher`](#brevo_loyalty_create_voucher) | Create a voucher | | [`brevo_loyalty_delete_balance_definition`](#brevo_loyalty_delete_balance_definition) | Delete balance definition | | [`brevo_loyalty_delete_balance_limit`](#brevo_loyalty_delete_balance_limit) | Delete balance limit | | [`brevo_loyalty_delete_contact_members`](#brevo_loyalty_delete_contact_members) | Delete subscription member | | [`brevo_loyalty_delete_contact_subscription`](#brevo_loyalty_delete_contact_subscription) | Delete subscription | | [`brevo_loyalty_delete_program`](#brevo_loyalty_delete_program) | Delete Loyalty Program | | [`brevo_loyalty_delete_tier`](#brevo_loyalty_delete_tier) | Delete tier | | [`brevo_loyalty_delete_tier_group`](#brevo_loyalty_delete_tier_group) | Delete tier group | | [`brevo_loyalty_get_balance_definition`](#brevo_loyalty_get_balance_definition) | Get balance definition | | [`brevo_loyalty_get_balance_definition_list`](#brevo_loyalty_get_balance_definition_list) | Get balance definition list | | [`brevo_loyalty_get_balance_limit`](#brevo_loyalty_get_balance_limit) | Get balance limits | | [`brevo_loyalty_get_code_count`](#brevo_loyalty_get_code_count) | Get code count | | [`brevo_loyalty_get_contact_balances`](#brevo_loyalty_get_contact_balances) | Get balance list | | [`brevo_loyalty_get_list_of_tier_groups`](#brevo_loyalty_get_list_of_tier_groups) | List tier groups | | [`brevo_loyalty_get_lplist`](#brevo_loyalty_get_lplist) | Get loyalty program list | | [`brevo_loyalty_get_offer_programs_by_pid_rewards_by_rid`](#brevo_loyalty_get_offer_programs_by_pid_rewards_by_rid) | Get reward information | | [`brevo_loyalty_get_parameter_subscription_info`](#brevo_loyalty_get_parameter_subscription_info) | Get Subscription Data | | [`brevo_loyalty_get_program_info`](#brevo_loyalty_get_program_info) | Get loyalty program Info | | [`brevo_loyalty_get_program_tier`](#brevo_loyalty_get_program_tier) | List tiers | | [`brevo_loyalty_get_subscription_balances`](#brevo_loyalty_get_subscription_balances) | Get subscription balances | | [`brevo_loyalty_get_tier_group`](#brevo_loyalty_get_tier_group) | Get tier group | | [`brevo_loyalty_list_loyalty_balance_programs_by_pid_active_balance`](#brevo_loyalty_list_loyalty_balance_programs_by_pid_active_balance) | Get Active Balances API | | [`brevo_loyalty_list_loyalty_balance_programs_by_pid_transaction_history`](#brevo_loyalty_list_loyalty_balance_programs_by_pid_transaction_history) | Get Transaction History API | | [`brevo_loyalty_list_loyalty_offer_programs_by_pid_offers`](#brevo_loyalty_list_loyalty_offer_programs_by_pid_offers) | Get Reward Page API | | [`brevo_loyalty_list_loyalty_offer_programs_by_pid_vouchers`](#brevo_loyalty_list_loyalty_offer_programs_by_pid_vouchers) | Get voucher for a contact | | [`brevo_loyalty_partially_update_loyalty_program`](#brevo_loyalty_partially_update_loyalty_program) | Partially update loyalty program | | [`brevo_loyalty_publish_loyalty_program`](#brevo_loyalty_publish_loyalty_program) | Publish loyalty program | | [`brevo_loyalty_redeem_voucher`](#brevo_loyalty_redeem_voucher) | Create redeem voucher request | | [`brevo_loyalty_revoke_vouchers`](#brevo_loyalty_revoke_vouchers) | Revoke vouchers | | [`brevo_loyalty_subscribe_member_to_asubscription`](#brevo_loyalty_subscribe_member_to_asubscription) | Create subscription member | | [`brevo_loyalty_subscribe_to_loyalty_program`](#brevo_loyalty_subscribe_to_loyalty_program) | Create subscription | | [`brevo_loyalty_update_balance_definition`](#brevo_loyalty_update_balance_definition) | Update balance definition | | [`brevo_loyalty_update_balance_limit`](#brevo_loyalty_update_balance_limit) | Updates balance limit | | [`brevo_loyalty_update_loyalty_program`](#brevo_loyalty_update_loyalty_program) | Update loyalty program | | [`brevo_loyalty_update_tier`](#brevo_loyalty_update_tier) | Update tier | | [`brevo_loyalty_update_tier_group`](#brevo_loyalty_update_tier_group) | Update tier group | | [`brevo_loyalty_validate_reward`](#brevo_loyalty_validate_reward) | Validate a reward | | [`brevo-loyalty_get_wallet_pass_install_url`](#brevo-loyalty_get_wallet_pass_install_url) | Get a pass installation URL for a contact | *** ## brevo\_loyalty\_add\_subscription\_to\_tier Assign a tier **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program ID | | `cid` | string | Yes | — | Contact ID | | `tid` | string | Yes | — | Tier ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program ID" }, "cid": { "type": "string", "description": "Contact ID" }, "tid": { "type": "string", "description": "Tier ID" } }, "required": [ "PCID", "pid", "cid", "tid" ] } ``` *** ## brevo\_loyalty\_begin\_transaction Create new transaction **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program Id | | `amount` | number | Yes | — | Transaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided). | | `autoComplete` | boolean | No | — | Whether the transaction should be automatically completed. | | `balanceDefinitionId` | string | Yes | — | Unique identifier (UUID) of the associated balance definition. | | `balanceExpiryInMinutes` | integer | No | — | Expiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true. | | `contactId` | integer | No | — | Unique identifier of the contact involved in the transaction. Required unless `LoyaltySubscriptionId` is provided. | | `eventTime` | string | No | — | Timestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format). | | `LoyaltySubscriptionId` | string | No | — | Unique identifier for the loyalty subscription. Required unless `contactId` is provided. | | `meta` | object | No | — | Optional metadata associated with the transaction. | | `transactionType` | string | No | — | Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). | | `ttl` | integer | No | — | Time-to-live for the transaction in seconds. Must be at least 10 seconds if provided. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program Id" }, "amount": { "type": "number", "description": "Transaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided)." }, "autoComplete": { "type": "boolean", "description": "Whether the transaction should be automatically completed." }, "balanceDefinitionId": { "type": "string", "description": "Unique identifier (UUID) of the associated balance definition." }, "balanceExpiryInMinutes": { "type": "integer", "description": "Expiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true." }, "contactId": { "type": "integer", "description": "Unique identifier of the contact involved in the transaction. Required unless `LoyaltySubscriptionId` is provided." }, "eventTime": { "type": "string", "description": "Timestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format)." }, "LoyaltySubscriptionId": { "type": "string", "description": "Unique identifier for the loyalty subscription. Required unless `contactId` is provided." }, "meta": { "type": "object", "description": "Optional metadata associated with the transaction." }, "transactionType": { "type": "string", "description": "Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit).", "enum": [ "credit", "debit" ] }, "ttl": { "type": "integer", "description": "Time-to-live for the transaction in seconds. Must be at least 10 seconds if provided." } }, "required": [ "PCID", "pid", "amount", "balanceDefinitionId" ] } ``` *** ## brevo\_loyalty\_cancel\_transaction Cancel transaction **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program Id | | `tid` | string | Yes | — | Transaction Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program Id" }, "tid": { "type": "string", "description": "Transaction Id" } }, "required": [ "PCID", "pid", "tid" ] } ``` *** ## brevo\_loyalty\_complete\_redeem\_transaction Complete redeem voucher request **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program ID | | `tid` | string | Yes | — | Redeem transaction ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program ID" }, "tid": { "type": "string", "description": "Redeem transaction ID" } }, "required": [ "PCID", "pid", "tid" ] } ``` *** ## brevo\_loyalty\_complete\_transaction Complete transaction **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program Id | | `tid` | string | Yes | — | Transaction Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program Id" }, "tid": { "type": "string", "description": "Transaction Id" } }, "required": [ "PCID", "pid", "tid" ] } ``` *** ## brevo\_loyalty\_create\_balance\_limit Create balance limits **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program Id | | `bdid` | string | Yes | — | Balance Definition Id | | `constraintType` | string | Yes | — | Defines whether the limit applies to transaction count or amount. | | `durationUnit` | string | Yes | — | Unit of time for which the limit is applicable. | | `durationValue` | integer | Yes | — | Number of time units for the balance limit. | | `slidingSchedule` | boolean | No | — | Determines if the limit resets on a rolling schedule. | | `transactionType` | string | Yes | — | Specifies whether the limit applies to credit or debit transactions. | | `value` | integer | Yes | — | Maximum allowed value for the specified constraint type. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program Id" }, "bdid": { "type": "string", "description": "Balance Definition Id" }, "constraintType": { "type": "string", "description": "Defines whether the limit applies to transaction count or amount.", "enum": [ "transaction", "amount" ] }, "durationUnit": { "type": "string", "description": "Unit of time for which the limit is applicable.", "enum": [ "day", "week", "month", "year" ] }, "durationValue": { "type": "integer", "description": "Number of time units for the balance limit." }, "slidingSchedule": { "type": "boolean", "description": "Determines if the limit resets on a rolling schedule." }, "transactionType": { "type": "string", "description": "Specifies whether the limit applies to credit or debit transactions.", "enum": [ "credit", "debit" ] }, "value": { "type": "integer", "description": "Maximum allowed value for the specified constraint type." } }, "required": [ "PCID", "pid", "bdid", "constraintType", "durationUnit", "durationValue", "transactionType", "value" ] } ``` *** ## brevo\_loyalty\_create\_balance\_order Create balance order **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program Id | | `amount` | number | Yes | — | Order amount (must be non-zero). | | `balanceDefinitionId` | string | Yes | — | Unique identifier (UUID) of the associated balance definition. | | `contactId` | integer | Yes | — | Unique identifier of the contact placing the order (must be ≥ 1). | | `dueAt` | string | Yes | — | RFC3339 timestamp specifying when the order is due. | | `expiresAt` | string | No | — | Optional RFC3339 timestamp defining order expiration. | | `meta` | object | No | — | Optional metadata associated with the order. | | `source` | string | Yes | — | Specifies the origin of the order. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program Id" }, "amount": { "type": "number", "description": "Order amount (must be non-zero)." }, "balanceDefinitionId": { "type": "string", "description": "Unique identifier (UUID) of the associated balance definition." }, "contactId": { "type": "integer", "description": "Unique identifier of the contact placing the order (must be ≥ 1)." }, "dueAt": { "type": "string", "description": "RFC3339 timestamp specifying when the order is due." }, "expiresAt": { "type": "string", "description": "Optional RFC3339 timestamp defining order expiration." }, "meta": { "type": "object", "description": "Optional metadata associated with the order." }, "source": { "type": "string", "description": "Specifies the origin of the order.", "enum": [ "engine", "user" ] } }, "required": [ "PCID", "pid", "amount", "balanceDefinitionId", "contactId", "dueAt", "source" ] } ``` *** ## brevo\_loyalty\_create\_loyalty\_balance\_programs\_by\_pid\_balance\_definitions Create balance definition **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program Id | | `balanceAvailabilityDurationModifier` | string | No | — | Defines when the balance expires within the selected duration. | | `balanceAvailabilityDurationUnit` | string | No | — | Unit of time for balance validity. | | `balanceAvailabilityDurationValue` | integer | No | — | Number of time units before the balance expires. | | `balanceExpirationDate` | string | No | — | Fixed expiration date (`dd/mm` format) as an alternative to duration-based expiry. | | `balanceOptionAmountOvertakingStrategy` | string | No | — | Defines whether partial credit is allowed when reaching max balance. | | `balanceOptionCreditRounding` | string | No | — | Defines rounding strategy for credit transactions. | | `balanceOptionDebitRounding` | string | No | — | Defines rounding strategy for debit transactions. | | `description` | string | No | — | Short description of the balance definition. | | `imageRef` | string | No | — | URL of an optional image reference. | | `maxAmount` | number | No | — | Maximum allowable balance amount. | | `maxCreditAmountLimit` | number | No | — | Maximum credit allowed per operation. | | `maxDebitAmountLimit` | number | No | — | Maximum debit allowed per operation. | | `meta` | object | No | — | Additional metadata for the balance definition. | | `minAmount` | number | No | — | Minimum allowable balance amount. | | `name` | string | Yes | — | Name of the balance definition. | | `unit` | string | Yes | — | Unit of balance measurement. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program Id" }, "balanceAvailabilityDurationModifier": { "type": "string", "description": "Defines when the balance expires within the selected duration.", "enum": [ "noModification", "startOfPeriod", "endOfPeriod" ] }, "balanceAvailabilityDurationUnit": { "type": "string", "description": "Unit of time for balance validity.", "enum": [ "day", "week", "month", "year" ] }, "balanceAvailabilityDurationValue": { "type": "integer", "description": "Number of time units before the balance expires." }, "balanceExpirationDate": { "type": "string", "description": "Fixed expiration date (`dd/mm` format) as an alternative to duration-based expiry." }, "balanceOptionAmountOvertakingStrategy": { "type": "string", "description": "Defines whether partial credit is allowed when reaching max balance.", "enum": [ "strict", "partial" ] }, "balanceOptionCreditRounding": { "type": "string", "description": "Defines rounding strategy for credit transactions.", "enum": [ "lower", "upper", "natural" ] }, "balanceOptionDebitRounding": { "type": "string", "description": "Defines rounding strategy for debit transactions.", "enum": [ "lower", "upper", "natural" ] }, "description": { "type": "string", "description": "Short description of the balance definition." }, "imageRef": { "type": "string", "description": "URL of an optional image reference." }, "maxAmount": { "type": "number", "description": "Maximum allowable balance amount." }, "maxCreditAmountLimit": { "type": "number", "description": "Maximum credit allowed per operation." }, "maxDebitAmountLimit": { "type": "number", "description": "Maximum debit allowed per operation." }, "meta": { "type": "object", "description": "Additional metadata for the balance definition.", "properties": { "isInternal": { "type": "boolean", "description": "Indicates whether the balance definition is internal." } } }, "minAmount": { "type": "number", "description": "Minimum allowable balance amount." }, "name": { "type": "string", "description": "Name of the balance definition." }, "unit": { "type": "string", "description": "Unit of balance measurement.", "enum": [ "POINTS", "EUR", "USD", "MXN", "GBP", "INR", "CAD", "SGD", "RON", "JPY", "MYR", "CLP", "PEN", "MAD", "AUD", "CHF", "BRL" ] } }, "required": [ "PCID", "pid", "name", "unit" ] } ``` *** ## brevo\_loyalty\_create\_loyalty\_balance\_programs\_by\_pid\_subscriptions\_by\_cid\_balances Create subscription balances **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program Id | | `cid` | string | Yes | — | Contact Id | | `balanceDefinitionId` | string | Yes | — | Unique identifier (UUID) of the balance definition associated with the new balance. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program Id" }, "cid": { "type": "string", "description": "Contact Id" }, "balanceDefinitionId": { "type": "string", "description": "Unique identifier (UUID) of the balance definition associated with the new balance." } }, "required": [ "PCID", "pid", "cid", "balanceDefinitionId" ] } ``` *** ## brevo\_loyalty\_create\_new\_lp Create loyalty program **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `description` | string | No | — | Optional description of the loyalty program (max 256 chars). | | `documentId` | string | No | — | Optional unique document ID. | | `meta` | object | No | — | Optional metadata related to the loyalty program. | | `name` | string | Yes | — | Required name of the loyalty program (max 128 chars). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "Optional description of the loyalty program (max 256 chars)." }, "documentId": { "type": "string", "description": "Optional unique document ID." }, "meta": { "type": "object", "description": "Optional metadata related to the loyalty program." }, "name": { "type": "string", "description": "Required name of the loyalty program (max 128 chars)." } }, "required": [ "PCID", "name" ] } ``` *** ## brevo\_loyalty\_create\_reward Create a reward **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program ID | | `name` | string | Yes | — | Internal name of the reward | | `publicDescription` | string | No | — | Public facing description of the reward | | `publicImage` | string | No | — | URL of the public image for the reward | | `publicName` | string | No | — | Public facing name of the reward | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program ID" }, "name": { "type": "string", "description": "Internal name of the reward" }, "publicDescription": { "type": "string", "description": "Public facing description of the reward" }, "publicImage": { "type": "string", "description": "URL of the public image for the reward" }, "publicName": { "type": "string", "description": "Public facing name of the reward" } }, "required": [ "PCID", "pid", "name" ] } ``` *** ## brevo\_loyalty\_create\_tier\_for\_tier\_group Create a tier **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program ID | | `gid` | string | Yes | — | Tier group ID | | `accessConditions` | object\[] | Yes | — | Access Conditions | | `imageRef` | string | No | — | Image of the tier | | `name` | string | Yes | — | Name of the tier to be created | | `tierRewards` | object\[] | No | — | Tier Rewards | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pid": { "type": "string", "description": "Loyalty Program ID" }, "gid": { "type": "string", "description": "Tier group ID" }, "accessConditions": { "type": "array", "items": { "type": "object", "properties": { "balanceDefinitionId": { "type": "string", "format": "uuid", "description": "Balance definition identifier for accessing the tier" }, "minimumValue": { "type": "integer", "description": "Minimum value required to access the tier" } } }, "description": "Access Conditions" }, "imageRef": { "type": "string", "description": "Image of the tier" }, "name": { "type": "string", "description": "Name of the tier to be created" }, "tierRewards": { "type": "array", "items": { "type": "object", "properties": { "rewardId": { "type": "string", "format": "uuid", "description": "Reward unique identifier" } } }, "description": "Tier Rewards" } }, "required": [ "PCID", "pid", "gid", "accessConditions", "name" ] } ``` *** ## brevo\_loyalty\_create\_tier\_group Create a tier group **Parameters:** | Parameter | Type | Required | Default | Description | | - | - | - | - | - | | `pid` | string | Yes | — | Loyalty Program ID | | `downgradeSchedule` | object | No | — | Schedule configuration for tier downgrades. Required when downgradeStrategy is set to a schedule-based strategy. | | `downgradeStrategy` | string | No | — | Select real\_time to downgrade tier on real time balance updates. Select membership\_anniversary to downgrade tier on subscription anniversary. Select tier\_anniversary to downgrade tier on tier anniversary. | | `meta` | object | No | — | Additional metadata for the tier group. | | `name` | string | Yes | — | Name of the tier group | | `tierOrder` | string\[] | N