Jobs

The Jobs APIs provide access to asynchronous import jobs created when participant files are uploaded to an experience group. These APIs enable you to monitor job progress, review processing results, and retrieve detailed error information for failed or partially successful imports.

End-user benefits

• Monitor the status and progress of participant import jobs.
• View success, failure, and processing counts for each job.
• Access detailed row-level error information for failed records.
• List and filter jobs by experience group for operational visibility and troubleshooting.

Integration capabilities

• List import jobs for the authenticated institution, with optional filtering by 'groupId'.
• Retrieve details of a specific import job by 'jobId', including status, record counts, and summary information.
• Retrieve paginated row-level errors for a job using 0-based page and size query parameters (default page size: 20).

Scopes

Scope	Description
groups:read	List import jobs, retrieve job details, and retrieve job errors

Required headers

Header	Description
Authorization	Bearer {token} (OAuth V2)
transactionId	UUID used to trace and correlate requests across services for debugging and logging.

Error codes

Code	Message	HTTP Status Code
2000	'jobId' {jobId} not found	400
2001	additional details may be available in server logs	500
2003	Invalid Authorization	401

Endpoints

List Jobs

Retrieves a paginated list of import jobs for the authenticated institution. Import jobs are

Get Job by ID

Retrieves the status and processing details of a specific import job identified by jobId.

Get Job Errors

Retrieves a paginated list of row-level errors for a specific import job identified by jobId.