List facilities

Returns a page of facilities.

Request
query Parameters
name
string

If set, the items will be filtered on facilities with the specified name.

deactivated
boolean

If set, the items will be filtered on facilities with the specified deactivated status.

parentFacilityId
string <uuid>
sortedBy
string

The property by which the returned data will be sorted.

Enum: "Id" "Name"
object

If set, the properties and directions the returned data will be sorted by.

offset
integer <int32>
Deprecated

The offset for the page to start.

cursor
string

The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically.

count
integer <int32>

The number of items to include in a single page.

sortDirection
string

The direction the returned data will be sorted by.

Enum: "Asc" "Desc"
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/facilities
Response samples
application/json
{
  • "previousCursor": "string",
  • "nextCursor": "string",
  • "nextOffset": 0,
  • "pageSize": 0,
  • "count": 0,
  • "totalCount": 0,
  • "items": [
    ],
  • "sortedBy": "Id",
  • "sortDirection": "Asc",
  • "sort": {
    }
}