Slateo MCP
REST API docs

Slateo MCP Server

Model Context Protocol server for the Slateo API — connect an MCP client to call these tools directly, scoped to your account and permissions.

Get started Authentication

Overview

The Slateo MCP server exposes the Slateo API as MCP tools over Streamable HTTP. Every tool call is proxied to the REST API using the caller's own API key, so results are scoped to that key's account and the calling member's permissions — the same rules that apply to a normal API request.

New here? Start with Quickstart. For how the auth header is checked and what it scopes, see Authentication.

What's available

Most operations go through six generic tools shared across every resource type — list_resource, create_resource, get_resource, update_resource, delete_resource, describe_resource — each taking a resource name plus the relevant arguments. Since create_resource/update_resource take a free-form body, call describe_resource first to get a resource's exact field names, types and enum values (e.g. a form field's allowed type values) straight from the API spec. Everything else (bulk endpoints, sub-resources, one-off actions) gets its own tool, grouped below by resource.

Quickstart

1. Get an API key

API keys are available from Slateo app settings. See Authentication for what the key can access.

2. Connect

Endpointhttps://app.slateo.io/mcp
TransportStreamable HTTP (stateless — no session is kept between requests)
AuthAuthorization: Bearer <api-key>

3. Connect your client

Steps and config field names for remote HTTP MCP servers vary by client. Pick yours:

Claude Code

From the CLI, add it as a remote HTTP server (-s user makes it available in every project, not just the current one):

claude mcp add --transport http slateo https://app.slateo.io/mcp \
  --header "Authorization: Bearer <api-key>" \
  -s user
Cursor

Add to ~/.cursor/mcp.json (global) or .cursor/mcp.json (project), then enable it under Settings → MCP:

{
  "mcpServers": {
    "slateo": {
      "url": "https://app.slateo.io/mcp",
      "headers": {
        "Authorization": "Bearer <api-key>"
      }
    }
  }
}
VS Code (GitHub Copilot)

Add to .vscode/mcp.json, or via the Command Palette → MCP: Add Server → HTTP. MCP tools only appear in Copilot Chat's Agent mode, not Ask mode:

{
  "servers": {
    "slateo": {
      "type": "http",
      "url": "https://app.slateo.io/mcp",
      "headers": {
        "Authorization": "Bearer <api-key>"
      }
    }
  }
}
Claude Desktop

Settings → Connectors → Add custom connector → paste the endpoint, then open Request headers and add Authorization / Bearer <api-key>.

Header-based auth for custom connectors is currently in beta and may not be enabled on every account yet — if you don't see a Request headers section, it isn't available for you yet.

Windsurf

Edit ~/.codeium/windsurf/mcp_config.json — note the field is serverUrl, not url. Fully quit and reopen Windsurf afterward; closing the window alone doesn't reload MCP config:

{
  "mcpServers": {
    "slateo": {
      "serverUrl": "https://app.slateo.io/mcp",
      "headers": {
        "Authorization": "Bearer <api-key>"
      }
    }
  }
}
ChatGPT

ChatGPT's custom connectors (Settings → Apps & Connectors → Advanced settings → Developer mode) currently only support OAuth or no auth for remote MCP servers — there's no field for a static API key or bearer token. That means the Slateo MCP server can't be connected through ChatGPT's connector UI today. Use the REST API directly, or a client from this list that supports header-based auth, instead.

Codex

Edit ~/.codex/config.toml. Keep the key out of the file by reading it from an environment variable:

[mcp_servers.slateo]
url = "https://app.slateo.io/mcp"
bearer_token_env_var = "SLATEO_API_KEY"

Then export SLATEO_API_KEY=<api-key> in the shell you launch codex from.

Antigravity

Edit ~/.gemini/config/mcp_config.json (global) or .agents/mcp_config.json (workspace) — note the field is serverUrl, not url:

{
  "mcpServers": {
    "slateo": {
      "serverUrl": "https://app.slateo.io/mcp",
      "headers": {
        "Authorization": "Bearer <api-key>"
      }
    }
  }
}
Other MCP clients

Any client that supports a remote HTTP (or SSE) MCP server with custom headers can connect with:

URLhttps://app.slateo.io/mcp
HeaderAuthorization: Bearer <api-key>

Clients that only support local stdio servers (a command to launch, no url) can't connect to a remote server like this one directly.

4. Try a tool call

Once connected, list_resource is a good first call — it needs no ID and works for any resource:

{
  "resource": "Tasks"
}

Authentication

Every tool call is authenticated the same way as a REST API request — there's no separate MCP-specific credential.

HeaderAuthorization: Bearer <api-key>
Getting a keyAvailable from Slateo app settings
ScopeThe member who created the key, within their account — same role and permissions as using the app

Since tool calls are proxied straight into the REST API with that header, a request the key isn't permitted to make over the API will fail the same way over MCP — the tool result reports the underlying HTTP status and error body.

Generic resource tools

getlist_resource

List records of a Slateo resource. Supported resources: Members, Memberships, Roles, Projects, Workstreams, Tasks, Tasklets, Labels, Ideas, Initiatives, Objectives, ObjectiveCycles, Products, ProjectCycles, Milestones, Documents, Acknowledgements, Forms, CustomFields, Entities, Customers, Vendors, Bills, Materials, Automations, Locations, StockTransactions, PurchaseRequisitions, PurchaseOrders, Deliveries, Assets, MaintenanceRequests, HousekeepingTasks, SopTemplates, TaskRecurrences, RecurringOperationalSchedules, BookingResources, Bookings, BookingResourceLayouts, Deals, DealPipelines, Invoices, Reminders.

{
  "type": "object",
  "properties": {
    "resource": {
      "type": "string",
      "enum": [
        "Members",
        "Memberships",
        "Roles",
        "Projects",
        "Workstreams",
        "Tasks",
        "Tasklets",
        "Labels",
        "Ideas",
        "Initiatives",
        "Objectives",
        "ObjectiveCycles",
        "Products",
        "ProjectCycles",
        "Milestones",
        "Documents",
        "Acknowledgements",
        "Forms",
        "CustomFields",
        "Entities",
        "Customers",
        "Vendors",
        "Bills",
        "Materials",
        "Automations",
        "Locations",
        "StockTransactions",
        "PurchaseRequisitions",
        "PurchaseOrders",
        "Deliveries",
        "Assets",
        "MaintenanceRequests",
        "HousekeepingTasks",
        "SopTemplates",
        "TaskRecurrences",
        "RecurringOperationalSchedules",
        "BookingResources",
        "Bookings",
        "BookingResourceLayouts",
        "Deals",
        "DealPipelines",
        "Invoices",
        "Reminders"
      ]
    },
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Optional query-string filters"
    }
  },
  "required": [
    "resource"
  ],
  "additionalProperties": false
}

postcreate_resource

Create a record of a Slateo resource. Supported resources: Members, Memberships, Roles, Projects, Workstreams, Tasks, Tasklets, Ideas, Initiatives, Objectives, ObjectiveCycles, Products, ProjectCycles, Milestones, Documents, Acknowledgements, Forms, CustomFields, Customers, Vendors, Bills, Materials, Automations, Locations, StockTransactions, PurchaseRequisitions, PurchaseOrders, Deliveries, Assets, MaintenanceRequests, HousekeepingTasks, SopTemplates, TaskRecurrences, RecurringOperationalSchedules, BookingResources, Bookings, BookingResourceLayouts, Deals, DealPipelines, Invoices, Reminders. See the Slateo OpenAPI spec for each resource's body schema.

