Shape your requests
Learn how arguments, pagination, filtering, field selection, responses, and errors work with the Contacts+ API on MindCloud.
Once your first Contacts+ 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 Contacts+ yet, start with Connect to Contacts+.
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 Contacts+ 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 Contacts+ 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.
| Piece | Where it goes |
|---|---|
| Action fields | Query parameters for GET and DELETE; JSON body fields for POST, PUT, and PATCH. |
connectionId | Query string for reads and deletes; body for creates and updates. |
limit, offset, where, sort, fields | Universal API controls; always query parameters, never body fields. |
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 Contacts+ 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.