Skip to main content
GET
/
v3
/
schemes
/
{scheme_id}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/schemes/{scheme_id} \
  --header 'X-Session-Token: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "code": "<string>",
      "description": "<string>",
      "dates": {
        "anticipated": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        }
      },
      "labels": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "from_template": true,
      "dates": {
        "scheduled": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        }
      },
      "counts": {
        "operations": 0,
        "permits": 0,
        "properties": 0,
        "streets": 0,
        "work_orders": 0
      },
      "completeness": {
        "percentage": {
          "completed": 0,
          "aborted": 0,
          "unknown": 100,
          "cancelled": 0
        },
        "counts": {
          "completed": 0,
          "aborted": 0,
          "unknown": 1,
          "cancelled": 0
        },
        "statuses": {
          "counts": {
            "done": 0,
            "in_progress": 0,
            "todo": 0
          },
          "percentages": {
            "done": 0,
            "in_progress": 0,
            "todo": 0
          }
        },
        "done_reasons": {
          "counts": {
            "aborted": 0,
            "cancelled": 0,
            "completed": 0
          },
          "percentages": {
            "aborted": 0,
            "cancelled": 0,
            "completed": 0
          }
        }
      },
      "is_default": false,
      "imported_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "organisation": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      },
      "scheme_template": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "work_orders": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      },
      "template": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "site_managers": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      },
      "assignees": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      },
      "teams": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      },
      "folder": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "start_time": "2023-11-07T05:31:56Z",
        "end_time": "2023-11-07T05:31:56Z",
        "medical_dependency": true,
        "on_ecr": true,
        "animals": true,
        "notes": "<string>",
        "on_ecr_notes": "<string>"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "author": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "interaction": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "operation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "time_band": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

scheme_id
string<uuid>
required

The unique identifier for the scheme.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
appointments,
assignees,
operations,
organisation,
permits,
properties,
site_managers,
streets,
teams,
template,
work_orders

Response

Get a scheme.

JSON API response object

data
object
required

A scheme

jsonapi
object
required
included
object[]

Related resources that can be included when a scheme is returned

An appointment