Organisations
Get an Organisation
API Documentation
Governance
- Organisations
- Schemes
- Work Orders
- Permits
- Operations
- Properties
- Streets
Data Capture
- Forms
- Form Categories
- Submissions
- Submission Versions
Operations
- Reinstatements
Assets
- Vehicles
Admin
- IAM
Organisations
Get an Organisation
Returns an organisation
GET
/
v3
/
orgs
/
{orgId}
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId} \
--header 'Authorization: Bearer <token>'
{
"data": {
"type": "organisations",
"id": "7e0c875a-fd47-401d-bd25-4278ed58d721",
"attributes": {
"name": "Ctrl Hub",
"slug": "ctrl-hub",
"description": "Ctrl Hub deliver best in class software for managing your compliance, safety, risk and resource requirements",
"settings": {
"nomenclature": {
"governance": {
"schemes": [
{
"language": "en-GB",
"singular": "Scheme",
"plural": "Schemes"
}
],
"work_orders": [
{
"language": "en-GB",
"singular": "Work Order",
"plural": "Work Orders"
}
],
"operations": [
{
"language": "en-GB",
"singular": "Operation",
"plural": "Operations"
}
]
}
}
}
},
"meta": {
"created_at": "2024-06-13T07:15:23.000Z",
"status": "active"
},
"links": {
"self": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721"
}
}
}
Authorizations
To understand how to authenticate, see the auth docs
Path Parameters
The ID of the organisation
Query Parameters
Limit the number of resources returned by the API
Offset for resources returned by the API
Response
200
application/json
The type of resource
Available options:
organisations
The organisation ID
Sortable. The organisation name.
Sortable. The organisation slug, which is used in requests for subresources.
A description for the organisation
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId} \
--header 'Authorization: Bearer <token>'
{
"data": {
"type": "organisations",
"id": "7e0c875a-fd47-401d-bd25-4278ed58d721",
"attributes": {
"name": "Ctrl Hub",
"slug": "ctrl-hub",
"description": "Ctrl Hub deliver best in class software for managing your compliance, safety, risk and resource requirements",
"settings": {
"nomenclature": {
"governance": {
"schemes": [
{
"language": "en-GB",
"singular": "Scheme",
"plural": "Schemes"
}
],
"work_orders": [
{
"language": "en-GB",
"singular": "Work Order",
"plural": "Work Orders"
}
],
"operations": [
{
"language": "en-GB",
"singular": "Operation",
"plural": "Operations"
}
]
}
}
}
},
"meta": {
"created_at": "2024-06-13T07:15:23.000Z",
"status": "active"
},
"links": {
"self": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721"
}
}
}