AvailableJobAid

A request or response body; the type column links to the schemas it refers to.

AvailableJobAid

FieldTypeRequiredDescription
job_aidJobAidyes—
organization_namestringyes—
owner_department_namestring | nullyes—
last_viewed_atstring (date-time) | nullyes

When the caller last opened the aid's page; null before the first time.

view_countintegeryes

How many times the caller has opened the aid's page.

view_supersededbooleanyes

True when the caller's last open predates the aid's recertification cutoff — its content was replaced with recertification required since — so the aid must be opened again for certification. False while no cutoff applies, before the first open, and once an open follows the cutoff.

jsonExample
{
  "job_aid": {
    "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "owner_department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "title": "string",
    "description": "string",
    "body_markdown": "string",
    "audience": "trainees",
    "subjects": [
      {
        "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
        "slug": "string",
        "name": "string"
      }
    ],
    "attachments": [
      {
        "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
        "file_name": "string",
        "content_type": "string",
        "label": "string",
        "position": 0,
        "prefer_inline_display": true
      }
    ],
    "links": [
      {
        "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
        "url": "https://www.osha.gov/powered-industrial-trucks",
        "label": "string",
        "position": 0
      }
    ],
    "recertification_required_at": "2026-01-01T00:00:00.000Z",
    "created_by": "string",
    "created_at": "2026-01-01T00:00:00.000Z",
    "archived_at": "2026-01-01T00:00:00.000Z"
  },
  "organization_name": "string",
  "owner_department_name": "string",
  "last_viewed_at": "2026-01-01T00:00:00.000Z",
  "view_count": 0,
  "view_superseded": true
}