Skip to main content
GET
/
v3
/
orgs
/
{org_id}
/
projects
/
permits
/
{permit_id}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/projects/permits/{permit_id} \
  --header 'X-Session-Token: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "dates": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "risk": {
        "remaining": {
          "days": 123,
          "percent": 50
        },
        "status": "low"
      }
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "source_permit": {
        "usrn": 123,
        "reference": "<string>",
        "status": "<string>",
        "work_status": "<string>"
      },
      "governance": {
        "complete": true
      }
    },
    "relationships": {
      "operation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "work_order": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "street_manager_permit": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "status": "done",
        "code": "<string>",
        "description": "<string>",
        "dates": {
          "scheduled": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          }
        },
        "labels": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "requirements": {
          "forms": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "required": true
            }
          ]
        },
        "done_reason": "aborted"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "counts": {
          "streets": 0,
          "properties": 0
        },
        "related_data": {
          "properties": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "postcode": "<string>"
            }
          ]
        }
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "scheme": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "work_order": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "appointment": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "permits": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "template": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "teams": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "assignees": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "properties": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "streets": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

permit_id
string<uuid>
required

The unique identifier for the governance permit.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
operation,
work_order,
street_manager_permit,
responsible_people

Response

An individual permit.

JSON API response object

data
object
required

A permit

jsonapi
object
required
included
object[]

Related resources that can be included when a permit is returned

An operation