Endpoints related to property (school/district) operations
Get All Properties
Retrieves a list of all properties (schools) that the API user has access to. District offices (parent locations) will be returned at position 0 in the array, followed by each school campus (child location) within the district. Each district office contains a Properties array listing the IDs of all school properties in that district.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Properties retrieved successfully
messagestring · requiredResponse message
message_codestring · requiredResponse message code
invocation_idstring · uuid · requiredRequest ID
propertiesobject[] · requiredList of all properties (e.g., schools) that the API user has access to
Get Property by ID
Retrieves detailed information about a specific property (e.g. school) based on the provided property ID. The parent (e.g. district) location will be identified by nested properties array.
path Parameters
property_idstring · ObjectId · requiredThe unique identifier (_id) of the property
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Property retrieved successfully
messagestring · requiredResponse message
message_codestring · requiredResponse message code
invocation_idstring · uuid · requiredRequest ID
propertyobject · requiredProperty details