Skip to main content
GET
/
v3
/
orgs
/
{org_id}
/
projects
/
operations
/
{operation_id}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/projects/operations/{operation_id} \
  --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>"
          }
        ]
      }
    }
  },
  "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.

operation_id
string<uuid>
required

The unique identifier for the operation.

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

Response

An individual operation.

JSON API response object

data
object
required

An operation

jsonapi
object
required
included
object[]

Related resources that can be included when an operation is returned

A form