{
  "type": "object",
  "properties": {
    "resource": {
      "type": "string",
      "enum": [
        "Members",
        "Memberships",
        "Roles",
        "Projects",
        "Workstreams",
        "Tasks",
        "Tasklets",
        "Ideas",
        "Initiatives",
        "Objectives",
        "ObjectiveCycles",
        "Products",
        "ProjectCycles",
        "Milestones",
        "Documents",
        "Acknowledgements",
        "Forms",
        "CustomFields",
        "Customers",
        "Vendors",
        "Bills",
        "Materials",
        "Automations",
        "Locations",
        "StockTransactions",
        "PurchaseRequisitions",
        "PurchaseOrders",
        "Deliveries",
        "Assets",
        "MaintenanceRequests",
        "HousekeepingTasks",
        "SopTemplates",
        "TaskRecurrences",
        "RecurringOperationalSchedules",
        "BookingResources",
        "Bookings",
        "BookingResourceLayouts",
        "Deals",
        "DealPipelines",
        "Invoices",
        "Reminders"
      ]
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "resource",
    "body"
  ],
  "additionalProperties": false
}

getget_resource

Get a single record by ID of a Slateo resource. Supported resources: Accounts, Members, Roles, Projects, Tasks, Products, ProjectCycles, Milestones, Documents, Forms, CustomFields, Customers, Vendors, Bills, Materials, Automations, Locations, StockTransactions, PurchaseRequisitions, PurchaseOrders, Deliveries, Assets, MaintenanceRequests, HousekeepingTasks, SopTemplates, TaskRecurrences, RecurringOperationalSchedules, BookingResources, Bookings, BookingResourceLayouts, Deals, DealPipelines, Invoices.

{
  "type": "object",
  "properties": {
    "resource": {
      "type": "string",
      "enum": [
        "Accounts",
        "Members",
        "Roles",
        "Projects",
        "Tasks",
        "Products",
        "ProjectCycles",
        "Milestones",
        "Documents",
        "Forms",
        "CustomFields",
        "Customers",
        "Vendors",
        "Bills",
        "Materials",
        "Automations",
        "Locations",
        "StockTransactions",
        "PurchaseRequisitions",
        "PurchaseOrders",
        "Deliveries",
        "Assets",
        "MaintenanceRequests",
        "HousekeepingTasks",
        "SopTemplates",
        "TaskRecurrences",
        "RecurringOperationalSchedules",
        "BookingResources",
        "Bookings",
        "BookingResourceLayouts",
        "Deals",
        "DealPipelines",
        "Invoices"
      ]
    },
    "id": {
      "type": "string",
      "description": "The record's ID"
    }
  },
  "required": [
    "resource",
    "id"
  ],
  "additionalProperties": false
}

patchupdate_resource

Update a record by ID of a Slateo resource. Supported resources: Accounts, Members, Memberships, Roles, Projects, Workstreams, Tasks, Tasklets, Ideas, Initiatives, Objectives, ObjectiveCycles, Products, ProjectCycles, Milestones, Documents, Forms, CustomFields, Customers, Vendors, Bills, Materials, Automations, Locations, PurchaseRequisitions, PurchaseOrders, Deliveries, Assets, MaintenanceRequests, HousekeepingTasks, SopTemplates, TaskRecurrences, RecurringOperationalSchedules, BookingResources, Bookings, BookingResourceLayouts, Deals, DealPipelines, Invoices, Reminders.

{
  "type": "object",
  "properties": {
    "resource": {
      "type": "string",
      "enum": [
        "Accounts",
        "Members",
        "Memberships",
        "Roles",
        "Projects",
        "Workstreams",
        "Tasks",
        "Tasklets",
        "Ideas",
        "Initiatives",
        "Objectives",
        "ObjectiveCycles",
        "Products",
        "ProjectCycles",
        "Milestones",
        "Documents",
        "Forms",
        "CustomFields",
        "Customers",
        "Vendors",
        "Bills",
        "Materials",
        "Automations",
        "Locations",
        "PurchaseRequisitions",
        "PurchaseOrders",
        "Deliveries",
        "Assets",
        "MaintenanceRequests",
        "HousekeepingTasks",
        "SopTemplates",
        "TaskRecurrences",
        "RecurringOperationalSchedules",
        "BookingResources",
        "Bookings",
        "BookingResourceLayouts",
        "Deals",
        "DealPipelines",
        "Invoices",
        "Reminders"
      ]
    },
    "id": {
      "type": "string",
      "description": "The record's ID"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Fields to update"
    }
  },
  "required": [
    "resource",
    "id",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_resource

Delete a record by ID of a Slateo resource. Supported resources: Accounts, Members, Memberships, Roles, Projects, Workstreams, Tasks, Initiatives, Objectives, ObjectiveCycles, Products, ProjectCycles, Milestones, Documents, CustomFields, Customers, Vendors, Bills, Materials, Automations, Locations, PurchaseRequisitions, PurchaseOrders, Deliveries, Assets, MaintenanceRequests, HousekeepingTasks, SopTemplates, TaskRecurrences, RecurringOperationalSchedules, BookingResources, Bookings, BookingResourceLayouts, Deals, DealPipelines, Invoices, Reminders.

{
  "type": "object",
  "properties": {
    "resource": {
      "type": "string",
      "enum": [
        "Accounts",
        "Members",
        "Memberships",
        "Roles",
        "Projects",
        "Workstreams",
        "Tasks",
        "Initiatives",
        "Objectives",
        "ObjectiveCycles",
        "Products",
        "ProjectCycles",
        "Milestones",
        "Documents",
        "CustomFields",
        "Customers",
        "Vendors",
        "Bills",
        "Materials",
        "Automations",
        "Locations",
        "PurchaseRequisitions",
        "PurchaseOrders",
        "Deliveries",
        "Assets",
        "MaintenanceRequests",
        "HousekeepingTasks",
        "SopTemplates",
        "TaskRecurrences",
        "RecurringOperationalSchedules",
        "BookingResources",
        "Bookings",
        "BookingResourceLayouts",
        "Deals",
        "DealPipelines",
        "Invoices",
        "Reminders"
      ]
    },
    "id": {
      "type": "string",
      "description": "The record's ID"
    }
  },
  "required": [
    "resource",
    "id"
  ],
  "additionalProperties": false
}

getdescribe_resource

Get the request body JSON Schema (field names, types, required-ness, enum values) for creating and/or updating a Slateo resource. Call this before create_resource/update_resource when you need exact field names or allowed values (e.g. a form field's allowed "type" values). Supported resources: Accounts, Members, Memberships, Roles, Projects, Workstreams, Tasks, Tasklets, Ideas, Initiatives, Objectives, ObjectiveCycles, Products, ProjectCycles, Milestones, Documents, Acknowledgements, Forms, CustomFields, Customers, Vendors, Bills, Materials, Automations, Locations, StockTransactions, PurchaseRequisitions, PurchaseOrders, Deliveries, Assets, MaintenanceRequests, HousekeepingTasks, SopTemplates, TaskRecurrences, RecurringOperationalSchedules, BookingResources, Bookings, BookingResourceLayouts, Deals, DealPipelines, Invoices, Reminders.

{
  "type": "object",
  "properties": {
    "resource": {
      "type": "string",
      "enum": [
        "Accounts",
        "Members",
        "Memberships",
        "Roles",
        "Projects",
        "Workstreams",
        "Tasks",
        "Tasklets",
        "Ideas",
        "Initiatives",
        "Objectives",
        "ObjectiveCycles",
        "Products",
        "ProjectCycles",
        "Milestones",
        "Documents",
        "Acknowledgements",
        "Forms",
        "CustomFields",
        "Customers",
        "Vendors",
        "Bills",
        "Materials",
        "Automations",
        "Locations",
        "StockTransactions",
        "PurchaseRequisitions",
        "PurchaseOrders",
        "Deliveries",
        "Assets",
        "MaintenanceRequests",
        "HousekeepingTasks",
        "SopTemplates",
        "TaskRecurrences",
        "RecurringOperationalSchedules",
        "BookingResources",
        "Bookings",
        "BookingResourceLayouts",
        "Deals",
        "DealPipelines",
        "Invoices",
        "Reminders"
      ]
    }
  },
  "required": [
    "resource"
  ],
  "additionalProperties": false
}

Accounts

postpost_accounts_by_accountid_subscription_initiate

[Accounts] Initiate a subscription payment (POST /accounts/{accountId}/subscription/initiate)

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "Path parameter: accountId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "accountId",
    "body"
  ],
  "additionalProperties": false
}

postpost_accounts_by_accountid_subscription_verify

[Accounts] Verify subscription payment (POST /accounts/{accountId}/subscription/verify)

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "Path parameter: accountId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "accountId",
    "body"
  ],
  "additionalProperties": false
}

getget_accounts_by_accountid_files_by_filename_upload_url

[Accounts] Get a presigned upload URL for a file (GET /accounts/{accountId}/files/{fileName}/upload-url)

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "Path parameter: accountId"
    },
    "fileName": {
      "type": "string",
      "description": "Path parameter: fileName"
    },
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "required": [
    "accountId",
    "fileName"
  ],
  "additionalProperties": false
}

getget_accounts_by_accountid_attachments

[Accounts] List attachments for an account (GET /accounts/{accountId}/attachments)

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "Path parameter: accountId"
    },
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "required": [
    "accountId"
  ],
  "additionalProperties": false
}

patchpatch_accounts_by_accountid_attachments_by_attachmentid

[Accounts] Update an attachment (PATCH /accounts/{accountId}/attachments/{attachmentId})

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "Path parameter: accountId"
    },
    "attachmentId": {
      "type": "string",
      "description": "Path parameter: attachmentId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "accountId",
    "attachmentId",
    "body"
  ],
  "additionalProperties": false
}

