Terrains

List terrains

GET
/orgs/{organizationId}/terrains

Lists terrains with pagination, filtering, sorting, and includes. Supports virtual fields: customer and occupation. Supports direct relations: meters, occupations, reservations, comments.

Authorization

ApiKeyAuth
headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

Query Parameters

page?integer
Range-9007199254740991 <= value <= 9007199254740991
limit?integer
Range-9007199254740991 <= value <= 9007199254740991
sortBy?string
Value in"id""name""description""bookable""createdAt""updatedAt""geoJson""surfaceArea""metadata""terrainTypeId"
sortDir?string
Value in"asc""desc"
include?|array<>|string
terrainTypeId?string|array<string>|null
bookable?boolean|string|number|null
surfaceArea?number||
createdAt?|null
updatedAt?|null
name?string|array<string>|
description?string|array<string>|
geoJson?
metadata?
hasReservations?boolean|string|number|null
hasNoReservations?boolean|string|number|null
hasMeters?boolean|string|number|null
hasNoMeters?boolean|string|number|null
hasMeterCabinets?boolean|string|number|null
hasNoMeterCabinets?boolean|string|number|null
hasOccupations?boolean|string|number|null
hasNoOccupations?boolean|string|number|null
hasComments?boolean|string|number|null
hasNoComments?boolean|string|number|null
hasTasks?boolean|string|number|null
hasNoTasks?boolean|string|number|null
hasEventLogs?boolean|string|number|null
hasNoEventLogs?boolean|string|number|null
hasAuditLogs?boolean|string|number|null
hasNoAuditLogs?boolean|string|number|null
reservationId?string|array<string>|
meterId?string|array<string>|
meterCabinetId?string|array<string>|
occupationId?string|array<string>|
commentId?string|array<string>|
taskId?string|array<string>|
eventLogId?string|array<string>|
auditLogId?string|array<string>|
hasTerrainType?boolean|string|number|null
hasNoTerrainType?boolean|string|number|null
search?string

Response Body

OK

application/json
  1. response
curl -X GET 'https://api.tillor.eu/orgs/string/terrains'
null