Sites

get

List block bookings for a site. Each row includes member counts and a status summary so the list view doesn't need a follow-up query.

Path parameters

siteIdstringRequired

Query parameters

qstringOptional

archivedbooleanOptional

limitnumberOptional

skipnumberOptional

sortstring · enumOptionalPossible values:

Responses

200

Default Response

No content

get/sites/{siteId}/block-bookings

HTTPcURLJavaScriptPython

GET /sites/{siteId}/block-bookings HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

No content

get

List cancellation codes for a site.

Path parameters

siteIdstringRequired

Query parameters

include_inactivebooleanOptionalDefault: false

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

get/sites/{siteId}/cancellation-codes

HTTPcURLJavaScriptPython

GET /sites/{siteId}/cancellation-codes HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

[
  {
    "_id": "text",
    "site": "text",
    "code": "text",
    "description": "text",
    "sequence": 1,
    "inactive": true,
    "created_at": "text",
    "updated_at": "text"
  }
]

post

Create a new cancellation code for a site.

Path parameters

siteIdstringRequired

Body

application/json

codestring · max: 16Required

descriptionstringRequired

sequencenumberOptionalDefault: 0

inactivebooleanOptionalDefault: false

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

post/sites/{siteId}/cancellation-codes

HTTPcURLJavaScriptPython

POST /sites/{siteId}/cancellation-codes HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "code": "text",
  "description": "text",
  "sequence": 0,
  "inactive": false
}

200

Default Response

{
  "_id": "text",
  "site": "text",
  "code": "text",
  "description": "text",
  "sequence": 1,
  "inactive": true,
  "created_at": "text",
  "updated_at": "text"
}

delete

Delete a cancellation code.

Path parameters

siteIdstringRequired

codeIdstringRequired

Responses

200

Default Response

application/json

_idstringRequired

deletedbooleanRequired

delete/sites/{siteId}/cancellation-codes/{codeId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/cancellation-codes/{codeId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "deleted": true
}

patch

Update a cancellation code. Code is immutable and cannot be changed.

Path parameters

siteIdstringRequired

codeIdstringRequired

Body

application/json

descriptionstringOptional

sequencenumberOptional

inactivebooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

patch/sites/{siteId}/cancellation-codes/{codeId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/cancellation-codes/{codeId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "description": "text",
  "sequence": 1,
  "inactive": true
}

200

Default Response

{
  "_id": "text",
  "site": "text",
  "code": "text",
  "description": "text",
  "sequence": 1,
  "inactive": true,
  "created_at": "text",
  "updated_at": "text"
}

post

Create a new category for a site.

Path parameters

siteIdstringRequired

Body

application/json

namestringRequired

colourstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

created_atstringRequired

updated_atstringRequired

post/sites/{siteId}/categories

HTTPcURLJavaScriptPython

POST /sites/{siteId}/categories HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "colour": "text"
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text"
}

delete

Remove a category from a site. Reassigns incidents if needed, archives or fully deletes.

Path parameters

siteIdstringRequired

categoryIdstringRequired

Body

application/json

reassign_tostringOptional

permanentbooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

archived_sitesstring[]Optional

created_atstringOptional

updated_atstringOptional

deletedbooleanOptional

archivedbooleanOptional

409

Default Response

application/json

delete/sites/{siteId}/categories/{categoryId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/categories/{categoryId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "reassign_to": "text",
  "permanent": true
}

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "archived_sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text",
  "deleted": true,
  "archived": true
}

patch

Update a category for a site.

Path parameters

siteIdstringRequired

categoryIdstringRequired

Body

application/json

namestringRequired

colourstringRequired

it_map_stringstringOptional

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

created_atstringRequired

updated_atstringRequired

it_map_stringstringOptional

patch/sites/{siteId}/categories/{categoryId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/categories/{categoryId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "name": "text",
  "colour": "text",
  "it_map_string": "text"
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text",
  "it_map_string": "text"
}

post

Restore an archived category back to a site.

Path parameters

siteIdstringRequired

categoryIdstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

archived_sitesstring[]Optional

created_atstringOptional

updated_atstringOptional

it_map_stringstringOptional

post/sites/{siteId}/categories/{categoryId}/restore

HTTPcURLJavaScriptPython

POST /sites/{siteId}/categories/{categoryId}/restore HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "archived_sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text",
  "it_map_string": "text"
}

get

Retrieve a list of sites the user has access to.

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

logo_urlstringOptional

created_atstringRequired

updated_atstringRequired

get/sites/

HTTPcURLJavaScriptPython

GET /sites/ HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

[
  {
    "_id": "text",
    "name": "text",
    "logo_url": "text",
    "created_at": "text",
    "updated_at": "text"
  }
]

post

Create a new site.

Body

application/json

namestringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

created_bystringRequired

created_atstringRequired

updated_atstringRequired

post/sites/

HTTPcURLJavaScriptPython

POST /sites/ HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "created_by": "text",
  "created_at": "text",
  "updated_at": "text"
}

