Retrieve worker's actionable journeys

GET

/engage/learning/actionable-journeys

GET

/rest/engage/learning/actionable-journeys

curl -G https://api.letsdeel.com/rest/engage/learning/actionable-journeys \
     -H "Authorization: Bearer <token>" \
     -d cursor=eyJvZmZzZXQiOjF9 \
     -d journey_assignment_ids=c765c265-f7c9-41b1-832a-c70fd25b3582 \
     -d journey_ids=985aa5c1-00f0-49a2-ac30-9be1489ecd8d \
     -d limit=50

{
  "data": [
    {
      "step": {
        "id": "54463680-7653-4f99-a87e-efa43d6290c0",
        "journey": {
          "id": "69c18d4d-3428-4ebf-96a8-9445c0bbd9ab",
          "title": "Health and Safety Training"
        },
        "journey_id": "69c18d4d-3428-4ebf-96a8-9445c0bbd9ab"
      },
      "journey": {
        "id": "69c18d4d-3428-4ebf-96a8-9445c0bbd9ab",
        "title": "Health and Safety Training",
        "type_slug": "default",
        "created_at": "2025-02-13T13:25:01.371Z",
        "updated_at": "2025-04-15T16:18:19.928Z",
        "description": "Welcome to Deel's Health and Safety course.",
        "is_template": false,
        "draft_for_id": "d0fe1c70-aa70-48fa-971a-db805b1ea66d",
        "published_at": "2025-02-05T10:37:26.368Z",
        "is_time_based": false,
        "organization_id": 166431,
        "visibility_slug": "private-marketplace",
        "recently_edited_at": "2025-02-05T10:37:26.361Z",
        "is_visible_in_library": false,
        "is_self_assignment_allowed": false,
        "created_by_hris_organization_user_profile": {
          "type": "CLIENT",
          "email": "mary.crist@private.com",
          "country": "DE",
          "pic_url": "https://avatars.githubusercontent.com/u/67282049?s=200&v=4",
          "job_title": "Software Engineer",
          "last_name": "Crist",
          "first_name": "Mary",
          "work_email": "mary.crist@workplace.com",
          "deactivated_at": "2025-02-13T13:25:01.371Z",
          "preferred_name": "Mary Crist",
          "organization_public_id": "84352093-cbe1-48f7-92ca-1f4bdb07b76f",
          "hris_organization_user_id": "fe5473e1-f6ff-45bf-b7bb-c8e44a225de7"
        },
        "updated_by_hris_organization_user_profile": {
          "type": "CLIENT",
          "email": "mary.crist@private.com",
          "country": "DE",
          "pic_url": "https://avatars.githubusercontent.com/u/67282049?s=200&v=4",
          "job_title": "Software Engineer",
          "last_name": "Crist",
          "first_name": "Mary",
          "work_email": "mary.crist@workplace.com",
          "deactivated_at": "2025-02-13T13:25:01.371Z",
          "preferred_name": "Mary Crist",
          "organization_public_id": "84352093-cbe1-48f7-92ca-1f4bdb07b76f",
          "hris_organization_user_id": "fe5473e1-f6ff-45bf-b7bb-c8e44a225de7"
        },
        "cover_picture": {
          "id": "0127f9ba-e6f7-478d-8dc0-619fda871628",
          "url": "https://picsum.photos/seed/picsum/200/300",
          "file_name": "health-and-safety.png",
          "attachable_id": "69c18d4d-3428-4ebf-96a8-9445c0bbd9ab",
          "attachable_type": "Journey",
          "file_content_type": "image/jpeg",
          "attachment_type_slug": "cover_picture"
        }
      },
      "scopeable": {
        "id": "0db4a31b-dce1-4ad6-8dcb-a1178b4add22",
        "is_self_assigned": false,
        "assignee_hris_organization_user": {
          "type": "WORKER",
          "email": "thomas.howel@private.com",
          "country": "DE",
          "pic_url": "https://avatars.githubusercontent.com/u/67282049?s=200&v=4",
          "job_title": "Software Engineer",
          "last_name": "Thomas",
          "first_name": "Howell",
          "work_email": "thomas.howe@privatel.com",
          "deactivated_at": "2025-02-13T13:25:01.371Z",
          "preferred_name": "Thomas Howell",
          "organization_public_id": "e24787df-a7ac-4d01-88a0-6aabeb187692",
          "hris_organization_user_id": "72b997c0-39ce-4f02-92e6-040fd5131d56"
        }
      },
      "completion": {
        "percentage": 37.5
      },
      "recipientable": {
        "type": "WORKER",
        "email": "thomas.howel@private.com",
        "country": "DE",
        "pic_url": "https://avatars.githubusercontent.com/u/67282049?s=200&v=4",
        "job_title": "Software Engineer",
        "last_name": "Howell",
        "first_name": "Thomas",
        "work_email": "thomas.howell@test.com",
        "deactivated_at": "2025-02-13T13:25:01.371Z",
        "preferred_name": "Thomas Howell",
        "organization_public_id": "e24787df-a7ac-4d01-88a0-6aabeb187692",
        "hris_organization_user_id": "72b997c0-39ce-4f02-92e6-040fd5131d56"
      },
      "actionable_path": "/learning/actionable-journeys/75d7c4ad-dc7c-4dab-8031-2f5802c02b07/recipient-step-redirection?scopeableId=f43974d7-2ba2-41ae-b45f-f3c9fcf51502&scopeableType=Assignment",
      "recipient_setting_type": "hris_organization_user",
      "total_journey_steps_count": 5,
      "completed_journey_steps_count": 3,
      "recipient_setting_dynamic_role_id": "0127f9ba-e6f7-478d-8dc0-619fda871628",
      "recipient_setting_dynamic_role_name": "Accounts Lead"
    }
  ],
  "next_cursor": "eyJvZmZzZXQiOjAsImxpbWl0IjpudWxsLCJzY29wZSI6bnVsbH0"
}

Retrieves the actionable journeys assigned to the authenticated worker. Use it to build a learning dashboard for the worker or to drive reminders for their journeys.

Token scopes: worker:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.deel.training/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

journey_idslist of stringsOptional

Filter by Journey IDs.

journey_assignment_idslist of stringsOptional

Filter by JourneyAssignment IDs.

limitintegerOptional1-100Defaults to 50

Return a page of results with given number of records.

cursorstringOptional

Cursor to the next page of results. If not provided, the first page will be returned.

Response

Successful retrieval of actionable journeys

datalist of objects

next_cursorstring or null

Cursor to fetch the next page of results. Null if no more pages.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error