Skip to main content
GET
/
v3
/
orgs
/
{org_id}
/
projects
/
operations
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/projects/operations \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "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>"
            }
          ]
        }
      }
    }
  ],
  "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": {
        "name": "<string>",
        "description": "<string>",
        "status": "draft"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "counts": {
          "schemas": 0,
          "categories": 0,
          "submissions": 0,
          "submission_versions": 0
        }
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "categories": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "schemas": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "author": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "latest_schema": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "submissions": {
          "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:
appointment,
assignees,
forms,
organisation,
permits,
properties,
scheme,
streets,
teams,
template,
work_order
​
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id_in: Filter by ID(s)
  • in_schemes: Filter for operations that are part of a scheme(s) by their ID(s)
  • in_work_orders: Filter for operations that are part of a work order(s) by their ID(s)
  • assigned_to: Filter for operations assigned to a user(s) by their ID(s)
  • at_properties: Filter for operations at a property(s) by their ID(s)
  • unscheduled: Filter for unscheduled operations
  • no_start: Filter operations with no start time
  • no_end: Filter operations with no end time
  • has_appointment: Filter operations that have appointments
  • no_appointment: Filter operations that do not have appointments
  • has_property: Filter operations that have any related property - this does not accept arguments, it just checks for the existence of a related property. You can use at_properties to find operations at a specific property.

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
​
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
code,
-code,
created_at,
-created_at,
name,
-name,
postcode,
-postcode

Response

List of operations.

JSON API response object

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

Related resources that can be included when an operation is returned

A form