Skip to main content

Ctrl Hub home page

Specifications

GET
Get this spec (JSON)
GET
Get this spec (YAML)

Street Manager

POST
Create a new activity
POST
Create a new permit
POST
Create a new protection
GET
List permits
GET
Get a permit
GET
List versions of a permit
GET
Get a permit version

Equipment

GET
List equipment categories
GET
Get an equipment category
GET
List equipment
GET
Get a piece of equipment

Vehicles

GET
List vehicle categories
GET
Get a vehicle category
GET
List vehicles
GET
Get a vehicle

Audit Events

GET
List audit events
GET
Get an audit event

Documents

GET
List downloads for all documents
POST
Upload a document
GET
List documents
POST
Create a document
GET
Get a document
PUT
Update a document
DEL
Delete a document
GET
List document contents
POST
Add content to a document
GET
Create the content of a document
GET
Download the content of a document
GET
List downloads of a document
PATCH
Change a documents folder

Document Reviews

PUT
Make a decision for a review
GET
List request for document reviews
POST
Request a document review
GET
Get a request for a document review
PUT
Update a request for a document review
DEL
Delete a request for a document review

Folders

GET
List folders
POST
Create a folder
GET
Get a folder
PUT
Update a folder
DEL
Delete a folder
PATCH
Change a folders parent

Forms, Schemas and Categories

GET
List form categories
POST
Create a form category
GET
Get a form category
POST
Add a form to a category
DEL
Remove a form from a category
PATCH
Update the category for a form
GET
List form schemas
POST
Create a schema for a form
GET
Get a form schema
GET
List forms
POST
Create a form
GET
Get a form
PUT
Update a form

Submissions

GET
Get all versions of form submissions
POST
Create a submission for a form
GET
Get a version of a form submission
GET
List all submissions for a form
GET
Get a form submission

Properties

GET
List properties
GET
Get a property

Streets

GET
List streets
GET
Get a street

IAM Grants

GET
List grants
POST
Create a grant
GET
Get a grant
PUT
Update a grant
DEL
Delete a grant

Whoami

GET
Get information about the currently authenticated principal
GET
Get information about the currently authenticated principal

Images

GET
List images
POST
Create an image
GET
Get an image
GET
Get an image at a specified size
GET
List images
deprecated
POST
Create an image
deprecated
GET
Get an image
deprecated
GET
Get an image at a specified size
deprecated

Job Roles

GET
List job role assignments
POST
Assign a job role
GET
Get a job role assignment
DEL
Unassign a job role
GET
List types of job roles
GET
Get a type of job roles
GET
List job roles
POST
Create a job role
GET
Get a job role
PUT
Update a job role
DEL
Delete a job role

Operations

GET
List operations
POST
Create an operation
GET
Get an operation
PUT
Update an operation
PATCH
Replace the appointment on an operation
POST
Assign users to an operation
deprecated
DEL
Remove assignees from an operation
deprecated
PATCH
Replace assignees to an operation
POST
Assign permits to an operation
DEL
Remove permits from an operation
PATCH
Replace the permits on an operation
POST
Assign properties to an operation
DEL
Remove properties from an operation
PATCH
Replace properties on an operation
POST
Assign streets to an operation
DEL
Remove streets from an operation
PATCH
Replace the streets on an operation
POST
Assign teams to an operation
DEL
Remove teams from an operation
deprecated
PATCH
Replace the teams on an operation
GET
List operation templates
POST
Create an operation template
GET
Get an operation template
PUT
Update an operation template
GET
List operations
deprecated
POST
Create an operation
deprecated
GET
Get an operation
deprecated
PUT
Update an operation
deprecated
PATCH
Replace the appointment on an operation
deprecated
POST
Assign users to an operation
deprecated
DEL
Remove assignees from an operation
deprecated
PATCH
Replace assignees to an operation
POST
Assign permits to an operation
deprecated
DEL
Remove permits from an operation
deprecated
PATCH
Replace the permits on an operation
deprecated
POST
Assign properties to an operation
deprecated
DEL
Remove properties from an operation
deprecated
PATCH
Replace properties on an operation
deprecated
POST
Assign streets to an operation
deprecated
DEL
Remove streets from an operation
deprecated
PATCH
Replace the streets on an operation
deprecated
POST
Assign teams to an operation
deprecated
DEL
Remove teams from an operation
deprecated
PATCH
Replace the teams on an operation
deprecated

Organisations

GET
List organisations
POST
Create an organisation
GET
Get an organisation
GET
Get member stats
GET
List members
GET
Get a member

