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
| 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 |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"businessUnitIds": {
"description": "Filters by business unit IDs",
"type": [
"string",
"null"
]
},
"createdBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)"
},
"createdOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)"
},
"customerIds": {
"description": "Filters by customer IDs",
"type": [
"string",
"null"
]
},
"ids": {
"description": "Perform lookup by multiple IDs (maximum 50)",
"type": [
"string",
"null"
]
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": [
"boolean",
"null"
]
},
"modifiedBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)"
},
"modifiedOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)"
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. The logical number of page to return, starting from 1"
},
"pageSize": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. How many records to return (50 by default)"
},
"sort": {
"description": "Applies sorting by the specified field:\n\"?sort=+FieldName\" for ascending order,\n\"?sort=-FieldName\" for descending order.\n\nAvailable fields are: Id, Name, CreatedOn, ModifiedOn, StartDate, EndDate",
"type": [
"string",
"null"
]
},
"status": {
"description": "Filters by service agreement status\nValues: [Draft, Sent, Rejected, Accepted, Activated, Canceled, Expired, AutoRenew]",
"type": [
"string",
"null"
]
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}