post

Create a new flag type for a site.

Path parameters

siteIdstringRequired

Body

application/json

namestringRequired

colourstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

created_atstringRequired

updated_atstringRequired

post/sites/{siteId}/flag-types

HTTPcURLJavaScriptPython

POST /sites/{siteId}/flag-types HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "colour": "text"
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text"
}

delete

Remove a flag type from a site. Archives or fully deletes.

Path parameters

siteIdstringRequired

flagTypeIdstringRequired

Body

application/json

permanentbooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

archived_sitesstring[]Optional

created_atstringOptional

updated_atstringOptional

deletedbooleanOptional

archivedbooleanOptional

delete/sites/{siteId}/flag-types/{flagTypeId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/flag-types/{flagTypeId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "permanent": true
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "archived_sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text",
  "deleted": true,
  "archived": true
}

patch

Update a flag type for a site.

Path parameters

siteIdstringRequired

flagTypeIdstringRequired

Body

application/json

namestringRequired

colourstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

created_atstringRequired

updated_atstringRequired

patch/sites/{siteId}/flag-types/{flagTypeId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/flag-types/{flagTypeId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "colour": "text"
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text"
}

post

Restore an archived flag type back to a site.

Path parameters

siteIdstringRequired

flagTypeIdstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

archived_sitesstring[]Optional

created_atstringOptional

updated_atstringOptional

post/sites/{siteId}/flag-types/{flagTypeId}/restore

HTTPcURLJavaScriptPython

POST /sites/{siteId}/flag-types/{flagTypeId}/restore HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "archived_sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text"
}

get

List housekeeping tasks for a site.

Path parameters

siteIdstringRequired

Query parameters

include_inactivebooleanOptionalDefault: false

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

instructionsstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

get/sites/{siteId}/housekeeping-tasks

HTTPcURLJavaScriptPython

GET /sites/{siteId}/housekeeping-tasks HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

[
  {
    "_id": "text",
    "site": "text",
    "code": "text",
    "description": "text",
    "instructions": "text",
    "sequence": 1,
    "inactive": true,
    "created_at": "text",
    "updated_at": "text"
  }
]

post

Create a new housekeeping task for a site.

Path parameters

siteIdstringRequired

Body

application/json

codestring · max: 16Required

descriptionstringRequired

instructionsstringOptional

sequencenumberOptionalDefault: 0

inactivebooleanOptionalDefault: false

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

instructionsstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

post/sites/{siteId}/housekeeping-tasks

HTTPcURLJavaScriptPython

POST /sites/{siteId}/housekeeping-tasks HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "code": "text",
  "description": "text",
  "instructions": "text",
  "sequence": 0,
  "inactive": false
}

200

Default Response

{
  "_id": "text",
  "site": "text",
  "code": "text",
  "description": "text",
  "instructions": "text",
  "sequence": 1,
  "inactive": true,
  "created_at": "text",
  "updated_at": "text"
}

delete

Delete a housekeeping task.

Path parameters

siteIdstringRequired

taskIdstringRequired

Responses

200

Default Response

application/json

_idstringRequired

deletedbooleanRequired

