Inspectr

REST API

Integrate inspections into your property stack

Create templates, assign inspections, invite members, and pull reports with a workspace API key. Responses use { data, meta? } on success and { error: { code, message } } on failure.

Authentication

Create a key in Settings → API, then send it on every request. Keys are shown once. Rotate from the same screen when a secret leaks.

Headers

authorizationString
Set value to Bearer isk_<prefix>_<secret>.
content-typeString
Set value to application/json.
x-workspace-idString
Optional. Keys are already workspace-bound.

Sample request

GET /api/workspace
Authorization: Bearer isk_<prefix>_<secret>
Content-Type: application/json
X-Workspace-Id: <workspace-uuid>

Workspace

Read or update the workspace bound to the API key.

Current workspace name, slug, role, and contact fields.

Response

idUUID
Required
nameString
Required
slugString
Required
organisationTypeString
May be null
registrationNumberString
May be null
contactEmailString
May be null
timezoneString
Required
countryCodeString
Required
roleString
One of owner, admin, programme_manager, reviewer, field_agent, property_representative
canManageBoolean
Required
agentBillingEnabledBoolean
Required
billingEnabledBoolean
Required
GET/api/workspace

Sample request

GET /api/workspace
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "Acme Inspections",
    "slug": "acme-inspections",
    "organisationType": "agency",
    "registrationNumber": "2020/123456/07",
    "contactEmail": "ops@example.co.za",
    "timezone": "Africa/Johannesburg",
    "countryCode": "ZA",
    "role": "owner",
    "canManage": true,
    "agentBillingEnabled": true,
    "billingEnabled": true
  }
}

Update name, organisation type, registration number, contact email, or agent billing.

Body parameters

nameString
Required
organisationTypeString
Optional
registrationNumberString
Optional
contactEmailString
Optional
agentBillingEnabledBoolean
Optional

Response

idUUID
Required
nameString
Required
slugString
Required
organisationTypeString
May be null
registrationNumberString
May be null
contactEmailString
May be null
timezoneString
Required
countryCodeString
Required
roleString
One of owner, admin, programme_manager, reviewer, field_agent, property_representative
canManageBoolean
Required
agentBillingEnabledBoolean
Required
billingEnabledBoolean
Required
PATCH/api/workspace

Sample request

PATCH /api/workspace
Authorization: Bearer isk_<prefix>_<secret>
Content-Type: application/json

{
  "name": "Acme Inspections",
  "organisationType": "agency",
  "registrationNumber": "2020/123456/07",
  "contactEmail": "ops@example.co.za",
  "agentBillingEnabled": true
}

Sample response

200 Ok

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "Acme Inspections",
    "slug": "acme-inspections",
    "organisationType": "agency",
    "registrationNumber": "2020/123456/07",
    "contactEmail": "ops@example.co.za",
    "timezone": "Africa/Johannesburg",
    "countryCode": "ZA",
    "role": "owner",
    "canManage": true,
    "agentBillingEnabled": true,
    "billingEnabled": true
  }
}

Members

List members and invite new ones by email. Invites send a join link.

Active members plus pending invitations.

Response

membersArray of Object
Required
invitationsArray of Object
Required
currentMemberIdUUID
Required
canManageBoolean
Required
GET/api/workspace/members

Sample request

GET /api/workspace/members
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "members": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "userId": "user_123",
        "name": "Acme Inspections",
        "email": "ops@example.co.za",
        "role": "owner",
        "joinedAt": "2026-08-27T12:00:00.000Z"
      }
    ],
    "invitations": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "email": "ops@example.co.za",
        "role": "owner",
        "expiresAt": "2026-08-27T12:00:00.000Z"
      }
    ],
    "currentMemberId": "11111111-1111-4111-8111-111111111111",
    "canManage": true
  }
}

Invite a member. Role cannot be owner.

Body parameters

emailString
Required
roleString
One of admin, programme_manager, reviewer, field_agent, property_representative

Response

idUUID
Required
emailString
Required
roleString
One of owner, admin, programme_manager, reviewer, field_agent, property_representative
expiresAtDateTime
Required
POST/api/workspace/invitations

Sample request

POST /api/workspace/invitations
Authorization: Bearer isk_<prefix>_<secret>
Content-Type: application/json

{
  "email": "ops@example.co.za",
  "role": "admin"
}

Sample response

