Specifications
Street Manager
Properties
Qualifications
- GETList assessment definitions
- POSTCreate an assessment definition
- GETGet an assessment definition
- PUTUpdate an assessment definition
- DELDelete an assessment definition
- GETList assessments
- POSTCreate an assessment
- GETGet an assessment
- PUTUpdate an assessment
- GETList awarding bodies
- GETGet an awarding body
- GETList competency requirement specifications
- POSTCreate a competency requirement specification
- GETGet a competency requirement specification
- PUTUpdate a competency requirement specification
- DELDelete a competency requirement specification
- POSTEvaluate group compliance for a CRS
- GETList induction completions
- POSTCreate an induction completion
- GETGet an induction completion
- PUTUpdate an induction completion
- DELDelete an induction completion
- GETList inductions
- POSTCreate an induction
- GETGet an induction
- PUTUpdate an induction
- DELDelete an induction
- GETList assessments
- POSTAssess a qualification
- GETGet an assessment
- GETList verifications
- POSTVerify a qualification
- GETGet a verification
- PUTUpdate a verification
- GETList qualification awards
- POSTAward a qualification
- GETGet a qualification award
- PUTUpdate an award
- GETList qualification units
- GETGet a qualification unit
- GETList qualifications
- GETGet a qualification
- PUTUpdate a qualification
- GETList registrations
- POSTCreate a registration
- GETGet a registration
- PUTUpdate a registration
- DELDelete a registration
- GETList skills register scheme categories
- POSTCreate a skills register scheme category
- GETGet a skills register scheme category
- PUTUpdate a skills register scheme category
- GETList skills register schemes
- POSTCreate a skills register scheme
- GETGet a skills register scheme
- PUTUpdate a skills register scheme
- GETList skills registers
- POSTCreate a skills register
- GETGet a skills register
- PUTUpdate a skills register
- GETList standards bodies
- GETGet a standards body
- GETList training items
- POSTCreate a training item
- GETGet a training item
- PUTUpdate a training item
- DELDelete a training item
- GETList training standard categories
- POSTCreate a training standard category
- GETGet a training standard category
- PUTUpdate a training standard category
- GETList training standard completions
- POSTCreate a training standard completion
- GETGet a training standard completion
- PUTUpdate a training standard completion
- GETList training standards
- GETGet a training standard
- PUTUpdate a training standard
Workforce
- GETList assessment records
- POSTCreate an assessment record
- GETGet an assessment record
- PUTUpdate an assessment record
- DELDelete an assessment record
- GETList category registrations
- POSTCreate a category registration
- GETGet a category registration
- PUTUpdate a category registration
- DELDelete a category registration
- GETList scheme registrations
- POSTCreate a scheme registration
- GETGet a scheme registration
- PUTUpdate a scheme registration
- DELDelete a scheme registration
- GETList training completions
- POSTCreate a training completion
- GETGet a training completion
- PUTUpdate a training completion
- DELDelete a training completion
- GETList verifications
- POSTCreate a verification
- GETGet a verification
Audit Events
Dashboards
Documents
- GETList downloads for all documents
- POSTUpload a document
- GETList documents
- POSTCreate a document
- GETGet a document
- PUTUpdate a document
- DELDelete a document
- GETList document contents
- POSTAdd content to a document
- GETCreate the content of a document
- GETDownload the content of a document
- GETList downloads of a document
- PATCHChange a documents folder
Document Reviews
Organisations
Equipment
- GETList equipment categories
- POSTCreate an equipment category
- GETGet an equipment category
- DELDelete an equipment category
- PATCHUpdate an equipment category
- GETList equipment items
- POSTCreate an equipment item
- GETGet an equipment item
- DELDelete an equipment item
- PATCHUpdate an equipment item
- GETList equipment manufacturers
- POSTCreate an equipment manufacturer
- GETGet an equipment manufacturer
- DELDelete an equipment manufacturer
- PATCHUpdate an equipment manufacturer
- GETList equipment models
- POSTCreate an equipment model
- GETGet an equipment model
- DELDelete an equipment model
- PATCHUpdate an equipment model
Feature Configurations
Feature Registry
Folders
Forms, Schemas and Categories
Submissions
Whoami
Import Templates
Job Roles
Settings
Operations
- GETList operation types
- POSTCreate an operation type
- GETGet an operation type
- PUTUpdate an operation type
- DELDelete an operation type
- GETList operations
- POSTCreate an operation
- GETGet an operation
- PUTUpdate an operation
- DELDelete an operation
- PATCHPatch an operation
- PATCHReplace the appointment on an operation
- POSTAssign users to an operationdeprecated
- DELRemove assignees from an operationdeprecated
- PATCHReplace assignees to an operation
- POSTAssign permits to an operation
- DELRemove permits from an operation
- PATCHReplace the permits on an operation
- POSTAssign properties to an operation
- DELRemove properties from an operation
- PATCHReplace properties on an operation
- POSTAssign streets to an operation
- DELRemove streets from an operation
- PATCHReplace the streets on an operation
- POSTAssign teams to an operation
- DELRemove teams from an operationdeprecated
- PATCHReplace the teams on an operation
- GETList operation templates
- POSTCreate an operation template
- GETGet an operation template
- PUTUpdate an operation template
Customer Accounts and Contacts
- GETList accounts
- POSTCreate an account
- GETGet an account
- PUTUpdate an account
- POSTAssociate a contact to an account
- DELRemove contacts from an account
- PATCHUpdate the contacts for an account
- POSTAssociate a property to an account
- DELRemove properties from an account
- PATCHUpdate the properties for an account
- GETList contacts
- POSTCreate a contact
- GETGet a contact
- PUTUpdate a contact
Customer Appointments
Customer Interactions
IAM Role Groups
Service Accounts
Bridges
Schemes
Work Orders
- GETList work order templates
- POSTCreate a work order template
- GETGet a work order template
- PUTUpdate a work order template
- GETList work orders
- POSTCreate a work order
- GETGet a work order
- PUTUpdate a work order
- DELDelete a work order
- POSTAssign permits to a work order
- DELRemove permits from a work order
- PATCHReplace permits on a work order
- POSTAssign site managers to a work order
- DELRemove site managers from a work order
- PATCHReplace site managers on a work order
IAM Permissions
IAM Roles
Scheme Contracts
Scheme Shares
Search
SSO Providers
Status
Invitations
Vehicles
- GETList vehicle categories
- POSTCreate a vehicle category
- GETGet a vehicle category
- DELDelete a vehicle category
- PATCHUpdate a vehicle category
- GETList vehicle enquiries
- POSTPerform a vehicle enquiry
- GETGet a vehicle enquiry
- GETList vehicle inspections
- POSTCreate a vehicle inspection
- GETGet a vehicle inspection
- DELDelete a vehicle inspection
- PATCHUpdate a vehicle inspection
- GETList vehicle inventory checks
- POSTCreate a vehicle inventory check
- GETGet a vehicle inventory check
- DELDelete a vehicle inventory check
- PATCHUpdate a vehicle inventory check
- GETList vehicle manufacturers
- POSTCreate a vehicle manufacturer
- GETGet a vehicle manufacturer
- DELDelete a vehicle manufacturer
- PATCHUpdate a vehicle manufacturer
- GETList vehicle models
- POSTCreate a vehicle model
- GETGet a vehicle model
- DELDelete a vehicle model
- PATCHUpdate a vehicle model
- GETList MOT records
- GETGet an MOT record
- GETList vehicle specifications
- POSTCreate a vehicle specification
- GETGet a vehicle specification
- DELDelete a vehicle specification
- PATCHUpdate a vehicle specification
- GETList vehicles
- POSTCreate a vehicle
- GETGet a vehicle
- DELDelete a vehicle
- PATCHUpdate a vehicle
Download document content
curl --request GET \
--url https://api.ctrl-hub.com/v3/documents/{document_id}/contents/{document_content_id}/download \
--header 'X-Session-Token: <api-key>'"<string>"Documents
Download the content of a document
Download document content
GET
/
v3
/
documents
/
{document_id}
/
contents
/
{document_content_id}
/
download
Download document content
curl --request GET \
--url https://api.ctrl-hub.com/v3/documents/{document_id}/contents/{document_content_id}/download \
--header 'X-Session-Token: <api-key>'"<string>"Documentation Index
Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
SessionOAuth2Cookie
Session token for authentication.
Path Parameters
The unique identifier for the document.
The unique identifier for the document content.
Response
Download the content of a document.
The response is of type file.
⌘I