Skip to main content
GET
/
v3
/
street-manager
/
permits
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/street-manager/permits \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "activated": true,
        "usrn": 123,
        "permit_reference_number": "<string>",
        "permit_reference_number_iteration": 123,
        "work_reference_number": "<string>",
        "status": "submitted",
        "work_status_ref": "completed",
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "latest_version": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "versions": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<string>"
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "permit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "work_reference_number": "<string>",
        "permit_reference_number": "<string>",
        "promoter_swa_code": "<string>",
        "promoter_organisation": "<string>",
        "highway_authority": "<string>",
        "works_location_coordinates": {},
        "street_name": "<string>",
        "area_name": "<string>",
        "work_category": "minor",
        "traffic_management_type": "road_closure",
        "proposed_start_date": "2023-11-07T05:31:56Z",
        "proposed_end_date": "2023-11-07T05:31:56Z",
        "proposed_start_time": "2023-11-07T05:31:56Z",
        "proposed_end_time": "2023-11-07T05:31:56Z",
        "actual_start_date_time": "2023-11-07T05:31:56Z",
        "actual_end_date_time": "2023-11-07T05:31:56Z",
        "work_status": "planned",
        "usrn": 123,
        "highway_authority_swa_code": "<string>",
        "work_category_ref": "<string>",
        "traffic_management_type_ref": "<string>",
        "work_status_ref": "<string>",
        "activity_type": "Highway improvement works",
        "is_ttro_required": "yes",
        "is_covid_19_response": true,
        "works_location_type": [
          "Carriageway"
        ],
        "permit_conditions": [
          "<string>"
        ],
        "road_category": 5,
        "is_traffic_sensitive": true,
        "is_deemed": true,
        "permit_status": "submitted",
        "town": "<string>",
        "collaborative_working": true,
        "collaboration_type": "trench_sharing_primary_promoter",
        "collaboration_type_ref": "<string>",
        "close_footway": "yes_provide_pedestrian_walkway",
        "close_footway_ref": "<string>",
        "current_traffic_management_type": "road_closure",
        "current_traffic_management_type_ref": "<string>",
        "current_traffic_management_update_date": "2023-11-07T05:31:56Z"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "permit": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

Authorizations

​
X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

​
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
versions,
latest_version
​
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • prn_in: Filter by PRN (Permit Reference Number)
  • wrn_in: Filter by WRN (Works Reference Number)
  • status_in: Filter by permit status
  • wsr_in: Filter by WSR (Work Status Reference)
  • no_wsr: Filter for no WSR (Work Status Reference)
  • updated_before: Filter for permits updated before a specific date/time (RFC3339 format)

For more information on using named filters, see the docs

​
limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
​
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

List all permits in the system.

JSON API response object

​
data
A list of permits · object[]
required
​
meta
object
required
​
jsonapi
object
required
​
included
object[]