GET
/
v3
/
orgs
/
{orgId}
/
governance
/
schemes
/
{schemeId}
/
work-orders
/
{workOrderId}
/
permits
/
{permitId}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{orgId}/governance/schemes/{schemeId}/work-orders/{workOrderId}/permits/{permitId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "type": "permits",
    "id": "bcbdf616-6dd9-4ad6-a01b-b451a0c1205a",
    "attributes": {
      "reference": "REF001",
      "description": "DESC-123456",
      "proposed_start_date": "2024-06-13T00:00:00.000Z",
      "proposed_end_date": "2024-08-13T00:00:00.000Z"
    },
    "meta": {
      "created_at": "2024-06-13T07:15:23.000Z",
      "updated_at": "2024-06-13T07:15:23.000Z",
      "status": "granted"
    },
    "links": {
      "self": "https://api.ctrl-hub.com/v3/governance/schemes/5852cf16-8ec8-4aba-809e-f8d828772c4e/work-orders/5852cf16-8ec8-4aba-809e-f8d828772c4e/permits/5852cf16-8ec8-4aba-809e-f8d828772c4e"
    }
  }
}

Authorizations

​
Authorization
string
header
required

To understand how to authenticate, see the auth docs

Path Parameters

​
orgId
string
required

The ID of the organisation

Example:

"cc9746e0-9286-4575-ae0b-ac1b0fe873a6"

​
schemeId
string
required

The ID of the scheme

Example:

"5852cf16-8ec8-4aba-809e-f8d828772c4e"

​
workOrderId
string
required

The ID of the work order

Example:

"5852cf16-8ec8-4aba-809e-f8d828772c4e"

​
permitId
string
required

The ID of the permit

Example:

"bcbdf616-6dd9-4ad6-a01b-b451a0c1205a"

Response

200
application/json

The response is of type object.