Ctrl Hub

API Reference

SDKs

Changelog

Dashboard

Website

Manufacturer Model

Introduction

About

Forms

Submissions

Processors

Reinstatements

Overview

Schemes / Work Orders

Schemes and Work Orders

Geospatial Data

Useful information to read before attempting to integrate with the API

Useful Reading

When we talk about API features, we are referring to the capabilities of the API rather than the resources themselves. This includes the ability to include, filter, sort, and page through data.

API Features

How to perform authenticated requests to the API

Auth

For current customers of Ctrl Hub, this is the latest version.

Current Version

The new version is the most recent version of Ctrl Hub which is backwards compatible with the current version. Access is currently limited as we prepare for release.

New Version

Installation

Usage

Organisation Model

Returns all organisations that the caller has access to

Get Organisations

Get an Organisation

Use this endpoint to create a new organisation. The owner of the organisation will be the caller who is making the API call.

Create an Organisation

Use this endpoint to update an organisation

Update an Organisation

Scheme Model

Get Schemes

Get a Scheme

Work Order Model

Get Work Orders

Get a Work Order

Permit Model

Get Permits

Get a Permit

Operation Model

Get Operations

Get an Operation

Property Model

Get Properties

Get a Property

Street Model

Get Streets

Get a Street

Form Model

Returns all forms for an organisation that the caller has access to

Get Forms

Return submission statistics for this form over a given time period

Get Stats

Form Category Model

Returns all form categories for an organisation

Get Form Categories

Submission Model

Returns all submissions for an organisation

Get Submissions

Get a Submission

Submission Version Model

Get Submission Versions

Get a Submission Version

Reinstatement Model

Returns all reinstatements for an organisation

Get Reinstatements

Returns a specific reinstatements for an organisation

Get a Reinstatement

Create a reinstatement for an organisation

Create a Reinstatement

API Documentation

Governance

Data Capture

Operations

Assets

Admin

Manufacturer Model