NGngpvan

/commitments

Changed on

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.<br/><br/>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.

get/commitments

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/commitments
  • Auth
    HTTP basic

Query parameters

vanIdinteger

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

statusIdinteger

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

frequencyIdinteger

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

designationIdinteger

Filter by designation. Accepts multiple comma-separated values.

$topinteger

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

$skipinteger

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

Changes