Endpoints
Reference for all available API endpoints.
Each endpoint includes request parameters, response schemas, and example responses. This information is generated from the OpenAPI specification →.
Areas
GETGet Area
Gets an area by its ID. A summary of its scheme and detailed information about its current stage will be provided, if set.
GETGet Area Scheduled Changes
Gets all scheduled future stage changes for an area. Includes pending, approved, cancelled, and applied changes.
GETGet Areas
Gets a page of areas, their associated schemes, current stages, and organisations, and pagination metadata.
GETGet Current Stage Assignment
Gets the currently active stage assignment for an area.
GETGet Stage Assignments
Gets all stage assignments for an area as a paginated timeline, sorted newest first. Includes the currently active assignment.