Specifications
Street Manager
Equipment
Vehicles
Audit Events
Document Management
- GETGet v3document downloads
- POSTUpload a document
- GETGet v3documents
- POSTCreate a document
- GETGet v3documents 1
- PUTUpdate an existing document
- DELDelete a document
- GETGet v3documents contents
- POSTCreate document content
- GETGet v3documents contents 1
- GETDownload document content
- GETGet v3documents downloads
- PATCHUpdate the folder that a document is in
- GETGet v3folders
- POSTCreate a folder
- GETGet v3folders 1
- PUTUpdate an existing folder
- DELDelete a folder
- PATCHUpdate the parent of an existing folder
Forms
- GETGet v3forms
- POSTCreate a new form
- GETGet v3forms 1
- PUTUpdate an existing form
- GETGet v3orgs data captureform categories
- POSTCreate a new form category
- GETGet v3orgs data captureform categories 1
- POSTPost v3orgs data captureform categories relationshipsforms
- DELDelete v3orgs data captureform categories relationshipsforms
- PATCHPatch v3orgs data captureform categories relationshipsforms
- GETGet v3orgs data captureform submission versions
- GETGet v3orgs data captureforms
- POSTCreate a new form
- GETGet v3orgs data captureforms 1
- PUTUpdate an existing form
- GETGet v3orgs data captureforms schemas
- POSTCreate a new form schema
- GETGet v3orgs data captureforms schemas 1
- GETGet v3orgs data captureforms submissions
- POSTCreate a form submission
- GETGet v3orgs data captureforms submissions 1
- GETGet v3orgs data captureforms submissions versions
- GETGet v3orgs data captureforms submissions versions 1
- GETGet v3orgs data capturesubmissions
- GETGet v3orgs data capturesubmissions 1
- GETGet v3orgs data capturesubmissions versions
- GETGet v3orgs data capturesubmissions versions 1
IAM
- GETGet v3grants
- POSTCreate a grant
- GETGet v3grants 1
- PUTUpdate an existing grant
- DELDelete a grant
- GETGet v3iamwhoami
- POSTCreate an organisation
- GETGet v3orgs iamgroups
- POSTCreate a Role Group
- GETGet v3orgs iamgroups 1
- PATCHUpdate a Role Group
- PATCHPatch v3orgs iamgroups relationshipsmembers
- GETGet v3orgs iammember stats
- GETGet v3orgs iammembers
- GETGet v3orgs iammembers 1
- GETGet v3orgs iamservice accounts
- POSTCreate a Service Account
- GETGet v3orgs iamservice accounts 1
- POSTCreate a Service Account Key
- GETGet v3orgs iamservice accounts logs
- GETGet v3orgs iamservice accounts logs 1
- GETGet v3permissions
- GETGet v3permissions 1
- GETGet v3roles
- GETGet v3roles 1
- GETGet v3sso provider matches
- GETGet v3sso providers
- POSTCreate an SSO provider
- GETGet v3sso providers 1
- PUTUpdate an existing SSO provider
- DELDelete an SSO provider
- PUTUpdate a User
- GETGet v3whoami
Organisations
- GETGet v3orgs
- GETGet v3orgs 1
- GETGet v3orgs organisation bridge requests
- POSTGenerate a code that will allow another organisation to request a bridge to your organisation
- GETGet v3orgs organisation bridge requests 1
- PATCHUpdate an existing organisation bridge request
- GETGet v3orgs organisation bridges
- GETGet v3orgs organisation bridges 1
- GETGet v3orgs settingstime bands
- POSTCreate a new time band
- GETGet v3orgs settingstime bands 1
- PUTUpdate an existing time band
Customers
- GETGet v3orgs customersaccounts
- POSTPost v3orgs customersaccounts
- GETGet v3orgs customersaccounts 1
- PUTPut v3orgs customersaccounts
- POSTPost v3orgs customersaccounts relationshipscontacts
- DELDelete v3orgs customersaccounts relationshipscontacts
- PATCHPatch v3orgs customersaccounts relationshipscontacts
- POSTPost v3orgs customersaccounts relationshipsproperties
- DELDelete v3orgs customersaccounts relationshipsproperties
- PATCHPatch v3orgs customersaccounts relationshipsproperties
- GETGet v3orgs customersappointments
- POSTPost v3orgs customersappointments
- GETGet v3orgs customersappointments 1
- PUTPut v3orgs customersappointments
- PATCHPatch v3orgs customersappointments relationshipsinteraction
- PATCHPatch v3orgs customersappointments relationshipsoperation
- PATCHPatch v3orgs customersappointments relationshipstime band
- GETGet v3orgs customerscontacts
- POSTPost v3orgs customerscontacts
- GETGet v3orgs customerscontacts 1
- PUTPut v3orgs customerscontacts
- GETGet v3orgs customersinteractions
- POSTPost v3orgs customersinteractions
- GETGet v3orgs customersinteractions 1
- PUTPut v3orgs customersinteractions
- PATCHPatch v3orgs customersinteractions relationshipsaccount
- PATCHPatch v3orgs customersinteractions relationshipscontact
- PATCHPatch v3orgs customersinteractions relationshipsproperty
- PATCHPatch v3orgs customersinteractions relationshipsrepresentative
Media
Workforce
- GETGet v3orgs peopleteams
- POSTCreate a Team
- GETGet v3orgs peopleteams 1
- PATCHUpdate a Team
- PATCHPatch v3orgs peopleteams relationshipsmembers
- GETGet v3orgs workforcecompetencequalifications
- POSTCreate a new qualification
- GETGet v3orgs workforcecompetencequalifications 1
- PUTUpdate an existing qualification
- GETGet v3qualification award assessments
- POSTCreate a new qualification award assessment
- GETGet v3qualification award assessments 1
- GETGet v3qualification awards
- POSTCreate a new award for a qualification
- GETGet v3qualification awards 1
- PUTUpdate an existing qualification award
- GETRetrieve qualification types
- GETRetrieve a qualification type
Projects
- GETGet v3orgs projectsoperation templates
- POSTCreate a new operation template
- GETGet v3orgs projectsoperation templates 1
- PUTUpdate an existing operation template
- GETGet v3orgs projectsoperations
- POSTCreate a new operation
- GETGet v3orgs projectsoperations 1
- PUTUpdate an existing operation
- PATCHPatch v3orgs projectsoperations relationshipsappointment
- POSTPost v3orgs projectsoperations relationshipsassignees
- DELDelete v3orgs projectsoperations relationshipsassignees
- PATCHPatch v3orgs projectsoperations relationshipsassignees
- POSTPost v3orgs projectsoperations relationshipspermits
- DELDelete v3orgs projectsoperations relationshipspermits
- PATCHPatch v3orgs projectsoperations relationshipspermits
- POSTPost v3orgs projectsoperations relationshipsproperties
- DELDelete v3orgs projectsoperations relationshipsproperties
- PATCHPatch v3orgs projectsoperations relationshipsproperties
- POSTPost v3orgs projectsoperations relationshipsstreets
- DELDelete v3orgs projectsoperations relationshipsstreets
- PATCHPatch v3orgs projectsoperations relationshipsstreets
- POSTPost v3orgs projectsoperations relationshipsteams
- DELDelete v3orgs projectsoperations relationshipsteams
- PATCHPatch v3orgs projectsoperations relationshipsteams
- GETGet v3orgs projectspermits
- POSTCreate a new permit
- GETGet v3orgs projectspermits 1
- GETGet v3orgs projectsscheme templates
- POSTCreate a new scheme template
- GETGet v3orgs projectsscheme templates 1
- PUTUpdate an existing scheme template
- GETGet v3orgs projectsschemes
- POSTCreate a new scheme
- GETGet v3orgs projectsschemes 1
- PUTUpdate an existing scheme
- GETGet v3orgs projectswork order templates
- POSTCreate a new work order template
- GETGet v3orgs projectswork order templates 1
- PUTUpdate an existing work order template
- GETGet v3orgs projectswork orders
- POSTCreate a new work order
- GETGet v3orgs projectswork orders 1
- PUTUpdate an existing work order
- POSTPost v3orgs projectswork orders relationshipspermits
- DELDelete v3orgs projectswork orders relationshipspermits
- PATCHPatch v3orgs projectswork orders relationshipspermits
- POSTPost v3orgs projectswork orders relationshipssite managers
- DELDelete v3orgs projectswork orders relationshipssite managers
- PATCHPatch v3orgs projectswork orders relationshipssite managers
- GETList scheme share resources
- POSTCreate a new resource share between 2 organisations
- GETGet a scheme share resource
- GETGet v3schemes
- GETGet v3schemes 1
cURL
Copy
curl --request GET \
--url https://api.ctrl-hub.com/spec.yamlCopy
"<string>"Specifications
Get specyaml
Returns the full API spec in YAML format.
GET
/
spec.yaml
cURL
Copy
curl --request GET \
--url https://api.ctrl-hub.com/spec.yamlCopy
"<string>"Response
The yaml spec
The response is of type string.
⌘I