200 Ok

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "email": "ops@example.co.za",
    "role": "owner",
    "expiresAt": "2026-08-27T12:00:00.000Z"
  }
}

Programmes and templates

Create a grading programme, then a template with sections and items. Publish locks the version.

List programmes in the workspace.

Response

programmesArray of Object
Required
canManageBoolean
Required
GET/api/programmes

Sample request

GET /api/programmes
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "programmes": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "code": "example",
        "issuer": "example",
        "name": "Acme Inspections",
        "status": "draft",
        "propertyCount": 0,
        "templateCount": 0,
        "primaryTemplateId": "11111111-1111-4111-8111-111111111111",
        "lastUpdatedAt": "2026-08-27T12:00:00.000Z",
        "gradeMix": {
          "a": 0,
          "b": 0,
          "c": 0,
          "fail": 0
        }
      }
    ],
    "canManage": true
  }
}

List templates with draft and published versions.

Response

templatesArray of Object
Required
canManageBoolean
Required
GET/api/templates

Sample request

GET /api/templates
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "templates": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "Acme Inspections",
        "programmeId": "11111111-1111-4111-8111-111111111111",
        "programmeCode": "TSHA",
        "programmeName": "Social Housing Accreditation",
        "draftVersion": 1,
        "publishedVersion": 1,
        "status": "draft",
        "itemCount": 0,
        "updatedAt": "2026-08-27T12:00:00.000Z"
      }
    ],
    "canManage": true
  }
}

Create a template. Set publish to true to lock it in the same request.

Body parameters

programmeIdUUID
Required
nameString
Required
kindString
Optional. One of accreditation, handover
sectionsArray of Object
Optional
publishBoolean
Optional

Response

idUUID
Required
nameString
Required
programmeIdUUID
Required
programmeCodeString
Required
programmeNameString
Required
versionInteger
Required
publishedAtDateTime
May be null
canManageBoolean
Required
totalsObject
Required
gradeBandsArray of Object
Required
sectionsArray of Object
Required
POST/api/templates

Sample request

POST /api/templates
Authorization: Bearer isk_<prefix>_<secret>
Content-Type: application/json

{
  "programmeId": "11111111-1111-4111-8111-111111111111",
  "name": "Acme Inspections",
  "kind": "accreditation",
  "sections": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "title": "Health and safety",
      "items": [
        {
          "id": "11111111-1111-4111-8111-111111111111",
          "label": "Fire extinguisher present",
          "responseType": "pass_fail",
          "points": 0,
          "minPhotos": 0,
          "criticalFail": true,
          "required": true,
          "choiceOptions": [
            "example"
          ]
        }
      ]
    }
  ],
  "publish": false
}

Sample response

200 Ok

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "Acme Inspections",
    "programmeId": "11111111-1111-4111-8111-111111111111",
    "programmeCode": "TSHA",
    "programmeName": "Social Housing Accreditation",
    "version": 1,
    "publishedAt": "2026-08-27T12:00:00.000Z",
    "canManage": true,
    "totals": {
      "items": 0,
      "points": 0,
      "criticalFails": 0
    },
    "gradeBands": [
      {
        "code": "example",
        "label": "Fire extinguisher present",
        "minScore": -9007199254740991,
        "maxScore": -9007199254740991,
        "colour": "example",
        "outcome": "approved"
      }
    ],
    "sections": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "key": "example",
        "title": "Health and safety",
        "order": -9007199254740991,
        "items": [
          {
            "id": "11111111-1111-4111-8111-111111111111",
            "key": "example",
            "label": "Fire extinguisher present",
            "responseType": "pass_fail",
            "required": true,
            "points": -9007199254740991,
            "criticalFail": true,
            "minPhotos": -9007199254740991,
            "choiceOptions": [
              "example"
            ]
          }
        ]
      }
    ]
  }
}

Publish the current draft. Published versions cannot be edited.

Path parameters

idUUID
Required path parameter.

Response

idUUID
Required
nameString
Required
programmeIdUUID
Required
programmeCodeString
Required
programmeNameString
Required
versionInteger
Required
publishedAtDateTime
May be null
canManageBoolean
Required
totalsObject
Required
gradeBandsArray of Object
Required
sectionsArray of Object
Required
POST/api/templates/{id}/publish

Sample request