Customer Accounts and Contacts

GET
List accounts
POST
Create an account
GET
Get an account
PUT
Update an account
POST
Associate a contact to an account
DEL
Remove contacts from an account
PATCH
Update the contacts for an account
POST
Associate a property to an account
DEL
Remove properties from an account
PATCH
Update the properties for an account
GET
List contacts
POST
Create a contact
GET
Get a contact
PUT
Update a contact

Customer Appointments

GET
List appointments
POST
Create an appointment
GET
Get an appointment
PUT
Update an appointment
PATCH
Update appointment interactions
PATCH
Update appointment operations
PATCH
Update an appointment time band

Customer Interactions

GET
List interactions
POST
Create an interaction
GET
Get an interaction
PUT
Update an interaction
PATCH
Update the account for an interaction
PATCH
Update the contact for an interaction
PATCH
Update the property for an interaction
PATCH
Update the prepresentative for an interaction

IAM Role Groups

GET
List role groups
POST
Create a role group
GET
Get a role group
PATCH
Update a role group
PATCH
Replace group members

Service Accounts

GET
List service accounts
POST
Create a service account
GET
Get a service account
POST
Create a key for a service account
GET
List logs for a service account
GET
Get a log for a service account

Bridges

GET
List bridge requests
POST
Create a bridge request
GET
Get a bridge request
PATCH
Update a bridge request
GET
List bridges
GET
Get a bridge

Teams

GET
List teams
POST
Create a team
GET
Get a team
PATCH
Update a team
PATCH
Replace team members

Permits

GET
List permits
POST
Create a permit
GET
Get a permit

Schemes

GET
List scheme templates
POST
Get a scheme template
GET
Get a scheme template
PUT
Update a scheme template
GET
List schemes
deprecated
POST
Create a scheme
deprecated
GET
Get a scheme
deprecated
PUT
Update a scheme
deprecated
GET
List schemes
deprecated
GET
Get a scheme

Work Orders

GET
List work order templates
POST
Create a work order template
GET
Get a work order template
PUT
Update a work order template
GET
List work order templates
deprecated
POST
Create a work order
deprecated
GET
Get a work order
deprecated
PUT
Update a work order
deprecated
POST
Assign permits to a work order
deprecated
DEL
Remove permits from a work order
deprecated
PATCH
Replace permits on a work order
deprecated
POST
Assign site managers to a work order
deprecated
DEL
Remove site managers from a work order
deprecated
PATCH
Replace site managers on a work order
deprecated
GET
List work orders
POST
Create a work order
GET
Get a work order
PUT
Update a work order
POST
Assign permits to a work order
DEL
Remove permits from a work order
PATCH
Replace permits on a work order
POST
Assign site managers to a work order
DEL
Remove site managers from a work order
PATCH
Replace site managers on a work order

Settings

GET
List time bands
POST
Create a time band
GET
Get a time band
PUT
Update a time band

Qualifications

GET
List qualifications
deprecated
POST
Create a qualification
deprecated
GET
Get a qualification
deprecated
PUT
Update a qualification
deprecated
GET
List assessments
POST
Assess a qualification
GET
Get an assessment
GET
List verifications
POST
Verify a qualification
GET
Get a verification
PUT
Update a verification
GET
List qualification awards
POST
Award a qualification
GET
Get a qualification award
PUT
Update an award
GET
List qualification types
GET
Get a qualification type
GET
List qualifications
POST
Create a qualification
GET
Get a qualification
PUT
Update a qualification

IAM Permissions

GET
List permissions
GET
Get a permission

IAM Roles

GET
List roles
GET
Get a role

Scheme Shares

GET
List scheme shares
POST
Create a scheme share
GET
Get a scheme share
PUT
Update a scheme share

Search

GET
Perform a search

SSO Providers

GET
Match an SSO provider
GET
List SSO providers
POST
Create an SSO provider
GET
Get an SSO provider
PUT
Update an SSO provider
DEL
Delete an SSO provider

Invitations

GET
List invitations
POST
Invite a user
GET
Get an invitation
DEL
Delete an invitation
PATCH
Update an invitation

Users

POST
Create a managed user
PUT
Update a user

Workflows

GET
List workflow versions
POST
Create a workflow version
GET
Get a workflow version
GET
List workflows
POST
Create a workflow
GET
Get a workflow
PUT
Update a workflow

Ctrl Hub home page

404

Page Not Found

We couldn't find the page. Maybe you were looking for one of these pages below?

Get a work order template List work order templates API Features

⌘I