Skip to main content
GET
/
v3
/
schemes
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/schemes \
  --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>"
          }
        },
        "contracts": {
          "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": {
        "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

​
org_id
string<uuid>
required

The unique identifier for the organisation.

Query Parameters

​
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
appointments,
assignees,
contracts,
operations,
organisation,
permits,
properties,
site_managers,
streets,
teams,
template,
work_orders,
folder
​
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id_in: Filter by scheme ID(s)
  • organisation_in: Filter schemes by organisation ID(s)
  • eq(contract,xxx): Filter schemes that are assigned to the given scheme contract ID.

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

Get a list of schemes.

JSON API response object

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

Related resources that can be included when a scheme is returned

An appointment