People

get

List people in a tenant (or in the tenant owning a given site).

Query parameters

tenantstringOptional

sitestringOptional

activebooleanOptional

qstringOptional

limitnumberOptional

skipnumberOptional

Responses

200

Default Response

No content

get

/people

HTTPcURLJavaScriptPython

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

200

Default Response

No content

post

Create a new person (tenant-scoped, unique by student_id within tenant).

Body

application/json

tenantstringRequired

sitestringOptional

first_namestringRequired

last_namestringRequired

student_idstringRequired

emailstringOptional

welfare_flagbooleanOptional

flagsstring[]Optional

welfare_statestringOptional

Responses

200

Default Response

No content

post

/people

HTTPcURLJavaScriptPython

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

{
  "tenant": "text",
  "site": "text",
  "first_name": "text",
  "last_name": "text",
  "student_id": "text",
  "email": "text",
  "welfare_flag": true,
  "flags": [
    "text"
  ],
  "welfare_state": "text"
}

200

Default Response

No content

get

Retrieve a single person with active booking context.

Path parameters

personIdstringRequired

Responses

200

Default Response

No content

get

/people/{personId}

HTTPcURLJavaScriptPython

GET /people/{personId} HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

No content

delete

Archive a person (soft delete).

Path parameters

personIdstringRequired

Query parameters

sitestringRequired

Responses

200

Default Response

No content

delete

/people/{personId}

HTTPcURLJavaScriptPython

DELETE /people/{personId}?site=text HTTP/1.1
Host: api.kitehouse.co.uk
Accept: */*

200

Default Response

No content

patch

Update a person.

Path parameters

personIdstringRequired

Body

application/json

sitestringRequired

first_namestringOptional

last_namestringOptional

emailstringOptional

welfare_flagbooleanOptional

flagsstring[]Optional

welfare_statestring · nullableOptional

activebooleanOptional

Responses

200

Default Response

No content

patch

/people/{personId}

HTTPcURLJavaScriptPython

PATCH /people/{personId} HTTP/1.1
Host: api.kitehouse.co.uk
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "site": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "welfare_flag": true,
  "flags": [
    "text"
  ],
  "welfare_state": null,
  "active": true
}

200

Default Response

No content

get

Unified person search by id / name / email / active booking location.

Query parameters

tenantstringOptional

sitestringOptional

qstringOptional

limitnumberOptional

scopestring · enumOptionalPossible values:

Responses

200

Default Response

No content

get

/people/search

HTTPcURLJavaScriptPython

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

200

Default Response

No content