Skip to main content

List Jobs

Loading...
API endpoint path: /v3/jobs

Retrieves a paginated list of import jobs for the authenticated institution. Import jobs are created when participant files are uploaded to an experience group.

Use this endpoint to:

  • View participant import jobs across experience groups.
  • Filter jobs for a specific experience group using groupId.
  • Monitor job status, record counts, and uploaded file details before retrieving job-specific information or error details.

Behavior and capabilities:

  • Supports pagination using the page and size query parameters.
  • Supports sorting through the sort query parameter. Sorting by group.groupName is supported only when groupId is not specified.
  • Returns jobs in content, pagination metadata in page, and navigation links in links.
  • Each job in content includes a self link to the Get Job by ID endpoint.

Request​

Responses​

Success