Response types API

List and retrieve response types (e.g. Pass/Fail, Single select, Number) used in inspection templates. Each type can include options (labels, values, flags). All operations use the same API key as other v1 endpoints and return global or organization-scoped types.

v1

List response types

Returns all response types available to your organization (global and org-specific). Use activeOnly=true to exclude archived or disabled types.

Request

GET /api/v1/response-types
Authorization: Bearer <your_token>

# Optional: exclude archived and disabled
GET /api/v1/response-types?activeOnly=true

Response

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "rt_123",
    "name": "Pass/Fail",
    "description": "Single choice pass or fail",
    "code": "PASS_FAIL",
    "inputType": "SINGLE_SELECT",
    "organizationId": null,
    "icon": "ci-check",
    "uiLabel": "Pass / Fail",
    "isArchived": false,
    "isDisabled": false,
    "inspectionType": "ASSET",
    "createdAt": "2026-01-10T09:00:00.000Z",
    "updatedAt": "2026-01-10T09:00:00.000Z",
    "options": [
      { "id": "opt_1", "label": "Pass", "value": "pass", "position": 0, "raiseFlag": false },
      { "id": "opt_2", "label": "Fail", "value": "fail", "position": 1, "raiseFlag": true }
    ]
  }
]

Get a response type

Returns a single response type by ID. The type must be global or belong to your organization.

Request

GET /api/v1/response-types/{responseTypeId}
Authorization: Bearer <your_token>

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "rt_123",
  "name": "Pass/Fail",
  "description": "Single choice pass or fail",
  "code": "PASS_FAIL",
  "inputType": "SINGLE_SELECT",
  "organizationId": null,
  "icon": "ci-check",
  "uiLabel": "Pass / Fail",
  "isArchived": false,
  "isDisabled": false,
  "inspectionType": "ASSET",
  "createdAt": "2026-01-10T09:00:00.000Z",
  "updatedAt": "2026-01-10T09:00:00.000Z",
  "options": [
    { "id": "opt_1", "label": "Pass", "value": "pass", "position": 0, "raiseFlag": false },
    { "id": "opt_2", "label": "Fail", "value": "fail", "position": 1, "raiseFlag": true }
  ]
}

Response fields

Each response type includes id, name, description, code, inputType, organizationId, icon, uiLabel, isArchived, isDisabled, inspectionType, createdAt, updatedAt, and options (array of label, value, position, raiseFlag, requireNote, etc.).

Rate limits

Same as other v1 APIs (per API key). See Error Handling for details.

Top