ServiceAgreements_GetList
Retrieve a list of service agreements by filtering tenant ID, customer IDs, business unit IDs, status, created/modified dates, pagination, and sorting options for efficient data management.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| businessUnitIds | No | Filters by business unit IDs | |
| createdBefore | No | Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC) | |
| createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC) | |
| customerIds | No | Filters by customer IDs | |
| ids | No | Perform lookup by multiple IDs (maximum 50) | |
| includeTotal | No | Whether total count should be returned | |
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC) | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC) | |
| page | No | Format - int32. The logical number of page to return, starting from 1 | |
| pageSize | No | Format - int32. How many records to return (50 by default) | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, Name, CreatedOn, ModifiedOn, StartDate, EndDate | |
| status | No | Filters by service agreement status Values: [Draft, Sent, Rejected, Accepted, Activated, Canceled, Expired, AutoRenew] | |
| tenant | Yes | Format - int64. Tenant ID |