Automations

getget_automations_by_automationid_runs

[Automations] List an automation's run log (GET /automations/{automationId}/runs)

{
  "type": "object",
  "properties": {
    "automationId": {
      "type": "string",
      "description": "Path parameter: automationId"
    },
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "required": [
    "automationId"
  ],
  "additionalProperties": false
}

Bills

getget_bills_settings_numbering

[Bills] Get the account's bill numbering settings (GET /bills/settings/numbering)

{
  "type": "object",
  "properties": {}
}

patchpatch_bills_settings_numbering

[Bills] Update the account's bill numbering prefix and/or reset the counter (PATCH /bills/settings/numbering)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

getget_bills_dashboard_data

[Bills] Get aggregate dashboard data for the bills workflow (GET /bills/dashboard-data)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "additionalProperties": false
}

getget_bills_summary_by_clienttype

[Bills] Get bills summary grouped by category and vendor (GET /bills/summary/{clientType})

{
  "type": "object",
  "properties": {
    "clientType": {
      "type": "string",
      "description": "Path parameter: clientType"
    },
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "required": [
    "clientType"
  ],
  "additionalProperties": false
}

getget_bills_summary_by_clienttype_vendor_by_vendorid

[Bills] Get bills summary for a single vendor, grouped by resource (GET /bills/summary/{clientType}/vendor/{vendorId})

{
  "type": "object",
  "properties": {
    "clientType": {
      "type": "string",
      "description": "Path parameter: clientType"
    },
    "vendorId": {
      "type": "string",
      "description": "Path parameter: vendorId"
    },
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "required": [
    "clientType",
    "vendorId"
  ],
  "additionalProperties": false
}

getget_bills_summary_by_clienttype_material

[Bills] Get bills summary grouped by material (GET /bills/summary/{clientType}/material)

{
  "type": "object",
  "properties": {
    "clientType": {
      "type": "string",
      "description": "Path parameter: clientType"
    },
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "required": [
    "clientType"
  ],
  "additionalProperties": false
}

postpost_bills_by_billid_stage

[Bills] Move a bill to a different workflow stage (POST /bills/{billId}/stage)

{
  "type": "object",
  "properties": {
    "billId": {
      "type": "string",
      "description": "Path parameter: billId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "billId",
    "body"
  ],
  "additionalProperties": false
}

postpost_bills_by_billid_flag

[Bills] Flag a bill (POST /bills/{billId}/flag)

{
  "type": "object",
  "properties": {
    "billId": {
      "type": "string",
      "description": "Path parameter: billId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "billId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_bills_by_billid_flag

[Bills] Remove the flag from a bill (DELETE /bills/{billId}/flag)

{
  "type": "object",
  "properties": {
    "billId": {
      "type": "string",
      "description": "Path parameter: billId"
    }
  },
  "required": [
    "billId"
  ],
  "additionalProperties": false
}

BookingResourceLayouts

postpost_booking_resource_layouts_by_layoutid_items

[BookingResourceLayouts] Add an item to a layout (POST /booking-resource-layouts/{layoutId}/items)

{
  "type": "object",
  "properties": {
    "layoutId": {
      "type": "string",
      "description": "Path parameter: layoutId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "layoutId",
    "body"
  ],
  "additionalProperties": false
}

postpost_booking_resource_layouts_by_layoutid_items_bulk

[BookingResourceLayouts] Add multiple items to a layout at once (POST /booking-resource-layouts/{layoutId}/items/bulk)

{
  "type": "object",
  "properties": {
    "layoutId": {
      "type": "string",
      "description": "Path parameter: layoutId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "layoutId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_booking_resource_layouts_by_layoutid_items_bulk

[BookingResourceLayouts] Save dragged item positions in bulk (PATCH /booking-resource-layouts/{layoutId}/items/bulk)

{
  "type": "object",
  "properties": {
    "layoutId": {
      "type": "string",
      "description": "Path parameter: layoutId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "layoutId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_booking_resource_layouts_by_layoutid_items_by_itemid

[BookingResourceLayouts] Update a single layout item (PATCH /booking-resource-layouts/{layoutId}/items/{itemId})

{
  "type": "object",
  "properties": {
    "layoutId": {
      "type": "string",
      "description": "Path parameter: layoutId"
    },
    "itemId": {
      "type": "string",
      "description": "Path parameter: itemId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "layoutId",
    "itemId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_booking_resource_layouts_by_layoutid_items_by_itemid

[BookingResourceLayouts] Remove an item from a layout (DELETE /booking-resource-layouts/{layoutId}/items/{itemId})

{
  "type": "object",
  "properties": {
    "layoutId": {
      "type": "string",
      "description": "Path parameter: layoutId"
    },
    "itemId": {
      "type": "string",
      "description": "Path parameter: itemId"
    }
  },
  "required": [
    "layoutId",
    "itemId"
  ],
  "additionalProperties": false
}

BookingResources

postpost_booking_resources_bulk

[BookingResources] Create multiple booking resources at once (POST /booking-resources/bulk)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

Customers

getget_customers_settings_statuses

[Customers] Get the account's configured customer status options (GET /customers/settings/statuses)

{
  "type": "object",
  "properties": {}
}

patchpatch_customers_settings_statuses

[Customers] Replace the account's configured customer status options (PATCH /customers/settings/statuses)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_customers_by_customerid_merge

[Customers] Merge a customer with type "unknown" into an existing customer (POST /customers/{customerId}/merge)

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "description": "Path parameter: customerId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "customerId",
    "body"
  ],
  "additionalProperties": false
}

getget_customers_by_customerid_contacts

[Customers] List contacts for a customer (GET /customers/{customerId}/contacts)

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "description": "Path parameter: customerId"
    }
  },
  "required": [
    "customerId"
  ],
  "additionalProperties": false
}

postpost_customers_by_customerid_contacts

[Customers] Add a contact to a customer (POST /customers/{customerId}/contacts)

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "description": "Path parameter: customerId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "customerId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_customers_by_customerid_contacts_by_contactid

[Customers] Update a contact (PATCH /customers/{customerId}/contacts/{contactId})

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "description": "Path parameter: customerId"
    },
    "contactId": {
      "type": "string",
      "description": "Path parameter: contactId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "customerId",
    "contactId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_customers_by_customerid_contacts_by_contactid

[Customers] Remove a contact (DELETE /customers/{customerId}/contacts/{contactId})

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "description": "Path parameter: customerId"
    },
    "contactId": {
      "type": "string",
      "description": "Path parameter: contactId"
    }
  },
  "required": [
    "customerId",
    "contactId"
  ],
  "additionalProperties": false
}

getget_customers_by_customerid_interactions

[Customers] List interactions (calls, emails, meetings, notes) logged against a customer (GET /customers/{customerId}/interactions)

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "description": "Path parameter: customerId"
    }
  },
  "required": [
    "customerId"
  ],
  "additionalProperties": false
}

postpost_customers_by_customerid_interactions

[Customers] Log an interaction against a customer (POST /customers/{customerId}/interactions)

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "description": "Path parameter: customerId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "customerId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_customers_by_customerid_interactions_by_interactionid

[Customers] Update a logged interaction (PATCH /customers/{customerId}/interactions/{interactionId})

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "description": "Path parameter: customerId"
    },
    "interactionId": {
      "type": "string",
      "description": "Path parameter: interactionId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "customerId",
    "interactionId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_customers_by_customerid_interactions_by_interactionid

[Customers] Delete a logged interaction (DELETE /customers/{customerId}/interactions/{interactionId})

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "description": "Path parameter: customerId"
    },
    "interactionId": {
      "type": "string",
      "description": "Path parameter: interactionId"
    }
  },
  "required": [
    "customerId",
    "interactionId"
  ],
  "additionalProperties": false
}

CustomFields

putput_custom_fields_by_customfieldid_values

[CustomFields] Set values for a custom field (PUT /custom-fields/{customFieldId}/values)

{
  "type": "object",
  "properties": {
    "customFieldId": {
      "type": "string",
      "description": "Path parameter: customFieldId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "customFieldId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_custom_fields_values_by_valueid

[CustomFields] Delete a custom field value (DELETE /custom-fields/values/{valueId})

{
  "type": "object",
  "properties": {
    "valueId": {
      "type": "string",
      "description": "Path parameter: valueId"
    }
  },
  "required": [
    "valueId"
  ],
  "additionalProperties": false
}

getget_custom_fields_resource_by_resourcetype_by_resourceid

[CustomFields] Get custom field values for a specific resource (GET /custom-fields/resource/{resourceType}/{resourceId})

{
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "description": "Path parameter: resourceType"
    },
    "resourceId": {
      "type": "string",
      "description": "Path parameter: resourceId"
    }
  },
  "required": [
    "resourceType",
    "resourceId"
  ],
  "additionalProperties": false
}

Deals

getget_deals_settings_numbering

[Deals] Get the account's deal numbering settings (GET /deals/settings/numbering)

{
  "type": "object",
  "properties": {}
}

patchpatch_deals_settings_numbering

[Deals] Update the account's deal numbering prefix and/or reset the counter (PATCH /deals/settings/numbering)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_deals_by_dealid_stage

[Deals] Move a deal to a different pipeline stage (POST /deals/{dealId}/stage)

{
  "type": "object",
  "properties": {
    "dealId": {
      "type": "string",
      "description": "Path parameter: dealId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "dealId",
    "body"
  ],
  "additionalProperties": false
}

getget_deals_by_dealid_interactions

[Deals] List interactions logged against a deal (GET /deals/{dealId}/interactions)

{
  "type": "object",
  "properties": {
    "dealId": {
      "type": "string",
      "description": "Path parameter: dealId"
    }
  },
  "required": [
    "dealId"
  ],
  "additionalProperties": false
}

postpost_deals_by_dealid_interactions

[Deals] Log an interaction against a deal (POST /deals/{dealId}/interactions)

{
  "type": "object",
  "properties": {
    "dealId": {
      "type": "string",
      "description": "Path parameter: dealId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "dealId",
    "body"
  ],
  "additionalProperties": false
}

Deliveries

getget_deliveries_settings_numbering

[Deliveries] Get the account's delivery numbering settings (GET /deliveries/settings/numbering)

{
  "type": "object",
  "properties": {}
}

patchpatch_deliveries_settings_numbering

[Deliveries] Update the account's delivery numbering prefix and/or reset the counter (PATCH /deliveries/settings/numbering)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_deliveries_by_deliveryid_stage

[Deliveries] Move a delivery to a different workflow stage (POST /deliveries/{deliveryId}/stage)

{
  "type": "object",
  "properties": {
    "deliveryId": {
      "type": "string",
      "description": "Path parameter: deliveryId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "deliveryId",
    "body"
  ],
  "additionalProperties": false
}

Documents

getget_documents_by_documentid_versions

[Documents] List a document's versions (GET /documents/{documentId}/versions)

{
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "description": "Path parameter: documentId"
    }
  },
  "required": [
    "documentId"
  ],
  "additionalProperties": false
}

postpost_documents_by_documentid_versions

[Documents] Create a new version (POST /documents/{documentId}/versions)

{
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "description": "Path parameter: documentId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "documentId",
    "body"
  ],
  "additionalProperties": false
}

getget_documents_by_documentid_versions_by_versionid

[Documents] Get a single document version (GET /documents/{documentId}/versions/{versionId})

{
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "description": "Path parameter: documentId"
    },
    "versionId": {
      "type": "string",
      "description": "Path parameter: versionId"
    }
  },
  "required": [
    "documentId",
    "versionId"
  ],
  "additionalProperties": false
}

Entities

getget_entities_by_entityid_participation_types

[Entities] List participation types for an entity (GET /entities/{entityId}/participation_types)

{
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string",
      "description": "Path parameter: entityId"
    }
  },
  "required": [
    "entityId"
  ],
  "additionalProperties": false
}

