PathwayAssignment

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

PathwayAssignment

FieldTypeRequiredDescription
idstring (uuid)yes—
pathway_idstring (uuid)yes—
assignee_kindstringyes

one of "role" | "department" | "organization"

role_idstring (uuid) | nullyes—
role_namestring | nullyes—
department_idstring (uuid) | nullyes

The role's department on a role assignment, the audience itself on a department one (covering departments nested beneath it too), null on an organization one.

department_namestring | nullyes—
created_atstring (date-time)yes—
jsonExample
{
  "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "pathway_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "assignee_kind": "role",
  "role_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "role_name": "string",
  "department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "department_name": "string",
  "created_at": "2026-01-01T00:00:00.000Z"
}