Assessments
Get a list of assessments produced for your organisation or produced by your organisation.
Authorization: Bearer {AuthorizationToken}
10001Comma separated assessment IDs
cllks38mw000131wh9ukgjc4gComma separated property IDs
cksq4ybpq104zwgwh2gd1vvhaComma separated assessment types
See GET /assessments/types
{"value":"cm65bkfml00kpyjwh84eword,cm65bkfml00koyjwhqz38xwa"}For: list assessments produced for your organisation. By: list assessments produced by your organisation
For,ByExample: {"value":"For"}Comma separated assessment statuses
approvedExample: {"value":"inprogress,submitted,approved"}Include assessment flags and their history
false9231GET /assessments HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"total": 9231,
"assessments": [
{
"id": "cllks38mw000131wh9ukgjc4g",
"property": "cksq4ybpq104zwgwh2gd1vvha",
"asset": "cksq4ybpq104zwgwh2gd1vvha",
"forOrganisation": "clkjwoavd00hj99whnsg8prog",
"byOrganisation": "clhracytd002243whodg03shv",
"reference": "RB-ABC123",
"customReference": "MyAseRef0001",
"type": "cm65bkfml00kpyjwh84eword",
"status": "inprogress",
"assessedDate": "2024-01-01",
"approvedDate": "2024-01-03",
"expiryDate": "2025-01-01",
"scheduleCustomReference": "MyAseSchRef0001",
"flags": [
{
"id": "gg00k4cccsokgggggko4scg0",
"name": "Onsite Visit Completed",
"currentState": {
"isSet": true,
"user": "cksq391qt04f60ns0rplhdmpj",
"comment": "I've fully completed the visit now",
"timestamp": "2025-03-05 12:13:00"
},
"history": [
{
"isSet": true,
"user": "cksq391qt04f60ns0rplhdmpj",
"comment": "",
"timestamp": "2025-03-05 10:01:25"
},
{
"isSet": false,
"user": "cksq391qt04f60ns0rplhdmpj",
"comment": "Need to go back for another photo",
"timestamp": "2025-03-05 11:25:01"
},
{
"isSet": true,
"user": "cksq391qt04f60ns0rplhdmpj",
"comment": "I've fully completed the visit now",
"timestamp": "2025-03-05 12:13:53"
}
]
},
{
"id": "i4ssoswwgocggggocgkc4kss",
"name": "Spelling Check",
"currentState": null,
"history": []
}
]
}
],
"organisations": [
[
{
"id": "clkjwoavd00hj99whnsg8prog",
"name": "Kenney Housing",
"address": {
"line1": "9 Plant Lane",
"line2": "",
"city": "London",
"county": "",
"postcode": "TW8 1PL"
}
},
{
"id": "clhracytd002243whodg03shv",
"name": "Brandon Fire Safety",
"address": {
"line1": "",
"line2": "",
"city": "",
"county": "",
"postcode": ""
}
}
]
]
}Authorization: Bearer {AuthorizationToken}
GET /assessments/types HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"types": [
{
"id": "cm65bkfml00koyjwhqz38xwa",
"name": "External Wall Engineer Report",
"isDeleted": false
},
{
"id": "cm65bkfml00kpyjwh84eword",
"name": "Fire Risk Assessment",
"isDeleted": false
}
]
}Get an assessment's report PDF
Authorization: Bearer {AuthorizationToken}
GET /assessments/{assessmentId}/report.pdf HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textGet an assessment's bundle ZIP. This bundle contains: • Report PDF • CSVs of actions, controls, and elements • Assessment attachments • Images and files for actions, controls, and elements
Authorization: Bearer {AuthorizationToken}
GET /assessments/{assessmentId}/bundle.zip HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textAuthorization: Bearer {AuthorizationToken}
10001Comma separated action IDs
cle72jm2q0001pxwhqnf5qfocInclude names and emails of manually assigned users
falseInclude names of manually assigned teams
falseInclude names of categories
falseInclude names of severities
falseInclude names of timescales
falseTotal number of matching actions before pagination
1GET /assessments/{assessmentId}/actions HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"total": 1,
"actions": [
{
"id": "cle72jm2q0001pxwhqnf5qfoc",
"asset": "cksq4ybpq104zwgwh2gd1vvha",
"reference": "RB-ABC123",
"status": null,
"what": "Description of action",
"why": "Why the action is required",
"location": "Location of action",
"category": "ckuqwxk32011i11oooozx3vc2",
"severity": "dkgcscowkkwcwsw0c40c4gcs",
"timescale": "scc4o0wc80800gkwg0cc4sk8",
"assignedTeams": [
{
"id": "cksq3a5ux03nx0ns0jntekwfm",
"manual": true,
"auto": false
}
],
"assignedUsers": [
{
"id": "cliylzuy600010nl44ox1hsqf",
"manual": true,
"auto": false
}
],
"photoIds": [
"cksq3jhl500ga0ls0oiibt7q2"
]
}
],
"users": [
{
"id": "cliylzuy600010nl44ox1hsqf",
"email": "assessor@example.com",
"name": "Alex Taylor"
}
],
"teams": [
{
"id": "cksq3a5ux03nx0ns0jntekwfm",
"name": "Repairs Team"
}
],
"categories": [
{
"id": "ckuqwxk32011i11oooozx3vc2",
"name": "Fire Safety"
}
],
"severities": [
{
"id": "dkgcscowkkwcwsw0c40c4gcs",
"name": "High"
}
],
"timescales": [
{
"id": "scc4o0wc80800gkwg0cc4sk8",
"name": "One Month"
}
]
}Returns the controls recorded in an assessment, whatever the assessment's status. Each assessment returns its own copy of a control, so reviewing a control in a later assessment does not change what earlier assessments return.
Authorization: Bearer {AuthorizationToken}
10001Comma separated control IDs
c250c4a8-61b2-4213-b396-d1c64cb9e3fbInclude names of categories
falseTotal number of matching controls before pagination
1GET /assessments/{assessmentId}/controls HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"total": 1,
"controls": [
{
"id": "c250c4a8-61b2-4213-b396-d1c64cb9e3fb",
"asset": "cksq4ybpq104zwgwh2gd1vvha",
"reference": "RB-ABC123",
"status": "ongoing",
"what": "Description of control",
"why": "Why the control is in place",
"location": "Location of control",
"category": "ckuqwxk32011i11oooozx3vc2",
"photoIds": [
"cksq3jhl500ga0ls0oiibt7q2"
]
}
],
"categories": [
{
"id": "ckuqwxk32011i11oooozx3vc2",
"name": "Fire Safety"
}
]
}Authorization: Bearer {AuthorizationToken}
10001Limit the list by asset type ID or name
Flat Entrance Door,firedoors,cksq3o1qn00j20hs0ayi7qaguLimit the list by asset ID
cksq3o1qn00j10hs07j31i9l1,cmgc4i3ii000108l14r8h3sl7Total number of matching assets before pagination
2Asset types represented by the assets on this page
GET /assessments/{assessmentId}/assets HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"$ref": "#/components/examples/assessmentassets/list"
}Get a list of assessment schedules
Authorization: Bearer {AuthorizationToken}
10001Comma separated property IDs
cksq4ybpq104zwgwh2gd1vvhaUse property instead
Comma separated assessment types
See GET /assessments/types
{"value":"cm65bkfml00kpyjwh84eword,cm65bkfml00koyjwhqz38xwa"}Comma separated schedule statuses
notstarted,inprogressExample: {"value":"notstarted"}Possible values: 1GET /assessments/schedules HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"total": 1,
"schedules": [
{
"property": "cksq4ybpq104zwgwh2gd1vvha",
"asset": "cksq4ybpq104zwgwh2gd1vvha",
"type": "cm65bkfml00kpyjwh84eword",
"status": "notstarted",
"dueDate": "2025-06-01",
"description": "Information for assessment author",
"customReference": "MyAseSchRef0001",
"assignedUsers": [
"cksq4xkxh012173wh9agrq0iz"
]
}
]
}Get a property's assessment schedule for a particular assessment type
Authorization: Bearer {AuthorizationToken}
The schedule's property ID
The schedule's assessment type ID
ID of property this schedule belongs to
Use property instead
See GET /assessments/types
No schedule found
GET /assessments/schedules/{property}/{type} HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"property": "cksq4ybpq104zwgwh2gd1vvha",
"asset": "cksq4ybpq104zwgwh2gd1vvha",
"type": "cm65bkfml00kpyjwh84eword",
"status": "notstarted",
"dueDate": "2025-06-01",
"description": "Information for assessment author",
"customReference": "MyAseSchRef0001",
"assignedUsers": [
"cksq4xkxh012173wh9agrq0iz"
]
}Update a property's assessment schedule if it exists, otherwise create it
Authorization: Bearer {AuthorizationToken}
The schedule's property ID
The schedule's assessment type ID
2025-06-01Information for assessment authorThe schedule's custom reference will appear on the assessment as scheduleCustomReference in GET /assessments
MyAseSchRef0001["cksq4xkxh012173wh9agrq0iz"]PUT /assessments/schedules/{property}/{type} HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 156
{
"dueDate": "2025-06-01",
"description": "Information for assessment author",
"customReference": "MyAseSchRef0001",
"assignedUsers": [
"cksq4xkxh012173wh9agrq0iz"
]
}Delete a property's assessment schedule
Authorization: Bearer {AuthorizationToken}
The schedule's property ID
The schedule's assessment type ID
DELETE /assessments/schedules/{property}/{type} HTTP/1.1
Host: api3.riskbase.uk
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Last updated
Was this helpful?