Docs

Shape your requests

Learn how arguments, pagination, filtering, field selection, responses, and errors work with the ClickUp API on MindCloud.

Once your first ClickUp request works, use this page to shape real production requests. MindCloud keeps the app-specific API details behind one REST format, so you can control arguments, pagination, filtering, fields, and errors without learning a separate convention for every provider. If you have not connected ClickUp yet, start with Connect to ClickUp.

Arguments

Arguments are the inputs an action needs. Pass them as flat fields beside the Universal API fields: query parameters for read and delete actions, JSON body fields for create and update actions. Each ClickUp action page documents its exact argument keys, types, and which ones are required. Keys are case-sensitive, and requests with missing or invalid required arguments fail instead of guessing.

Request format

The REST format is intentionally plain. Choose a ClickUp action, call its Universal API URL, authenticate with your MindCloud API Key, and include the connection and action fields in the correct lane for the HTTP method.

PieceWhere it goes
Action fieldsQuery parameters for GET and DELETE; JSON body fields for POST, PUT, and PATCH.
connectionIdQuery string for reads and deletes; body for creates and updates.
limit, offset, where, sort, fieldsUniversal API controls; always query parameters, never body fields.

Filtering

Filterable list actions accept a where query parameter written as an RSQL expression. MindCloud translates it into the filtering shape ClickUp supports, and the filterable fields are listed on each action page.

OperatorMeaningExample
== / !=Equals / does not equalstatus==active
> >= < <=ComparisonscreatedAt>=2026-01-01
=like=Contains text, with * wildcardsname=like=*dan*

Combine conditions with ; for AND and , for OR: status==active;createdAt>=2026-01-01.

These ClickUp actions support filtering:

Sorting

Sortable list actions accept a sort query parameter: a comma-separated list of fields, with a - prefix for descending order, such as sort=-createdAt,name. MindCloud maps it into the sorting format ClickUp supports, and the sortable fields are listed on each action page.

These ClickUp actions support sorting:

Field selection

Use the fields query parameter to return only the response fields your code reads, with dot notation for nested objects: fields=id,name,profile.email. Selection is applied to each row in data after the response is mapped, and id is kept whenever it exists so rows stay identifiable.

Responses and errors

Every ClickUp response is mapped into the same public envelope before it reaches your code: success, your rows in a data array (single-row actions return an array with one item), and optional meta. Failed requests return success: false with a stable code to branch on and a human-readable message:

{
  "success": false,
  "code": "CONNECTION_APP_MISMATCH",
  "message": "Connection \"conn_123\" is not configured for this app."
}

Check the HTTP status first: 401 or 403 for authentication and authorization, 400 for invalid request shape, and 5xx when MindCloud cannot complete the action upstream. Most failures come from a missing API Key, a missing or mismatched connection, or arguments that do not match the action page.