Maxxton External API

Sections

Get location details

Query Parameters

endDatestring

Date to filter records based on end date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

locationIdsarray

List of locationIds to fetch the details

returnSectionsarray

List of constant strings to return only the selected sections in the response. The possible values are AMENITYCATEGORYSETS, DYNAMICFIELDS, IMAGES, MAILADDRESS, LOCATIONMAP, SUBJECTS, VIDEOS, VISITADDRESS, TRANSLATIONS. For example, returnSections=IMAGES,DYNAMICFIELDS will only return images and dynamicfields sections in the response. This is recommended to use to reduce the size of the response body and improve the performance of the call.

Enum values:
AMENITYCATEGORYSETSDYNAMICFIELDSIMAGESMAILADDRESSLOCATIONMAPSUBJECTSVIDEOSVISITADDRESSTRANSLATIONS
Allow unique items
true
startDatestring

Date to filter records based on start date. Date should be added using ISO 8601 standard(yyyy-MM-dd).

pageinteger

Page number

sizeinteger

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
locationPriority:0,
locationNumber:0,
internalLocationNumber:String,
code:String,
locationId:0,
parentId:0,
archivedFrom:2026-04-02,
adminOrganisationId:0,
origin:String,
originId:String,
bookableLocation:true,
previousPmsId:String,
minAgeForBooking:0For more information, check: Filtering

Response

200
Object
The request is completed successfully without any errors

Response Attributes

totalElementsinteger

Total number of elements available in the whole response.

totalPagesinteger

Total number of pages the response has.

sizeinteger

Size of the current page.

contentarray

Show child attributes

numberinteger

Page number currently accessed.

sortobject

Show child attributes

firstboolean

Boolean field to specify if its the first page or not.

lastboolean

Boolean field to specify if its the last page or not.

numberOfElementsinteger

Total number of elements in the current page.

emptyboolean
500
Object
Error occurred while fetching locations.

GET

/

Select
1

Response