postpost_entities_by_entityid_participation_types

[Entities] Add a participation type to an entity (POST /entities/{entityId}/participation_types)

{
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string",
      "description": "Path parameter: entityId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "entityId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_entities_by_entityid_participation_types_by_typeid

[Entities] Update a participation type (PATCH /entities/{entityId}/participation_types/{typeId})

{
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string",
      "description": "Path parameter: entityId"
    },
    "typeId": {
      "type": "string",
      "description": "Path parameter: typeId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "entityId",
    "typeId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_entities_by_entityid_participation_types_by_typeid

[Entities] Delete a participation type (DELETE /entities/{entityId}/participation_types/{typeId})

{
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string",
      "description": "Path parameter: entityId"
    },
    "typeId": {
      "type": "string",
      "description": "Path parameter: typeId"
    }
  },
  "required": [
    "entityId",
    "typeId"
  ],
  "additionalProperties": false
}

getget_entities_by_entityid_participation_types_by_typeid_allowed_participants

[Entities] List allowed participants for a participation type (GET /entities/{entityId}/participation_types/{typeId}/allowed_participants)

{
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string",
      "description": "Path parameter: entityId"
    },
    "typeId": {
      "type": "string",
      "description": "Path parameter: typeId"
    }
  },
  "required": [
    "entityId",
    "typeId"
  ],
  "additionalProperties": false
}

postpost_entities_by_entityid_participation_types_by_typeid_allowed_participants

[Entities] Add a member to a participation type's allow-list (POST /entities/{entityId}/participation_types/{typeId}/allowed_participants)

{
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string",
      "description": "Path parameter: entityId"
    },
    "typeId": {
      "type": "string",
      "description": "Path parameter: typeId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "entityId",
    "typeId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_entities_by_entityid_participation_types_by_typeid_allowed_parti_8d9582bb

[Entities] Remove a member from a participation type's allow-list (DELETE /entities/{entityId}/participation_types/{typeId}/allowed_participants/{allowedParticipantId})

{
  "type": "object",
  "properties": {
    "entityId": {
      "type": "string",
      "description": "Path parameter: entityId"
    },
    "typeId": {
      "type": "string",
      "description": "Path parameter: typeId"
    },
    "allowedParticipantId": {
      "type": "string",
      "description": "Path parameter: allowedParticipantId"
    }
  },
  "required": [
    "entityId",
    "typeId",
    "allowedParticipantId"
  ],
  "additionalProperties": false
}

EntityWorkflowTemplates

postpost_entity_workflow_templates_by_workflowtemplateid_entity_workflow_te_37e0166a

[EntityWorkflowTemplates] Reorder workflow template stages (POST /entity-workflow-templates/{workflowTemplateId}/entity-workflow-template-stages-order)

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "workflowTemplateId",
    "body"
  ],
  "additionalProperties": false
}

postpost_entity_workflow_templates_by_workflowtemplateid_entity_workflow_te_86271868

[EntityWorkflowTemplates] Add a stage to a workflow template (POST /entity-workflow-templates/{workflowTemplateId}/entity-workflow-template-stages)

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "workflowTemplateId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_entity_workflow_templates_by_workflowtemplateid_entity_workflow_t_c1b63587

[EntityWorkflowTemplates] Update a workflow template stage (PATCH /entity-workflow-templates/{workflowTemplateId}/entity-workflow-template-stages/{workflowTemplateStageId})

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    },
    "workflowTemplateStageId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateStageId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "workflowTemplateId",
    "workflowTemplateStageId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_entity_workflow_templates_by_workflowtemplateid_entity_workflow__3567a3fd

[EntityWorkflowTemplates] Delete a workflow template stage (DELETE /entity-workflow-templates/{workflowTemplateId}/entity-workflow-template-stages/{workflowTemplateStageId})

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    },
    "workflowTemplateStageId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateStageId"
    }
  },
  "required": [
    "workflowTemplateId",
    "workflowTemplateStageId"
  ],
  "additionalProperties": false
}

getget_entity_workflow_templates_by_workflowtemplateid_condition_fields

[EntityWorkflowTemplates] List fields available for stage conditions (GET /entity-workflow-templates/{workflowTemplateId}/condition-fields)

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    }
  },
  "required": [
    "workflowTemplateId"
  ],
  "additionalProperties": false
}

getget_entity_workflow_templates_by_workflowtemplateid_entity_workflow_tem_61ca2a7c

[EntityWorkflowTemplates] List entry conditions for a workflow template stage (GET /entity-workflow-templates/{workflowTemplateId}/entity-workflow-template-stages/{workflowTemplateStageId}/conditions)

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    },
    "workflowTemplateStageId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateStageId"
    }
  },
  "required": [
    "workflowTemplateId",
    "workflowTemplateStageId"
  ],
  "additionalProperties": false
}

postpost_entity_workflow_templates_by_workflowtemplateid_entity_workflow_te_5a61a5a2

[EntityWorkflowTemplates] Add an entry condition to a workflow template stage (POST /entity-workflow-templates/{workflowTemplateId}/entity-workflow-template-stages/{workflowTemplateStageId}/conditions)

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    },
    "workflowTemplateStageId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateStageId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "workflowTemplateId",
    "workflowTemplateStageId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_entity_workflow_templates_by_workflowtemplateid_entity_workflow__50037164