POST /api/templates/{id}/publish
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "Acme Inspections",
    "programmeId": "11111111-1111-4111-8111-111111111111",
    "programmeCode": "TSHA",
    "programmeName": "Social Housing Accreditation",
    "version": 1,
    "publishedAt": "2026-08-27T12:00:00.000Z",
    "canManage": true,
    "totals": {
      "items": 0,
      "points": 0,
      "criticalFails": 0
    },
    "gradeBands": [
      {
        "code": "example",
        "label": "Fire extinguisher present",
        "minScore": -9007199254740991,
        "maxScore": -9007199254740991,
        "colour": "example",
        "outcome": "approved"
      }
    ],
    "sections": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "key": "example",
        "title": "Health and safety",
        "order": -9007199254740991,
        "items": [
          {
            "id": "11111111-1111-4111-8111-111111111111",
            "key": "example",
            "label": "Fire extinguisher present",
            "responseType": "pass_fail",
            "required": true,
            "points": -9007199254740991,
            "criticalFail": true,
            "minPhotos": -9007199254740991,
            "choiceOptions": [
              "example"
            ]
          }
        ]
      }
    ]
  }
}

Assignments

Assign a published template version to an inspector and a property.

Assignment board: inspectors, due work, and create options.

Response

canManageBoolean
Required
summaryObject
Required
inspectorsArray of Object
Required
assignmentsArray of Object
Required
optionsObject
Required
GET/api/assignments

Sample request

GET /api/assignments
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "canManage": true,
    "summary": {
      "active": 0,
      "overdue": 0,
      "inProgress": 0
    },
    "inspectors": [
      {
        "userId": "user_123",
        "name": "Acme Inspections",
        "role": "example",
        "assignedCount": 0,
        "overdueCount": 0
      }
    ],
    "assignments": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "propertyId": "11111111-1111-4111-8111-111111111111",
        "propertyName": "12 Long Street",
        "street": "12 Long Street",
        "suburb": "Gardens",
        "city": "Cape Town",
        "propertyType": "apartment",
        "inspectionType": "accreditation",
        "inspectorUserId": "user_123",
        "inspectorName": "Thabo Nkosi",
        "programmeCode": "TSHA",
        "templateVersionLabel": "v3",
        "sectionCount": 0,
        "dueAt": "2026-08-27T12:00:00.000Z",
        "status": "draft",
        "boardStatus": "overdue",
        "scorePercentage": -9007199254740991,
        "canUnassign": true,
        "followUpOfId": "11111111-1111-4111-8111-111111111111",
        "unitId": "11111111-1111-4111-8111-111111111111",
        "unitName": "example"
      }
    ],
    "options": {
      "properties": [
        {
          "id": "11111111-1111-4111-8111-111111111111",
          "name": "Acme Inspections",
          "suburb": "Gardens",
          "programmeId": "11111111-1111-4111-8111-111111111111",
          "units": [
            {
              "id": "11111111-1111-4111-8111-111111111111",
              "name": "Acme Inspections"
            }
          ]
        }
      ],
      "programmes": [
        {
          "id": "11111111-1111-4111-8111-111111111111",
          "code": "example",
          "name": "Acme Inspections"
        }
      ],
      "versions": [
        {
          "id": "11111111-1111-4111-8111-111111111111",
          "programmeId": "11111111-1111-4111-8111-111111111111",
          "label": "Fire extinguisher present",
          "isCurrent": true
        }
      ],
      "inspectors": [
        {
          "userId": "user_123",
          "name": "Acme Inspections",
          "role": "example"
        }
      ]
    }
  }
}

Create an assignment. The property must not already have occupying work.

Body parameters

propertyIdUUID
Required
programmeIdUUID
Required
templateVersionIdUUID
Required
assigneeIdString
Required
dueDateDate
Required
unitIdUUID
Optional. May be null

Response

idUUID
Required
propertyIdUUID
Required
propertyNameString
Required
streetString
Required
suburbString
Required
cityString
Required
propertyTypeString
Required
inspectionTypeString
One of accreditation, handover, routine
inspectorUserIdString
Required
inspectorNameString
Required
programmeCodeString
Required
templateVersionLabelString
Required
sectionCountInteger
Required
dueAtDateTime
Required
statusString
One of draft, assigned, in_progress, submitted, under_review, approved, conditionally_approved, remediation_required, rejected, returned, cancelled, expired
boardStatusString
One of overdue, in_progress, assigned, submitted
scorePercentageInteger
May be null
canUnassignBoolean
Required
followUpOfIdUUID
May be null
unitIdUUID
May be null
unitNameString
May be null
POST/api/assignments

