---
title: "Get progress status for the recipient"
method: GET
path: "/v2/pathways/{id}/recipient-progress"
tags: ["Pathways"]
---

# Get progress status for the recipient

`GET /v2/pathways/{id}/recipient-progress`

## Path parameters

- `id` string, required

## Query parameters

- `recipientIdentifier` string, required

## Response `200`

OK

- V2PathwayRecipientProgress
  - `calculationInfo` V2PathwayProgressCalculationInfo, required
    - `computedDate` string, date-time, nullable
    - `computedPublishedStructureVersion` integer, nullable
    - `computedVersion` integer, nullable
    - `stale` boolean, required
    - `staleBeforeVersion` integer, required
  - `id` string, required
  - `pathwayId` string, required
  - `progress` V2Progress — Describes progress of the recipient. Might be missing if progress was not calculated yet.
    - `elementProgress` object, required — Progress by element ID
    - `endProgress` V2PathwayEndProgress, required
      - `completed` integer, required — Number of completed elements by the learner
      - `failed` integer, required — Number of failed elements by the learner
      - `inProgress` integer, required — Number of in-progress elements by the learner
      - `notStarted` integer, required — Number of elements that have not been started yet by the learner
      - `required` integer, required — Number of required elements on the pathway excluding root.
      - `status` 'COMPLETED' | 'FAILED' | 'IN_PROGRESS' | 'NOT_STARTED', required — End status of the pathway. Note: status might be COMPLETED without completing all required elements if it contains "2 out of 3" type of condition(s) for pre-requisite steps.
  - `scope` Recipient, required
    - `@type` 'recipient'
    - `identifier` union, required
      - Email
        - `@type` 'email', required
        - `email` string, required
      - Telephone
        - `@type` 'telephone', required
        - `telephone` string, required
      - Url
        - `@type` 'url', required
        - `url` string, required

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/instructure/apis/public-api-docs.md) · [All operations](https://skmtc.net/instructure/apis/public-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instructure/public-api-docs/revisions/44eb39b4bd65/schema)