> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Get service tickets filtered and paged > Get a paged list of existing service tickets, optionally filtered to the given parameters. ## OpenAPI ````json POST /api/v1/maintenance/servicetickets/filter { "openapi": "3.0.4", "info": { "title": "Maintenance V1", "description": "# Maintenance API Documentation\nWelcome to BETA version of the new Maintenance API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.\n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## Operations \n\nThe API supports operations for the following: \n\n- **Service Tickets**\n\nFor each type, you can: \n\n- **GET**: Retrieve a list or apply filters.", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Metadata" }, { "name": "ServiceTickets" } ], "paths": { "/api/v1/maintenance/servicetickets/filter": { "post": { "tags": [ "ServiceTickets" ], "summary": "Get service tickets filtered and paged", "description": "Get a paged list of existing service tickets, optionally filtered to the given parameters.", "operationId": "GetServiceTicketsFilteredPaged", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTicketSearchRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTicketSearchResult" } } } } }, "x-d360-narrative-url": "

Get service tickets filtered and paged (POST)

This endpoint returns a paged list of existing service tickets, optionally filtered by the given parameters, with sorting support.

Integrators use it to display multiple tickets at once, for example all tickets currently in an \"Active\" state with \"High\" priority in a connected app.

Request Fields

Field

Type

Required

Description

paging.pageSize

integer

No

Maximum number of tickets to return per page. Defaults to 100 when not given. Minimum 1, maximum 1000.

paging.pageNumber

integer

No

Page number to retrieve. Defaults to 1 when not given. Minimum 1, maximum 9999.

sorting.columnName

string

No

Field the results are sorted on, for example stateName.

sorting.order

integer

No

Sort direction for columnName. Valid values are 0 (Ascending) or 1 (Descending).

filter.reference

string

No

Filters results on the internal identifier of the ticket.

filter.externalIdentifier

string

No

Filters results on the external identifier of the ticket.

filter.reportingDate.from

string (date-time)

No

Earliest reportingDate to include in the selection. ISO 8601 format.

filter.reportingDate.to

string (date-time)

No

Latest reportingDate to include in the selection. ISO 8601 format.

filter.stateName

string

No

Filters results on the ticket's state name, for example Active.

filter.priority

integer

No

Filters results on priority. Valid values are 1 (Low), 2 (Normal), or 3 (High).

filter.problemCategoryName

string

No

Filters results on the problem category name.

filter.realEstateObjectReference

string

No

Filters results on the reference of the real estate object the ticket applies to.

filter.reporterReference

string

No

Filters results on the reference of the relation to contact regarding the ticket.

filter.tenantReference

string

No

Filters results on the tenant reference. This is automatically populated based on the tenant registered on the property at the time the ticket was submitted; it is not a field set directly when creating or updating a ticket.

filter.supplierReference

string

No

Filters results on the reference of the supplier handling the ticket.

Response Fields

Field

Type

Required

Description

paging.pageSize

integer

No

Page size used for this result set. Minimum 1, maximum 1000.

paging.pageNumber

integer

No

Page number returned in this result set. Minimum 1, maximum 9999.

sorting.columnName

string

No

Field the results are sorted on.

sorting.order

integer

No

Sort direction for columnName. 0 is Ascending, 1 is Descending.

serviceTickets

array of object

No

The list of tickets matching the filter, for the requested page. Empty or omitted when no tickets match.

serviceTickets.reference

string

No

Internal identifier of the ticket.

serviceTickets.externalIdentifier

string

No

External identifier of the ticket, as set by the integrating system.

serviceTickets.reportingDate

string (date-time)

Yes

Date and time the ticket was created.

serviceTickets.stateName

string

No

Name of the ticket's current state.

serviceTickets.priority

integer

Yes

Priority of the report. Valid values are 1 (Low), 2 (Normal), or 3 (High).

serviceTickets.problemCategoryName

string

No

Problem category the ticket belongs to.

serviceTickets.realEstateObjectReference

string

No

Reference of the real estate object the ticket applies to.

serviceTickets.reporterReference

string

No

Reference of the relation to contact regarding the ticket.

serviceTickets.tenantReference

string

No

Tenant reference, automatically populated based on the tenant registered on the property at the time the ticket was submitted.

serviceTickets.supplierReference

string

No

Reference of the supplier handling the ticket.

" } } }, "components": { "schemas": { "ServiceTicketSearchRequest": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingInfo" }, "sorting": { "$ref": "#/components/schemas/SortingInfo" }, "filter": { "$ref": "#/components/schemas/ServiceTicketSearchRequestFilter" } }, "additionalProperties": false }, "ServiceTicketSearchResult": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingInfo" }, "sorting": { "$ref": "#/components/schemas/SortingInfo" }, "serviceTickets": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTicketSearchResultFilter" }, "nullable": true } }, "additionalProperties": false }, "PagingInfo": { "type": "object", "properties": { "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "pageNumber": { "maximum": 9999, "minimum": 1, "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SortingInfo": { "type": "object", "properties": { "columnName": { "type": "string", "nullable": true }, "order": { "type": "integer", "description": "Ascending = 0\nDescending = 1", "format": "int32", "x-enumNames": [ "Ascending", "Descending" ] } }, "additionalProperties": false }, "ServiceTicketSearchRequestFilter": { "type": "object", "properties": { "reference": { "type": "string", "nullable": true }, "externalIdentifier": { "type": "string", "nullable": true }, "reportingDate": { "$ref": "#/components/schemas/CompareFilterModelDateTime" }, "stateName": { "type": "string", "nullable": true }, "priority": { "type": "integer", "description": "Low = 1\nNormal = 2\nHigh = 3", "format": "int32", "nullable": true, "x-enumNames": [ "Low", "Normal", "High" ] }, "problemCategoryName": { "type": "string", "nullable": true }, "realEstateObjectReference": { "type": "string", "nullable": true }, "reporterReference": { "type": "string", "nullable": true }, "tenantReference": { "type": "string", "nullable": true }, "supplierReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceTicketSearchResultFilter": { "type": "object", "properties": { "reference": { "type": "string", "nullable": true }, "externalIdentifier": { "type": "string", "nullable": true }, "reportingDate": { "type": "string", "format": "date-time" }, "stateName": { "type": "string", "nullable": true }, "priority": { "type": "integer", "description": "Low = 1\nNormal = 2\nHigh = 3", "format": "int32", "x-enumNames": [ "Low", "Normal", "High" ] }, "problemCategoryName": { "type": "string", "nullable": true }, "realEstateObjectReference": { "type": "string", "nullable": true }, "reporterReference": { "type": "string", "nullable": true }, "tenantReference": { "type": "string", "nullable": true }, "supplierReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CompareFilterModelDateTime": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time", "nullable": true }, "to": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false } } } } ````