Sample request

POST /api/assignments
Authorization: Bearer isk_<prefix>_<secret>
Content-Type: application/json

{
  "propertyId": "11111111-1111-4111-8111-111111111111",
  "programmeId": "11111111-1111-4111-8111-111111111111",
  "templateVersionId": "11111111-1111-4111-8111-111111111111",
  "assigneeId": "user_123",
  "dueDate": "2026-08-27",
  "unitId": "11111111-1111-4111-8111-111111111111"
}

Sample response

200 Ok

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "propertyId": "11111111-1111-4111-8111-111111111111",
    "propertyName": "12 Long Street",
    "street": "12 Long Street",
    "suburb": "Gardens",
    "city": "Cape Town",
    "propertyType": "apartment",
    "inspectionType": "accreditation",
    "inspectorUserId": "user_123",
    "inspectorName": "Thabo Nkosi",
    "programmeCode": "TSHA",
    "templateVersionLabel": "v3",
    "sectionCount": 0,
    "dueAt": "2026-08-27T12:00:00.000Z",
    "status": "draft",
    "boardStatus": "overdue",
    "scorePercentage": -9007199254740991,
    "canUnassign": true,
    "followUpOfId": "11111111-1111-4111-8111-111111111111",
    "unitId": "11111111-1111-4111-8111-111111111111",
    "unitName": "example"
  }
}

Reports

List generated reports. Download uses a short-lived URL when a PDF exists.

Report library for the workspace.

Response

reportsArray of Object
Required
totalInteger
Required
finalisedInteger
Required
GET/api/reports

Sample request

GET /api/reports
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "reports": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "inspectionId": "11111111-1111-4111-8111-111111111111",
        "programmeCode": "TSHA",
        "propertyName": "12 Long Street",
        "gradeCode": "example",
        "gradeLabel": "example",
        "scorePercentage": -9007199254740991,
        "inspectorName": "Thabo Nkosi",
        "reviewerName": "example",
        "datedAt": "2026-08-27T12:00:00.000Z",
        "status": "draft",
        "type": "accreditation",
        "pdfUrl": "https://example.co.za",
        "verificationUrl": "https://example.co.za"
      }
    ],
    "total": 0,
    "finalised": 0
  }
}

HTML preview payload, optional pdfUrl, and verification URL.

Path parameters

idUUID
Required path parameter.

Response

idUUID
Required
inspectionIdUUID
Required
programmeCodeString
Required
propertyNameString
Required
gradeCodeString
Required
gradeLabelString
Required
scorePercentageInteger
Required
inspectorNameString
Required
reviewerNameString
May be null
datedAtDateTime
Required
statusString
One of draft, final
typeString
One of accreditation, inspection, handover
pdfUrlString
May be null
verificationUrlString
Required
programmeNameString
Required
explanationString
Required
sectionsArray of Object
Required
evidenceArray of Object
Required
GET/api/reports/{id}

Sample request

GET /api/reports/{id}
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "inspectionId": "11111111-1111-4111-8111-111111111111",
    "programmeCode": "TSHA",
    "propertyName": "12 Long Street",
    "gradeCode": "example",
    "gradeLabel": "example",
    "scorePercentage": -9007199254740991,
    "inspectorName": "Thabo Nkosi",
    "reviewerName": "example",
    "datedAt": "2026-08-27T12:00:00.000Z",
    "status": "draft",
    "type": "accreditation",
    "pdfUrl": "https://example.co.za",
    "verificationUrl": "https://example.co.za",
    "programmeName": "Social Housing Accreditation",
    "explanation": "Score meets the programme band for a pass.",
    "sections": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "title": "Health and safety",
        "percentage": -9007199254740991,
        "gradeCode": "example",
        "gradeLabel": "example",
        "items": [
          {
            "id": "11111111-1111-4111-8111-111111111111",
            "label": "Fire extinguisher present",
            "points": -9007199254740991,
            "scoreAwarded": -9007199254740991,
            "value": "pass"
          }
        ]
      }
    ],
    "evidence": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "caption": "example",
        "downloadUrl": "https://example.co.za"
      }
    ]
  }
}

API keys

Create, rotate, or revoke keys from Settings or these routes. Rotate invalidates the previous secret immediately.

List keys (masked) and webhook endpoints.

Response

keysArray of Object
Required
endpointsArray of Object
Required
canManageBoolean
Required
GET/api/integrations