[EntityWorkflowTemplates] Remove an entry condition from a workflow template stage (DELETE /entity-workflow-templates/{workflowTemplateId}/entity-workflow-template-stages/{workflowTemplateStageId}/conditions/{conditionId})

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    },
    "workflowTemplateStageId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateStageId"
    },
    "conditionId": {
      "type": "string",
      "description": "Path parameter: conditionId"
    }
  },
  "required": [
    "workflowTemplateId",
    "workflowTemplateStageId",
    "conditionId"
  ],
  "additionalProperties": false
}

getget_entity_workflow_templates_by_workflowtemplateid_entity_workflow_tem_821af0c1

[EntityWorkflowTemplates] List required approvers for a workflow template stage (GET /entity-workflow-templates/{workflowTemplateId}/entity-workflow-template-stages/{workflowTemplateStageId}/approvers)

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    },
    "workflowTemplateStageId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateStageId"
    }
  },
  "required": [
    "workflowTemplateId",
    "workflowTemplateStageId"
  ],
  "additionalProperties": false
}

postpost_entity_workflow_templates_by_workflowtemplateid_entity_workflow_te_514ff903

[EntityWorkflowTemplates] Require an approver participation type for a workflow template stage (POST /entity-workflow-templates/{workflowTemplateId}/entity-workflow-template-stages/{workflowTemplateStageId}/approvers)

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    },
    "workflowTemplateStageId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateStageId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "workflowTemplateId",
    "workflowTemplateStageId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_entity_workflow_templates_by_workflowtemplateid_entity_workflow__dacb4b9f

[EntityWorkflowTemplates] Remove a required approver from a workflow template stage (DELETE /entity-workflow-templates/{workflowTemplateId}/entity-workflow-template-stages/{workflowTemplateStageId}/approvers/{approverId})

{
  "type": "object",
  "properties": {
    "workflowTemplateId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateId"
    },
    "workflowTemplateStageId": {
      "type": "string",
      "description": "Path parameter: workflowTemplateStageId"
    },
    "approverId": {
      "type": "string",
      "description": "Path parameter: approverId"
    }
  },
  "required": [
    "workflowTemplateId",
    "workflowTemplateStageId",
    "approverId"
  ],
  "additionalProperties": false
}

Facilities

getget_facilities_dashboard_data

[Facilities] Get aggregate dashboard data for facilities operations (GET /facilities/dashboard-data)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "additionalProperties": false
}

Features

getget_products_by_productid_features

[Features] List features for a product (GET /products/{productId}/features)

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "Path parameter: productId"
    }
  },
  "required": [
    "productId"
  ],
  "additionalProperties": false
}

postpost_products_by_productid_features

[Features] Create a feature (POST /products/{productId}/features)

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "Path parameter: productId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "productId",
    "body"
  ],
  "additionalProperties": false
}

postpost_products_by_productid_features_bulk

[Features] Bulk create features (POST /products/{productId}/features/bulk)

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "Path parameter: productId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "productId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_products_by_productid_features_by_featureid

[Features] Update a feature (PATCH /products/{productId}/features/{featureId})

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "Path parameter: productId"
    },
    "featureId": {
      "type": "string",
      "description": "Path parameter: featureId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "productId",
    "featureId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_products_by_productid_features_by_featureid

[Features] Delete a feature (DELETE /products/{productId}/features/{featureId})

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "Path parameter: productId"
    },
    "featureId": {
      "type": "string",
      "description": "Path parameter: featureId"
    }
  },
  "required": [
    "productId",
    "featureId"
  ],
  "additionalProperties": false
}

Forms

getget_forms_by_form_id_responses

[Forms] List responses for a form (GET /forms/{form_id}/responses)

{
  "type": "object",
  "properties": {
    "form_id": {
      "type": "string",
      "description": "Path parameter: form_id"
    }
  },
  "required": [
    "form_id"
  ],
  "additionalProperties": false
}

postpost_forms_by_form_id_responses

[Forms] Submit a response against an internal resource (POST /forms/{form_id}/responses)

