curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/governance/schemes \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"type": "schemes",
"id": "5852cf16-8ec8-4aba-809e-f8d828772c4e",
"attributes": {
"name": "IMGA100000",
"code": "CODE001",
"description": "DESC-123456",
"status": "active",
"start_date": "2024-06-13T00:00:00.000Z",
"end_date": "2024-08-13T00:00:00.000Z",
"labels": [
{
"key": "your-label",
"value": "abc123"
},
{
"key": "another-label",
"value": "meaningful-value"
}
]
},
"meta": {
"created_at": "2024-06-13T07:15:23.000Z"
},
"links": {
"self": "https://api.ctrl-hub.com/v3/governance/schemes/5852cf16-8ec8-4aba-809e-f8d828772c4e"
}
}
],
"meta": {
"counts": {
"limit": 10
},
"page": {
"limit": 10,
"offset": {
"current": 20,
"next": 30,
"previous": 10
}
}
},
"links": {
"current": "https://api.ctrl-hub.com/v3/governance/schemes?limit=10&offset=20",
"next": "https://api.ctrl-hub.com/v3/governance/schemes?limit=10&offset=30",
"previous": "https://api.ctrl-hub.com/v3/governance/schemes?limit=10&offset=10"
}
}
Sort Support
Resources can be sorted by name, code, status or created_at
The ID of the organisation
Limit the number of resources returned by the API
Offset for resources returned by the API
A field in the resource to sort results with. Not all attributes are supported, please see the Object Model for sortable fields.
Available options:
schemes
data.attributes.description
The description of the scheme
Available options:
In Planning,
Live,
On Hold,
Complete,
Cancelled
data.attributes.start_date
The start date of the scheme
The end date of the scheme
An array of label objects related to the scheme
data.attributes.labels.key
data.attributes.labels.value
Sortable. The time the scheme was created (RFC 3339)
meta.page.offset.previous