Sample request

GET /api/integrations
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "keys": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "Acme Inspections",
        "keyPrefix": "example",
        "masked": "example",
        "lastUsedAt": "2026-08-27T12:00:00.000Z",
        "createdAt": "2026-08-27T12:00:00.000Z"
      }
    ],
    "endpoints": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "url": "example",
        "events": [
          "inspection.assigned"
        ],
        "active": true,
        "createdAt": "2026-08-27T12:00:00.000Z"
      }
    ],
    "canManage": true
  }
}

Create a key. The raw secret is returned once.

Body parameters

nameString
Required

Response

idUUID
Required
nameString
Required
keyPrefixString
Required
maskedString
Required
lastUsedAtDateTime
May be null
createdAtDateTime
Required
rawKeyString
Required
POST/api/integrations/keys

Sample request

POST /api/integrations/keys
Authorization: Bearer isk_<prefix>_<secret>
Content-Type: application/json

{
  "name": "Acme Inspections"
}

Sample response

200 Ok

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "Acme Inspections",
    "keyPrefix": "example",
    "masked": "example",
    "lastUsedAt": "2026-08-27T12:00:00.000Z",
    "createdAt": "2026-08-27T12:00:00.000Z",
    "rawKey": "example"
  }
}

Issue a new secret for the same key. Copy it immediately.

Path parameters

idUUID
Required path parameter.

Response

idUUID
Required
nameString
Required
keyPrefixString
Required
maskedString
Required
lastUsedAtDateTime
May be null
createdAtDateTime
Required
rawKeyString
Required
POST/api/integrations/keys/{id}/rotate

Sample request

POST /api/integrations/keys/{id}/rotate
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "Acme Inspections",
    "keyPrefix": "example",
    "masked": "example",
    "lastUsedAt": "2026-08-27T12:00:00.000Z",
    "createdAt": "2026-08-27T12:00:00.000Z",
    "rawKey": "example"
  }
}

SaaS billing

Workspace subscription and hosted Paystack checkout. Status changes only via webhooks.

Current plan, usage meters, invoices, and lock state.

Response

canManageBoolean
Required
checkoutAvailableBoolean
Required
manageAvailableBoolean
Required
writableBoolean
Required
lockReasonString
May be null. One of subscription_inactive, quota_exceeded
lockMessageString
May be null
statusString
One of trial, complimentary, active, past_due, cancelled
cancelAtPeriodEndBoolean
Required
periodEndLabelString
Required
planCodeString
One of starter, growth, enterprise
planNameString
Required
intervalString
One of monthly, annual
priceLabelString
Required
usageArray of Object
Required
invoicesArray of Object
Required
GET/api/saas/subscription

Sample request

GET /api/saas/subscription
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "canManage": true,
    "checkoutAvailable": true,
    "manageAvailable": true,
    "writable": true,
    "lockReason": "subscription_inactive",
    "lockMessage": "example",
    "status": "trial",
    "cancelAtPeriodEnd": true,
    "periodEndLabel": "example",
    "planCode": "starter",
    "planName": "example",
    "interval": "monthly",
    "priceLabel": "example",
    "usage": [
      {
        "label": "Fire extinguisher present",
        "usedLabel": "example",
        "ratio": 0
      }
    ],
    "invoices": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "dateLabel": "example",
        "planName": "example",
        "amountLabel": "example",
        "status": "pending",
        "hostedUrl": "https://example.co.za"
      }
    ]
  }
}

Start hosted Paystack checkout for Starter or Growth. Does not mark the workspace paid.

Body parameters

planCodeString
One of starter, growth
intervalString
One of monthly, annual

Response

authorizationUrlString
Required
POST/api/saas/checkout

Sample request

POST /api/saas/checkout
Authorization: Bearer isk_<prefix>_<secret>
Content-Type: application/json

{
  "planCode": "starter",
  "interval": "monthly"
}

Sample response

200 Ok

{
  "data": {
    "authorizationUrl": "https://example.co.za"
  }
}

Paystack customer portal URL to update the card or cancel.

Response

manageUrlString
Required
POST/api/saas/manage-link

Sample request

POST /api/saas/manage-link
Authorization: Bearer isk_<prefix>_<secret>

Sample response

200 Ok

{
  "data": {
    "manageUrl": "https://example.co.za"
  }
}

Create a workspace key in Settings → API after you sign in.

Start free