API referenceInspection frequencies
Retrieve an inspection frequency
Returns one of your inspection frequencies.
GET
ApiKeyheader
AuthorizationBearer <token>Your organisation's API key. Send it as Authorization: Bearer <key>. Create one in the Scannable admin under Settings → API keys.
frequency_id*stringThe freq_… identifier of one of your inspection frequencies.
The requested inspection frequency.
application/json- response
id*stringThe inspection frequency identifier you use to address it in the API.
name*stringThe name of the inspection frequency.
interval*How often an inspection falls due.
type*stringThe kind of inspection that falls due: thorough or general.
Value in
"thorough""general"status*stringactive, or paused while it raises no new due dates for its items.
Value in
"active""paused"created_at*stringWhen the inspection frequency was created (ISO 8601).
updated_at*stringWhen the inspection frequency was last changed (ISO 8601).
Example Request
curl -X GET 'https://api.scannable.io/v1/inspection-frequencies/freq_fu760equhw69jld'Example response
{ "id": "freq_fu760equhw69jld", "name": "6-monthly thorough", "interval": { "quantity": 6, "unit": "months" }, "type": "thorough", "status": "active", "created_at": "2025-01-09T12:00:00.000Z", "updated_at": "2025-01-09T12:00:00.000Z"}