Sign in
latestOpenAPI 3.0.12026-08-1091181421.2 KB

44eb39b4bd65

Pathways

Get progress status for the recipient

get/v2/pathways/{id}/recipient-progress

Path parameters

idstring required

Query parameters

recipientIdentifierstring required

Identifier of the recipient, format: recipientType:recipientId

Response

OK

idstring required
pathwayIdstring required

Example response

{
  "id": "61aa04adf5afe00d0a6dac72",
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "progress": {
    "endProgress": {
      "completed": 4,
      "failed": 1,
      "inProgress": 3,
      "notStarted": 2,
      "required": 10
    }
  },
  "scope": {
    "identifier": {
      "email": "mail@example.com"
    }
  }
}