delete/sites/{siteId}/housekeeping-tasks/{taskId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/housekeeping-tasks/{taskId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "deleted": true
}

patch

Update a housekeeping task. Code is immutable and cannot be changed.

Path parameters

siteIdstringRequired

taskIdstringRequired

Body

application/json

descriptionstringOptional

instructionsstringOptional

sequencenumberOptional

inactivebooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

instructionsstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

patch/sites/{siteId}/housekeeping-tasks/{taskId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/housekeeping-tasks/{taskId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "description": "text",
  "instructions": "text",
  "sequence": 1,
  "inactive": true
}

200

Default Response

{
  "_id": "text",
  "site": "text",
  "code": "text",
  "description": "text",
  "instructions": "text",
  "sequence": 1,
  "inactive": true,
  "created_at": "text",
  "updated_at": "text"
}

post

Create a new incident form for a site.

Path parameters

siteIdstringRequired

Responses

200

Default Response

No content

post/sites/{siteId}/incident-forms

HTTPcURLJavaScriptPython

POST /sites/{siteId}/incident-forms HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

No content

delete

Delete an incident form for a site.

Path parameters

siteIdstringRequired

formIdstringRequired

Responses

200

Default Response

No content

delete/sites/{siteId}/incident-forms/{formId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/incident-forms/{formId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

No content

patch

Update an incident form for a site.

Path parameters

siteIdstringRequired

formIdstringRequired

Responses

200

Default Response

No content

patch/sites/{siteId}/incident-forms/{formId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/incident-forms/{formId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

No content

post

Generate a presigned URL for a site logo upload.

Path parameters

siteIdstringRequired

Body

application/json

content_typestring · enumRequiredPossible values:

Responses

200

Default Response

application/json

urlstringRequired

object_idstringRequired

post/sites/{siteId}/logo

HTTPcURLJavaScriptPython

POST /sites/{siteId}/logo HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "content_type": "image/png"
}

200

Default Response

{
  "url": "text",
  "object_id": "text"
}

put

Persist an uploaded site logo.

Path parameters

siteIdstringRequired

Body

application/json

object_idstringRequired

Responses

200

Default Response

application/json

raw_urlstringRequired

source_uristringRequired

uploadedbooleanRequired

object_idstringRequired

put/sites/{siteId}/logo

HTTPcURLJavaScriptPython

PUT /sites/{siteId}/logo HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "object_id": "text"
}

200

Default Response

{
  "raw_url": "text",
  "source_uri": "text",
  "uploaded": true,
  "object_id": "text"
}

get

List no-service reasons for a site.

Path parameters

siteIdstringRequired

Query parameters

include_inactivebooleanOptionalDefault: false

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

get/sites/{siteId}/no-service-reasons

HTTPcURLJavaScriptPython

GET /sites/{siteId}/no-service-reasons HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

[
  {
    "_id": "text",
    "site": "text",
    "code": "text",
    "description": "text",
    "sequence": 1,
    "inactive": true,
    "created_at": "text",
    "updated_at": "text"
  }
]

post

Create a new no-service reason for a site.

Path parameters

siteIdstringRequired

Body

application/json

codestring · max: 20Required

descriptionstring · max: 2000Required

sequencenumberOptionalDefault: 0

inactivebooleanOptionalDefault: false

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

post/sites/{siteId}/no-service-reasons

HTTPcURLJavaScriptPython

POST /sites/{siteId}/no-service-reasons HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "code": "text",
  "description": "text",
  "sequence": 0,
  "inactive": false
}

200

Default Response

{
  "_id": "text",
  "site": "text",
  "code": "text",
  "description": "text",
  "sequence": 1,
  "inactive": true,
  "created_at": "text",
  "updated_at": "text"
}

delete

Delete a no-service reason.

Path parameters

siteIdstringRequired

reasonIdstringRequired

Responses

200

Default Response

application/json

_idstringRequired

deletedbooleanRequired

delete/sites/{siteId}/no-service-reasons/{reasonId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/no-service-reasons/{reasonId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "deleted": true
}

patch

Update a no-service reason. Code is immutable and cannot be changed.

Path parameters

siteIdstringRequired

reasonIdstringRequired

Body

application/json

descriptionstring · max: 2000Optional

sequencenumberOptional

inactivebooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

patch/sites/{siteId}/no-service-reasons/{reasonId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/no-service-reasons/{reasonId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "description": "text",
  "sequence": 1,
  "inactive": true
}

200

Default Response

{
  "_id": "text",
  "site": "text",
  "code": "text",
  "description": "text",
  "sequence": 1,
  "inactive": true,
  "created_at": "text",
  "updated_at": "text"
}

get

List out-of-order/out-of-service reasons for a site.

Path parameters

siteIdstringRequired

Query parameters

include_inactivebooleanOptionalDefault: false

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

typestring · enumRequiredPossible values:

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

get/sites/{siteId}/out-of-order-reasons

HTTPcURLJavaScriptPython

GET /sites/{siteId}/out-of-order-reasons HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

[
  {
    "_id": "text",
    "site": "text",
    "code": "text",
    "description": "text",
    "sequence": 1,
    "type": "out_of_order",
    "inactive": true,
    "created_at": "text",
    "updated_at": "text"
  }
]

post

Create a new out-of-order reason for a site.

Path parameters

siteIdstringRequired

Body

application/json

codestring · max: 16Required

descriptionstringRequired

sequencenumberOptionalDefault: 0

typestring · enumRequiredPossible values:

inactivebooleanOptionalDefault: false

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

typestring · enumRequiredPossible values:

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

post/sites/{siteId}/out-of-order-reasons

HTTPcURLJavaScriptPython

POST /sites/{siteId}/out-of-order-reasons HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "code": "text",
  "description": "text",
  "sequence": 0,
  "type": "out_of_order",
  "inactive": false
}

200

Default Response

{
  "_id": "text",
  "site": "text",
  "code": "text",
  "description": "text",
  "sequence": 1,
  "type": "out_of_order",
  "inactive": true,
  "created_at": "text",
  "updated_at": "text"
}

delete

Delete an out-of-order reason.

Path parameters

siteIdstringRequired

reasonIdstringRequired

Responses

200

Default Response

application/json

_idstringRequired

deletedbooleanRequired

delete/sites/{siteId}/out-of-order-reasons/{reasonId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/out-of-order-reasons/{reasonId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "deleted": true
}

patch

Update an out-of-order reason. Code is immutable and cannot be changed.

Path parameters

siteIdstringRequired

reasonIdstringRequired

Body

application/json

descriptionstringOptional

sequencenumberOptional

typestring · enumOptionalPossible values:

inactivebooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

typestring · enumRequiredPossible values:

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

patch/sites/{siteId}/out-of-order-reasons/{reasonId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/out-of-order-reasons/{reasonId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "description": "text",
  "sequence": 1,
  "type": "out_of_order",
  "inactive": true
}

200

Default Response

{
  "_id": "text",
  "site": "text",
  "code": "text",
  "description": "text",
  "sequence": 1,
  "type": "out_of_order",
  "inactive": true,
  "created_at": "text",
  "updated_at": "text"
}

post

Resolve a list of identifiers (student IDs and/or emails) to people in the site's tenant. Used by the bulk booking paste/upload flow to map raw input to person records.

Path parameters

siteIdstringRequired

Body

application/json

identifiersstring[] · min: 1 · max: 2000Required

Responses

200

Default Response

No content

post/sites/{siteId}/people/resolve

HTTPcURLJavaScriptPython

POST /sites/{siteId}/people/resolve HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "identifiers": [
    "text"
  ]
}

200

Default Response

No content

post

Create a new priority for a site.

Path parameters

siteIdstringRequired

Body

application/json

namestringRequired

colourstringRequired

notifybooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

created_atstringRequired

updated_atstringRequired

notifybooleanRequired

post/sites/{siteId}/priorities

HTTPcURLJavaScriptPython

POST /sites/{siteId}/priorities HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "colour": "text",
  "notify": true
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text",
  "notify": true
}

delete

Remove a priority from a site. Reassigns incidents if needed, archives or fully deletes.

Path parameters

siteIdstringRequired

priorityIdstringRequired

Body

application/json

reassign_tostringOptional

permanentbooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

archived_sitesstring[]Optional

created_atstringOptional

updated_atstringOptional

notifybooleanOptional

deletedbooleanOptional

archivedbooleanOptional

409

Default Response

application/json

delete/sites/{siteId}/priorities/{priorityId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/priorities/{priorityId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "reassign_to": "text",
  "permanent": true
}

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "archived_sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text",
  "notify": true,
  "deleted": true,
  "archived": true
}

patch

Update a priority for a site.

Path parameters

siteIdstringRequired

priorityIdstringRequired

Body

application/json

namestringRequired

colourstringRequired

notifybooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

created_atstringRequired

updated_atstringRequired

notifybooleanRequired

patch/sites/{siteId}/priorities/{priorityId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/priorities/{priorityId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "colour": "text",
  "notify": true
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text",
  "notify": true
}

post

Restore an archived priority back to a site.

Path parameters

siteIdstringRequired

priorityIdstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

archived_sitesstring[]Optional

created_atstringOptional

updated_atstringOptional

notifybooleanOptional

post/sites/{siteId}/priorities/{priorityId}/restore

HTTPcURLJavaScriptPython

POST /sites/{siteId}/priorities/{priorityId}/restore HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "archived_sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text",
  "notify": true
}

get

Retrieve a site.

Path parameters

siteIdstringRequired

Responses

200

Default Response

application/json

namestringRequired

created_bystringRequired

created_atstringRequired

updated_atstringRequired

incident_tracker_main_location_idstringOptional

photo_urlstringOptional

logo_urlstringOptional

permissionstringRequired

get/sites/{siteId}

HTTPcURLJavaScriptPython

GET /sites/{siteId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "name": "text",
  "created_by": "text",
  "created_at": "text",
  "updated_at": "text",
  "incident_tracker_main_location_id": "text",
  "default_status_pipeline": [
    {
      "_id": "text",
      "key": "text",
      "name": "text",
      "colour": "text",
      "position": 1,
      "is_terminal": true
    }
  ],
  "categories": [
    {
      "_id": "text",
      "name": "text",
      "colour": "text",
      "it_map_string": "text",
      "sites": [
        "text"
      ],
      "archived_sites": [
        "text"
      ],
      "can_delete": true,
      "status_pipeline": [
        {
          "_id": "text",
          "key": "text",
          "name": "text",
          "colour": "text",
          "position": 1,
          "is_terminal": true
        }
      ]
    }
  ],
  "sources": [
    {
      "_id": "text",
      "name": "text",
      "colour": "text",
      "sites": [
        "text"
      ],
      "archived_sites": [
        "text"
      ],
      "can_delete": true
    }
  ],
  "priorities": [
    {
      "_id": "text",
      "name": "text",
      "colour": "text",
      "archived": true,
      "notify": true,
      "sites": [
        "text"
      ],
      "archived_sites": [
        "text"
      ],
      "can_delete": true
    }
  ],
  "archived_categories": [
    {
      "_id": "text",
      "name": "text",
      "colour": "text",
      "it_map_string": "text",
      "sites": [
        "text"
      ],
      "archived_sites": [
        "text"
      ]
    }
  ],
  "archived_sources": [
    {
      "_id": "text",
      "name": "text",
      "colour": "text",
      "sites": [
        "text"
      ],
      "archived_sites": [
        "text"
      ],
      "can_delete": true
    }
  ],
  "archived_priorities": [
    {
      "_id": "text",
      "name": "text",
      "colour": "text",
      "archived": true,
      "notify": true,
      "sites": [
        "text"
      ],
      "archived_sites": [
        "text"
      ]
    }
  ],
  "flag_types": [
    {
      "_id": "text",
      "name": "text",
      "colour": "text",
      "sites": [
        "text"
      ],
      "archived_sites": [
        "text"
      ],
      "can_delete": true
    }
  ],
  "welfare_states": [
    {
      "_id": "text",
      "name": "text",
      "colour": "text",
      "sites": [
        "text"
      ],
      "archived_sites": [
        "text"
      ],
      "can_delete": true
    }
  ],
  "archived_flag_types": [
    {
      "_id": "text",
      "name": "text",
      "colour": "text",
      "sites": [
        "text"
      ],
      "archived_sites": [
        "text"
      ],
      "can_delete": true
    }
  ],
  "archived_welfare_states": [
    {
      "_id": "text",
      "name": "text",
      "colour": "text",
      "sites": [
        "text"
      ],
      "archived_sites": [
        "text"
      ],
      "can_delete": true
    }
  ],
  "incident_forms": [
    {
      "_id": "text",
      "name": "text",
      "site": "text",
      "categories": [
        "text"
      ],
      "fields": [
        {
          "_id": "text",
          "label": "text",
          "field_type": "text",
          "required": true,
          "options": [
            "text"
          ],
          "order": 1
        }
      ],
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "photo_url": "text",
  "logo_url": "text",
  "permission": "text"
}

patch

Update a site.

Path parameters

siteIdstringRequired

Body

application/json

namestringRequired

photo_urlstringOptional

logo_urlstringOptional

incident_tracker_main_location_idstringOptional

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

photo_urlstringOptional

logo_urlstringOptional

created_bystringRequired

created_atstringRequired

updated_atstringRequired

incident_tracker_main_location_idstringOptional

patch/sites/{siteId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "name": "text",
  "photo_url": "text",
  "logo_url": "text",
  "incident_tracker_main_location_id": "text"
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "photo_url": "text",
  "logo_url": "text",
  "created_by": "text",
  "created_at": "text",
  "updated_at": "text",
  "incident_tracker_main_location_id": "text"
}

get

List room move reasons for a site.

Path parameters

siteIdstringRequired

Query parameters

include_inactivebooleanOptionalDefault: false

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

get/sites/{siteId}/room-move-reasons

HTTPcURLJavaScriptPython

GET /sites/{siteId}/room-move-reasons HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

[
  {
    "_id": "text",
    "site": "text",
    "code": "text",
    "description": "text",
    "sequence": 1,
    "inactive": true,
    "created_at": "text",
    "updated_at": "text"
  }
]

post

Create a new room move reason for a site.

Path parameters

siteIdstringRequired

Body

application/json

codestring · max: 16Required

descriptionstringRequired

sequencenumberOptionalDefault: 0

inactivebooleanOptionalDefault: false

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

post/sites/{siteId}/room-move-reasons

HTTPcURLJavaScriptPython

POST /sites/{siteId}/room-move-reasons HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "code": "text",
  "description": "text",
  "sequence": 0,
  "inactive": false
}

200

Default Response

{
  "_id": "text",
  "site": "text",
  "code": "text",
  "description": "text",
  "sequence": 1,
  "inactive": true,
  "created_at": "text",
  "updated_at": "text"
}

delete

Delete a room move reason.

Path parameters

siteIdstringRequired

reasonIdstringRequired

Responses

200

Default Response

application/json

_idstringRequired

deletedbooleanRequired

delete/sites/{siteId}/room-move-reasons/{reasonId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/room-move-reasons/{reasonId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "deleted": true
}

patch

Update a room move reason. Code is immutable and cannot be changed.

Path parameters

siteIdstringRequired

reasonIdstringRequired

Body

application/json

descriptionstringOptional

sequencenumberOptional

inactivebooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

sitestringOptional

codestringRequired

descriptionstringRequired

sequencenumberRequired

inactivebooleanRequired

created_atstringOptional

updated_atstringOptional

patch/sites/{siteId}/room-move-reasons/{reasonId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/room-move-reasons/{reasonId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "description": "text",
  "sequence": 1,
  "inactive": true
}

200

Default Response

{
  "_id": "text",
  "site": "text",
  "code": "text",
  "description": "text",
  "sequence": 1,
  "inactive": true,
  "created_at": "text",
  "updated_at": "text"
}

post

Create a new source for a site.

Path parameters

siteIdstringRequired

Body

application/json

namestringRequired

colourstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

created_atstringRequired

updated_atstringRequired

post/sites/{siteId}/sources

HTTPcURLJavaScriptPython

POST /sites/{siteId}/sources HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "colour": "text"
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text"
}

delete

Remove a source from a site. Reassigns incidents if needed, archives or fully deletes.

Path parameters

siteIdstringRequired

sourceIdstringRequired

Body

application/json

reassign_tostringOptional

permanentbooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

archived_sitesstring[]Optional

created_atstringOptional

updated_atstringOptional

deletedbooleanOptional

archivedbooleanOptional

409

Default Response

application/json

delete/sites/{siteId}/sources/{sourceId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/sources/{sourceId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "reassign_to": "text",
  "permanent": true
}

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "archived_sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text",
  "deleted": true,
  "archived": true
}

patch

Update a source for a site.

Path parameters

siteIdstringRequired

sourceIdstringRequired

Body

application/json

namestringRequired

colourstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

created_atstringRequired

updated_atstringRequired

patch/sites/{siteId}/sources/{sourceId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/sources/{sourceId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "colour": "text"
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text"
}

post

Restore an archived source back to a site.

Path parameters

siteIdstringRequired

sourceIdstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

archived_sitesstring[]Optional

created_atstringOptional

updated_atstringOptional

post/sites/{siteId}/sources/{sourceId}/restore

HTTPcURLJavaScriptPython

POST /sites/{siteId}/sources/{sourceId}/restore HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "archived_sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text"
}

get

Get the site default status pipeline.

Path parameters

siteIdstringRequired

Responses

200

Default Response

No content

get/sites/{siteId}/status-pipeline

HTTPcURLJavaScriptPython

GET /sites/{siteId}/status-pipeline HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

No content

patch

Update the site default status pipeline.

Path parameters

siteIdstringRequired

Body

application/json

Responses

200

Default Response

No content

patch/sites/{siteId}/status-pipeline

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/status-pipeline HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "statuses": [
    {
      "_id": "text",
      "key": "text",
      "name": "text",
      "colour": "text",
      "position": 1,
      "is_terminal": true
    }
  ]
}

200

Default Response

No content

patch

Set or clear a site-specific category status pipeline override.

Path parameters

siteIdstringRequired

categoryIdstringRequired

Body

application/json

Responses

200

Default Response

No content

patch/sites/{siteId}/categories/{categoryId}/status-pipeline

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/categories/{categoryId}/status-pipeline HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "statuses": [
    {
      "_id": "text",
      "key": "text",
      "name": "text",
      "colour": "text",
      "position": 1,
      "is_terminal": true
    }
  ]
}

200

Default Response

No content

post

Create a new welfare state for a site.

Path parameters

siteIdstringRequired

Body

application/json

namestringRequired

colourstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

created_atstringRequired

updated_atstringRequired

post/sites/{siteId}/welfare-states

HTTPcURLJavaScriptPython

POST /sites/{siteId}/welfare-states HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "colour": "text"
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text"
}

delete

Remove a welfare state from a site. Archives or fully deletes.

Path parameters

siteIdstringRequired

welfareStateIdstringRequired

Body

application/json

permanentbooleanOptional

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

archived_sitesstring[]Optional

created_atstringOptional

updated_atstringOptional

deletedbooleanOptional

archivedbooleanOptional

delete/sites/{siteId}/welfare-states/{welfareStateId}

HTTPcURLJavaScriptPython

DELETE /sites/{siteId}/welfare-states/{welfareStateId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "permanent": true
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "archived_sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text",
  "deleted": true,
  "archived": true
}

patch

Update a welfare state for a site.

Path parameters

siteIdstringRequired

welfareStateIdstringRequired

Body

application/json

namestringRequired

colourstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

created_atstringRequired

updated_atstringRequired

patch/sites/{siteId}/welfare-states/{welfareStateId}

HTTPcURLJavaScriptPython

PATCH /sites/{siteId}/welfare-states/{welfareStateId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "colour": "text"
}

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text"
}

post

Restore an archived welfare state back to a site.

Path parameters

siteIdstringRequired

welfareStateIdstringRequired

Responses

200

Default Response

application/json

_idstringRequired

namestringRequired

colourstringRequired

sitesstring[]Optional

archived_sitesstring[]Optional

created_atstringOptional

updated_atstringOptional

post/sites/{siteId}/welfare-states/{welfareStateId}/restore

HTTPcURLJavaScriptPython

POST /sites/{siteId}/welfare-states/{welfareStateId}/restore HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

{
  "_id": "text",
  "name": "text",
  "colour": "text",
  "sites": [
    "text"
  ],
  "archived_sites": [
    "text"
  ],
  "created_at": "text",
  "updated_at": "text"
}