{
  "type": "object",
  "properties": {
    "form_id": {
      "type": "string",
      "description": "Path parameter: form_id"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "form_id",
    "body"
  ],
  "additionalProperties": false
}

HousekeepingTasks

getget_housekeeping_tasks_settings_numbering

[HousekeepingTasks] Get the account's housekeeping task numbering settings (GET /housekeeping-tasks/settings/numbering)

{
  "type": "object",
  "properties": {}
}

patchpatch_housekeeping_tasks_settings_numbering

[HousekeepingTasks] Update the account's housekeeping task numbering prefix and/or reset the counter (PATCH /housekeeping-tasks/settings/numbering)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_housekeeping_tasks_by_housekeepingtaskid_stage

[HousekeepingTasks] Move a housekeeping task to a different workflow stage (POST /housekeeping-tasks/{housekeepingTaskId}/stage)

{
  "type": "object",
  "properties": {
    "housekeepingTaskId": {
      "type": "string",
      "description": "Path parameter: housekeepingTaskId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "housekeepingTaskId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_housekeeping_tasks_by_housekeepingtaskid_workflow_stages_by_taskw_e3a0fb83

[HousekeepingTasks] Edit planned dates, estimates, or progress on a specific workflow stage instance (PATCH /housekeeping-tasks/{housekeepingTaskId}/workflow_stages/{taskWorkflowStageId})

{
  "type": "object",
  "properties": {
    "housekeepingTaskId": {
      "type": "string",
      "description": "Path parameter: housekeepingTaskId"
    },
    "taskWorkflowStageId": {
      "type": "string",
      "description": "Path parameter: taskWorkflowStageId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "housekeepingTaskId",
    "taskWorkflowStageId",
    "body"
  ],
  "additionalProperties": false
}

Ideas

postpost_ideas_by_ideaid_vote

[Ideas] Vote on an idea (POST /ideas/{ideaId}/vote)

{
  "type": "object",
  "properties": {
    "ideaId": {
      "type": "string",
      "description": "Path parameter: ideaId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "ideaId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_ideas_by_ideaid_vote

[Ideas] Remove vote from an idea (DELETE /ideas/{ideaId}/vote)

{
  "type": "object",
  "properties": {
    "ideaId": {
      "type": "string",
      "description": "Path parameter: ideaId"
    }
  },
  "required": [
    "ideaId"
  ],
  "additionalProperties": false
}

postpost_ideas_by_ideaid_comments

[Ideas] Add a comment to an idea (POST /ideas/{ideaId}/comments)

{
  "type": "object",
  "properties": {
    "ideaId": {
      "type": "string",
      "description": "Path parameter: ideaId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "ideaId",
    "body"
  ],
  "additionalProperties": false
}

Insights

postpost_insights_about_website

[Insights] Extract product insights from a website URL (POST /insights/about-website)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_insights_get_entities_for_project

[Insights] Get suggested entities for a project (POST /insights/get-entities-for-project)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_insights_get_stages_for_workflow

[Insights] Get suggested stages for a workflow (POST /insights/get-stages-for-workflow)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_insights_extract_tasks

[Insights] Extract tasks from text (POST /insights/extract-tasks)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_insights_document_type

[Insights] Classify the type of a document (POST /insights/document-type)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_insights_extract_tasks_from_document

[Insights] Extract tasks from a document (POST /insights/extract-tasks-from-document)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_insights_extract_feedback_from_document

[Insights] Extract feedback items from a document (POST /insights/extract-feedback-from-document)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_insights_draft_message_from_feedback_followups

[Insights] Draft a follow-up message from feedback items (POST /insights/draft-message-from-feedback-followups)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_insights_product_creation_data_from_website

[Insights] Generate product creation data from a website (POST /insights/product-creation-data-from-website)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

Instagram

getget_instagram_status

[Instagram] Get the account's Instagram connection status (GET /instagram/status)

{
  "type": "object",
  "properties": {}
}

postpost_instagram_connect

[Instagram] Link an Instagram professional account via Facebook Login (POST /instagram/connect)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

deletedelete_instagram_connect

[Instagram] Unlink the account's Instagram account (DELETE /instagram/connect)

{
  "type": "object",
  "properties": {}
}

getget_instagram_messages

[Instagram] Get the Instagram DM timeline for a customer (GET /instagram/messages)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "additionalProperties": false
}

postpost_instagram_messages

[Instagram] Send an Instagram DM to a customer or contact (POST /instagram/messages)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

getget_instagram_webhook

[Instagram] Meta webhook verification handshake (GET /instagram/webhook)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "additionalProperties": false
}

postpost_instagram_webhook

[Instagram] Receive inbound Instagram DMs and delivery/read callbacks (POST /instagram/webhook)

{
  "type": "object",
  "properties": {}
}

Invoices

getget_invoices_settings_numbering

[Invoices] Get the account's invoice numbering settings (GET /invoices/settings/numbering)

{
  "type": "object",
  "properties": {}
}

patchpatch_invoices_settings_numbering

[Invoices] Update the account's invoice numbering prefix and/or reset the counter (PATCH /invoices/settings/numbering)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_invoices_by_invoiceid_send

[Invoices] Mark a draft invoice as sent (POST /invoices/{invoiceId}/send)

{
  "type": "object",
  "properties": {
    "invoiceId": {
      "type": "string",
      "description": "Path parameter: invoiceId"
    }
  },
  "required": [
    "invoiceId"
  ],
  "additionalProperties": false
}

postpost_invoices_by_invoiceid_void

[Invoices] Void an invoice (POST /invoices/{invoiceId}/void)

{
  "type": "object",
  "properties": {
    "invoiceId": {
      "type": "string",
      "description": "Path parameter: invoiceId"
    }
  },
  "required": [
    "invoiceId"
  ],
  "additionalProperties": false
}

postpost_invoices_by_invoiceid_payments

[Invoices] Record a payment against an invoice (POST /invoices/{invoiceId}/payments)

{
  "type": "object",
  "properties": {
    "invoiceId": {
      "type": "string",
      "description": "Path parameter: invoiceId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "invoiceId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_invoices_by_invoiceid_payments_by_paymentid

[Invoices] Remove a payment from an invoice (DELETE /invoices/{invoiceId}/payments/{paymentId})

{
  "type": "object",
  "properties": {
    "invoiceId": {
      "type": "string",
      "description": "Path parameter: invoiceId"
    },
    "paymentId": {
      "type": "string",
      "description": "Path parameter: paymentId"
    }
  },
  "required": [
    "invoiceId",
    "paymentId"
  ],
  "additionalProperties": false
}

getget_invoices_by_invoiceid_pdf

[Invoices] Download an invoice as a PDF (GET /invoices/{invoiceId}/pdf)

{
  "type": "object",
  "properties": {
    "invoiceId": {
      "type": "string",
      "description": "Path parameter: invoiceId"
    }
  },
  "required": [
    "invoiceId"
  ],
  "additionalProperties": false
}

MaintenanceRequests

getget_maintenance_requests_settings_numbering

[MaintenanceRequests] Get the account's maintenance request numbering settings (GET /maintenance-requests/settings/numbering)

{
  "type": "object",
  "properties": {}
}

patchpatch_maintenance_requests_settings_numbering

[MaintenanceRequests] Update the account's maintenance request numbering prefix and/or reset the counter (PATCH /maintenance-requests/settings/numbering)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_maintenance_requests_by_maintenancerequestid_stage

[MaintenanceRequests] Move a maintenance request to a different workflow stage (POST /maintenance-requests/{maintenanceRequestId}/stage)

{
  "type": "object",
  "properties": {
    "maintenanceRequestId": {
      "type": "string",
      "description": "Path parameter: maintenanceRequestId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "maintenanceRequestId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_maintenance_requests_by_maintenancerequestid_workflow_stages_by_t_dcd59ecc

[MaintenanceRequests] Edit planned dates, estimates, or progress on a specific workflow stage instance (PATCH /maintenance-requests/{maintenanceRequestId}/workflow_stages/{taskWorkflowStageId})

{
  "type": "object",
  "properties": {
    "maintenanceRequestId": {
      "type": "string",
      "description": "Path parameter: maintenanceRequestId"
    },
    "taskWorkflowStageId": {
      "type": "string",
      "description": "Path parameter: taskWorkflowStageId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "maintenanceRequestId",
    "taskWorkflowStageId",
    "body"
  ],
  "additionalProperties": false
}

Materials

getget_materials_by_materialid_purchase_units

[Materials] List a material's purchase units (GET /materials/{materialId}/purchase-units)

{
  "type": "object",
  "properties": {
    "materialId": {
      "type": "string",
      "description": "Path parameter: materialId"
    }
  },
  "required": [
    "materialId"
  ],
  "additionalProperties": false
}

postpost_materials_by_materialid_purchase_units

[Materials] Add a purchase unit to a material (POST /materials/{materialId}/purchase-units)

{
  "type": "object",
  "properties": {
    "materialId": {
      "type": "string",
      "description": "Path parameter: materialId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "materialId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_materials_by_materialid_purchase_units_by_purchaseunitid

[Materials] Update a material's purchase unit (PATCH /materials/{materialId}/purchase-units/{purchaseUnitId})

{
  "type": "object",
  "properties": {
    "materialId": {
      "type": "string",
      "description": "Path parameter: materialId"
    },
    "purchaseUnitId": {
      "type": "string",
      "description": "Path parameter: purchaseUnitId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "materialId",
    "purchaseUnitId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_materials_by_materialid_purchase_units_by_purchaseunitid

[Materials] Remove a purchase unit from a material (DELETE /materials/{materialId}/purchase-units/{purchaseUnitId})

{
  "type": "object",
  "properties": {
    "materialId": {
      "type": "string",
      "description": "Path parameter: materialId"
    },
    "purchaseUnitId": {
      "type": "string",
      "description": "Path parameter: purchaseUnitId"
    }
  },
  "required": [
    "materialId",
    "purchaseUnitId"
  ],
  "additionalProperties": false
}

Members

getget_members_by_memberid_notifications

[Members] Get notifications for a member (GET /members/{memberId}/notifications)

{
  "type": "object",
  "properties": {
    "memberId": {
      "type": "string",
      "description": "Path parameter: memberId"
    }
  },
  "required": [
    "memberId"
  ],
  "additionalProperties": false
}

getget_members_by_memberid_notifications_last_updated_at

[Members] Get timestamp of most recent notification update (GET /members/{memberId}/notifications/last-updated-at)

{
  "type": "object",
  "properties": {
    "memberId": {
      "type": "string",
      "description": "Path parameter: memberId"
    }
  },
  "required": [
    "memberId"
  ],
  "additionalProperties": false
}

getget_members_by_memberid_notifications_unread_count

[Members] Get unread notification count (GET /members/{memberId}/notifications/unread-count)

{
  "type": "object",
  "properties": {
    "memberId": {
      "type": "string",
      "description": "Path parameter: memberId"
    }
  },
  "required": [
    "memberId"
  ],
  "additionalProperties": false
}

postpost_members_by_memberid_notifications_mark_as_read

[Members] Mark notifications as read (POST /members/{memberId}/notifications/mark-as-read)

{
  "type": "object",
  "properties": {
    "memberId": {
      "type": "string",
      "description": "Path parameter: memberId"
    }
  },
  "required": [
    "memberId"
  ],
  "additionalProperties": false
}

postpost_members_by_memberid_push_token

[Members] Register a push notification token (POST /members/{memberId}/push-token)

{
  "type": "object",
  "properties": {
    "memberId": {
      "type": "string",
      "description": "Path parameter: memberId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "memberId",
    "body"
  ],
  "additionalProperties": false
}

Objectives

postpost_objectives_by_objectiveid_key_results

[Objectives] Add a key result to an objective (POST /objectives/{objectiveId}/key-results)

{
  "type": "object",
  "properties": {
    "objectiveId": {
      "type": "string",
      "description": "Path parameter: objectiveId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "objectiveId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_objectives_by_objectiveid_key_results_by_keyresultid

[Objectives] Update a key result (PATCH /objectives/{objectiveId}/key-results/{keyResultId})

{
  "type": "object",
  "properties": {
    "objectiveId": {
      "type": "string",
      "description": "Path parameter: objectiveId"
    },
    "keyResultId": {
      "type": "string",
      "description": "Path parameter: keyResultId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "objectiveId",
    "keyResultId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_objectives_by_objectiveid_key_results_by_keyresultid

[Objectives] Delete a key result (DELETE /objectives/{objectiveId}/key-results/{keyResultId})

{
  "type": "object",
  "properties": {
    "objectiveId": {
      "type": "string",
      "description": "Path parameter: objectiveId"
    },
    "keyResultId": {
      "type": "string",
      "description": "Path parameter: keyResultId"
    }
  },
  "required": [
    "objectiveId",
    "keyResultId"
  ],
  "additionalProperties": false
}

Onboarding

postpost_accounts_by_accountid_onboarding_complete

[Onboarding] Mark onboarding as complete (POST /accounts/{accountId}/onboarding/complete)

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "Path parameter: accountId"
    }
  },
  "required": [
    "accountId"
  ],
  "additionalProperties": false
}

postpost_accounts_by_accountid_onboarding_skip

[Onboarding] Skip onboarding (POST /accounts/{accountId}/onboarding/skip)

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "Path parameter: accountId"
    }
  },
  "required": [
    "accountId"
  ],
  "additionalProperties": false
}

Projects

getget_projects_by_projectid_deletable

[Projects] Check whether a project can be hard deleted (GET /projects/{projectId}/deletable)

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string",
      "description": "Path parameter: projectId"
    }
  },
  "required": [
    "projectId"
  ],
  "additionalProperties": false
}

getget_projects_by_projectid_dashboard_data

[Projects] Get dashboard data for a project (GET /projects/{projectId}/dashboard-data)

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string",
      "description": "Path parameter: projectId"
    }
  },
  "required": [
    "projectId"
  ],
  "additionalProperties": false
}

getget_projects_by_projectid_permissions

[Projects] Get permissions for a project (GET /projects/{projectId}/permissions)

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string",
      "description": "Path parameter: projectId"
    }
  },
  "required": [
    "projectId"
  ],
  "additionalProperties": false
}

patchpatch_projects_by_projectid_current_cycle

[Projects] Set (or clear) the project's current phase, release, or sprint (PATCH /projects/{projectId}/current-cycle)

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string",
      "description": "Path parameter: projectId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "projectId",
    "body"
  ],
  "additionalProperties": false
}

Public

getget_public_forms_by_form_id

[Public] Get a published form (no auth required) (GET /public/forms/{form_id})

{
  "type": "object",
  "properties": {
    "form_id": {
      "type": "string",
      "description": "Path parameter: form_id"
    }
  },
  "required": [
    "form_id"
  ],
  "additionalProperties": false
}

postpost_public_forms_by_form_id_responses

[Public] Submit a response to a form (no auth required) (POST /public/forms/{form_id}/responses)

{
  "type": "object",
  "properties": {
    "form_id": {
      "type": "string",
      "description": "Path parameter: form_id"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "form_id",
    "body"
  ],
  "additionalProperties": false
}

PurchaseOrders

getget_purchase_orders_settings_numbering

[PurchaseOrders] Get the account's purchase order numbering settings (GET /purchase-orders/settings/numbering)

{
  "type": "object",
  "properties": {}
}

patchpatch_purchase_orders_settings_numbering

[PurchaseOrders] Update the account's purchase order numbering prefix and/or reset the counter (PATCH /purchase-orders/settings/numbering)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_purchase_orders_by_purchaseorderid_stage

[PurchaseOrders] Move a purchase order to a different workflow stage (POST /purchase-orders/{purchaseOrderId}/stage)

{
  "type": "object",
  "properties": {
    "purchaseOrderId": {
      "type": "string",
      "description": "Path parameter: purchaseOrderId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "purchaseOrderId",
    "body"
  ],
  "additionalProperties": false
}

PurchaseRequisitions

getget_purchase_requisitions_settings_numbering

[PurchaseRequisitions] Get the account's purchase requisition numbering settings (GET /purchase-requisitions/settings/numbering)

{
  "type": "object",
  "properties": {}
}

patchpatch_purchase_requisitions_settings_numbering

[PurchaseRequisitions] Update the account's purchase requisition numbering prefix and/or reset the counter (PATCH /purchase-requisitions/settings/numbering)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_purchase_requisitions_by_purchaserequisitionid_stage

[PurchaseRequisitions] Move a purchase requisition to a different workflow stage (POST /purchase-requisitions/{purchaseRequisitionId}/stage)

{
  "type": "object",
  "properties": {
    "purchaseRequisitionId": {
      "type": "string",
      "description": "Path parameter: purchaseRequisitionId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "purchaseRequisitionId",
    "body"
  ],
  "additionalProperties": false
}

RoadmapItems

getget_products_by_productid_roadmap_items

[RoadmapItems] List roadmap items for a product (GET /products/{productId}/roadmap-items)

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "Path parameter: productId"
    }
  },
  "required": [
    "productId"
  ],
  "additionalProperties": false
}

postpost_products_by_productid_roadmap_items

[RoadmapItems] Create a roadmap item (POST /products/{productId}/roadmap-items)

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "Path parameter: productId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "productId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_products_by_productid_roadmap_items_by_roadmapitemid

[RoadmapItems] Update a roadmap item (PATCH /products/{productId}/roadmap-items/{roadmapItemId})

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "Path parameter: productId"
    },
    "roadmapItemId": {
      "type": "string",
      "description": "Path parameter: roadmapItemId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "productId",
    "roadmapItemId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_products_by_productid_roadmap_items_by_roadmapitemid

[RoadmapItems] Delete a roadmap item (DELETE /products/{productId}/roadmap-items/{roadmapItemId})

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "Path parameter: productId"
    },
    "roadmapItemId": {
      "type": "string",
      "description": "Path parameter: roadmapItemId"
    }
  },
  "required": [
    "productId",
    "roadmapItemId"
  ],
  "additionalProperties": false
}

Slack

postpost_slack_command_tasklet

[Slack] Handle a Slack slash command for tasklets (POST /slack/command/tasklet)

{
  "type": "object",
  "properties": {}
}

postpost_slack_interactions

[Slack] Handle Slack interactive component payloads (POST /slack/interactions)

{
  "type": "object",
  "properties": {}
}

postpost_slack_events

[Slack] Handle Slack event API payloads (POST /slack/events)

{
  "type": "object",
  "properties": {}
}

StockTransactions

getget_stock_transactions_current_stock

[StockTransactions] Get current stock, aggregated by material and location (GET /stock-transactions/current-stock)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "additionalProperties": false
}

Tasklets

getget_tasklets_last_updated_time

[Tasklets] Get the last updated time for tasklets (GET /tasklets/last-updated-time)

{
  "type": "object",
  "properties": {}
}

getget_tasklets_by_id_comments

[Tasklets] List comments on a tasklet (GET /tasklets/{id}/comments)

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Path parameter: id"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

postpost_tasklets_by_id_comments

[Tasklets] Add a comment to a tasklet (POST /tasklets/{id}/comments)

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Path parameter: id"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "id",
    "body"
  ],
  "additionalProperties": false
}

Tasks

postpost_tasks_bulk

[Tasks] Bulk create tasks (POST /tasks/bulk)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

patchpatch_tasks_bulk

[Tasks] Bulk update tasks (PATCH /tasks/bulk)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

postpost_tasks_bulk_workflow_stages

[Tasks] Bulk update the workflow stage of tasks (POST /tasks/bulk/workflow_stages)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

getget_tasks_by_taskid_comments

[Tasks] List comments on a task (GET /tasks/{taskId}/comments)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    }
  },
  "required": [
    "taskId"
  ],
  "additionalProperties": false
}

postpost_tasks_by_taskid_comments

[Tasks] Add a comment to a task (POST /tasks/{taskId}/comments)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "taskId",
    "body"
  ],
  "additionalProperties": false
}

