Skip to main content

Get Job by ID

Loading...
API endpoint path: /v3/jobs/{jobId}

Retrieves the status and processing details of a specific import job identified by jobId. Import jobs are created when participant files are uploaded to an experience group.

Use this endpoint to:

  • Monitor the progress of a participant upload after it has been accepted for processing.
  • Review job status, record counts, and processing summary information.
  • Verify whether a job completed successfully before retrieving row-level error details.

Behavior and capabilities:

  • Returns the import job associated with the specified jobId for the authenticated institution.
  • The response includes jobStatus and the upload type (ADD, REMOVE, or REPLACE).
  • When jobStatus is PARTIAL_SUCCESS or FAILED, jobDetails provides a summary such as Partial Success. See detailed report., and row-level errors are available from the Get Job Errors by ID endpoint.

Next Steps:

After a participant upload is accepted, poll this endpoint until jobStatus is no longer CREATED or PROCESSING.

Request​

Responses​

Success