commitments

List commitments

get/v3/commitments

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/commitments
  • Auth: API key in header Authorization

Query parameters

pagenumber double

Page Number

limitnumber double

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: customerId (uuid): eq, neq, in, nin, isnull, isnotnull contractId (uuid): eq, neq, in, nin, isnull, isnotnull

Example: filter=customerId:eq:00000000-0000-0000-0000-000000000001

Response

Get all commitments with optional customer and contract filtering

payloadV3CommitmentsGetResponsesContentApplicationJsonSchemaPayload required

Response payload, will be empty when success is false

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

No recorded changes to this operation across all 1 revision of this API.