postpost_tasks_by_taskid_labels

[Tasks] Add labels to a task (POST /tasks/{taskId}/labels)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "taskId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_tasks_by_taskid_labels_by_labelid

[Tasks] Remove a label from a task (DELETE /tasks/{taskId}/labels/{labelId})

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "labelId": {
      "type": "string",
      "description": "Path parameter: labelId"
    }
  },
  "required": [
    "taskId",
    "labelId"
  ],
  "additionalProperties": false
}

postpost_tasks_by_taskid_workflow_stages

[Tasks] Update the workflow stage of a task (POST /tasks/{taskId}/workflow_stages)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "taskId",
    "body"
  ],
  "additionalProperties": false
}

getget_tasks_by_taskid_workflow_stages_by_stageid_approvals

[Tasks] Get approval status for a task's stage (GET /tasks/{taskId}/workflow_stages/{stageId}/approvals)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "stageId": {
      "type": "string",
      "description": "Path parameter: stageId"
    }
  },
  "required": [
    "taskId",
    "stageId"
  ],
  "additionalProperties": false
}

postpost_tasks_by_taskid_workflow_stages_by_stageid_approvals

[Tasks] Approve a task's entry into a stage (POST /tasks/{taskId}/workflow_stages/{stageId}/approvals)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "stageId": {
      "type": "string",
      "description": "Path parameter: stageId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "taskId",
    "stageId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_tasks_by_taskid_workflow_stages_by_stageid_approvals_by_approvalid

