/commitments

Returns a paginated list of recurring commitments matching the specified filter criteria. At least one filter parameter is recommended; omitting all parameters returns all commitments accessible in the current context.

A contact with no recurring commitments returns 200 OK with an empty items array and count of 0. Multiple comma-separated values are accepted for all ID filter parameters, and results from all matched IDs are returned in a single response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

Filter to commitments for the specified contact(s). Accepts multiple comma-separated VAN IDs.

int32

Filter by commitment status. Accepts multiple comma-separated values.

int32

Filter by recurrence frequency. Accepts multiple comma-separated values.

int32

Filter by designation. Accepts multiple comma-separated values.

int32

Maximum number of records to return per page. Defaults to 50.

int32

Number of records to skip. Used for pagination in combination with $top.

Responses
200
400

Bad Request

403

Forbidden

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!