[Tasks] Revoke a stage approval (DELETE /tasks/{taskId}/workflow_stages/{stageId}/approvals/{approvalId})

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "stageId": {
      "type": "string",
      "description": "Path parameter: stageId"
    },
    "approvalId": {
      "type": "string",
      "description": "Path parameter: approvalId"
    }
  },
  "required": [
    "taskId",
    "stageId",
    "approvalId"
  ],
  "additionalProperties": false
}

getget_tasks_by_taskid_workflow_stages_by_stageid_eligibility

[Tasks] Check whether a task is eligible to move into a stage (GET /tasks/{taskId}/workflow_stages/{stageId}/eligibility)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "stageId": {
      "type": "string",
      "description": "Path parameter: stageId"
    }
  },
  "required": [
    "taskId",
    "stageId"
  ],
  "additionalProperties": false
}

getget_tasks_by_taskid_activity_logs

[Tasks] Get activity logs for a task (GET /tasks/{taskId}/activity-logs)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    }
  },
  "required": [
    "taskId"
  ],
  "additionalProperties": false
}

getget_tasks_by_taskid_last_activity_time

[Tasks] Get last activity time for a task (GET /tasks/{taskId}/last-activity-time)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    }
  },
  "required": [
    "taskId"
  ],
  "additionalProperties": false
}

getget_tasks_by_taskid_participants

[Tasks] List participants of a task (GET /tasks/{taskId}/participants)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    }
  },
  "required": [
    "taskId"
  ],
  "additionalProperties": false
}

postpost_tasks_by_taskid_participants

[Tasks] Add a participant to a task (POST /tasks/{taskId}/participants)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "taskId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_tasks_by_taskid_participants_by_participantid

[Tasks] Remove a participant from a task (DELETE /tasks/{taskId}/participants/{participantId})

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "participantId": {
      "type": "string",
      "description": "Path parameter: participantId"
    }
  },
  "required": [
    "taskId",
    "participantId"
  ],
  "additionalProperties": false
}

postpost_tasks_by_taskid_links

[Tasks] Link this task to another task (POST /tasks/{taskId}/links)

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Path parameter: taskId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "taskId",
    "body"
  ],
  "additionalProperties": false
}

Users

getget_users_me

[Users] Get the currently authenticated user (GET /users/me)

{
  "type": "object",
  "properties": {}
}

Vendors

getget_vendors_by_vendorid_contacts

[Vendors] List contacts for a vendor (GET /vendors/{vendorId}/contacts)

{
  "type": "object",
  "properties": {
    "vendorId": {
      "type": "string",
      "description": "Path parameter: vendorId"
    }
  },
  "required": [
    "vendorId"
  ],
  "additionalProperties": false
}

postpost_vendors_by_vendorid_contacts

[Vendors] Add a contact to a vendor (POST /vendors/{vendorId}/contacts)

{
  "type": "object",
  "properties": {
    "vendorId": {
      "type": "string",
      "description": "Path parameter: vendorId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "vendorId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_vendors_by_vendorid_contacts_by_vendorcontactid

[Vendors] Update a vendor contact (PATCH /vendors/{vendorId}/contacts/{vendorContactId})

{
  "type": "object",
  "properties": {
    "vendorId": {
      "type": "string",
      "description": "Path parameter: vendorId"
    },
    "vendorContactId": {
      "type": "string",
      "description": "Path parameter: vendorContactId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "vendorId",
    "vendorContactId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_vendors_by_vendorid_contacts_by_vendorcontactid

[Vendors] Remove a vendor contact (DELETE /vendors/{vendorId}/contacts/{vendorContactId})

{
  "type": "object",
  "properties": {
    "vendorId": {
      "type": "string",
      "description": "Path parameter: vendorId"
    },
    "vendorContactId": {
      "type": "string",
      "description": "Path parameter: vendorContactId"
    }
  },
  "required": [
    "vendorId",
    "vendorContactId"
  ],
  "additionalProperties": false
}

getget_vendors_by_vendorid_material_history

[Vendors] List materials purchased from a vendor (GET /vendors/{vendorId}/material-history)

{
  "type": "object",
  "properties": {
    "vendorId": {
      "type": "string",
      "description": "Path parameter: vendorId"
    },
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "required": [
    "vendorId"
  ],
  "additionalProperties": false
}

Versions

getget_versions_app_client

[Versions] Get the current app client version (GET /versions/app-client)

{
  "type": "object",
  "properties": {}
}

Webhooks

postpost_webhooks_razorpay

[Webhooks] Razorpay payment webhook (POST /webhooks/razorpay)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

Whatsapp

getget_whatsapp_status

[Whatsapp] Get the account's WhatsApp connection status (GET /whatsapp/status)

{
  "type": "object",
  "properties": {}
}

postpost_whatsapp_connect

[Whatsapp] Link a WhatsApp Business Account via Embedded Signup (POST /whatsapp/connect)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

deletedelete_whatsapp_connect

[Whatsapp] Unlink the account's WhatsApp Business Account (DELETE /whatsapp/connect)

{
  "type": "object",
  "properties": {}
}

getget_whatsapp_messages

[Whatsapp] Get the WhatsApp message timeline for a customer (GET /whatsapp/messages)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "additionalProperties": false
}

postpost_whatsapp_messages

[Whatsapp] Send a WhatsApp message to a customer or contact (POST /whatsapp/messages)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

getget_whatsapp_templates

[Whatsapp] List the account's approved WhatsApp message templates (GET /whatsapp/templates)

{
  "type": "object",
  "properties": {}
}

postpost_whatsapp_templates

[Whatsapp] Create a new WhatsApp message template (POST /whatsapp/templates)

{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "body"
  ],
  "additionalProperties": false
}

getget_whatsapp_webhook

[Whatsapp] Meta webhook verification handshake (GET /whatsapp/webhook)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "additionalProperties": false
}

postpost_whatsapp_webhook

[Whatsapp] Receive inbound WhatsApp messages and delivery status callbacks (POST /whatsapp/webhook)

{
  "type": "object",
  "properties": {}
}

Workstreams

getget_workstreams_by_workstreamid_activity_logs

[Workstreams] Get activity logs for a workstream (GET /workstreams/{workstreamId}/activity-logs)

{
  "type": "object",
  "properties": {
    "workstreamId": {
      "type": "string",
      "description": "Path parameter: workstreamId"
    }
  },
  "required": [
    "workstreamId"
  ],
  "additionalProperties": false
}

getget_workstreams_by_workstreamid_activity_snapshot_since

[Workstreams] Get activity snapshot since a given time (GET /workstreams/{workstreamId}/activity-snapshot-since)

{
  "type": "object",
  "properties": {
    "workstreamId": {
      "type": "string",
      "description": "Path parameter: workstreamId"
    },
    "query": {
      "type": "object",
      "additionalProperties": {},
      "description": "Query-string parameters"
    }
  },
  "required": [
    "workstreamId"
  ],
  "additionalProperties": false
}

getget_workstreams_by_workstreamid_participation_types

[Workstreams] List participation types for a workstream (GET /workstreams/{workstreamId}/participation_types)

{
  "type": "object",
  "properties": {
    "workstreamId": {
      "type": "string",
      "description": "Path parameter: workstreamId"
    }
  },
  "required": [
    "workstreamId"
  ],
  "additionalProperties": false
}

postpost_workstreams_by_workstreamid_participation_types

[Workstreams] Add a participation type to a workstream (POST /workstreams/{workstreamId}/participation_types)

{
  "type": "object",
  "properties": {
    "workstreamId": {
      "type": "string",
      "description": "Path parameter: workstreamId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "workstreamId",
    "body"
  ],
  "additionalProperties": false
}

patchpatch_workstreams_by_workstreamid_participation_types_by_typeid

[Workstreams] Update a participation type (PATCH /workstreams/{workstreamId}/participation_types/{typeId})

{
  "type": "object",
  "properties": {
    "workstreamId": {
      "type": "string",
      "description": "Path parameter: workstreamId"
    },
    "typeId": {
      "type": "string",
      "description": "Path parameter: typeId"
    },
    "body": {
      "type": "object",
      "additionalProperties": {},
      "description": "Request body"
    }
  },
  "required": [
    "workstreamId",
    "typeId",
    "body"
  ],
  "additionalProperties": false
}

deletedelete_workstreams_by_workstreamid_participation_types_by_typeid

[Workstreams] Delete a participation type (DELETE /workstreams/{workstreamId}/participation_types/{typeId})

{
  "type": "object",
  "properties": {
    "workstreamId": {
      "type": "string",
      "description": "Path parameter: workstreamId"
    },
    "typeId": {
      "type": "string",
      "description": "Path parameter: typeId"
    }
  },
  "required": [
    "workstreamId",
    "typeId"
  ],
  "additionalProperties": false
}