Jobs
Jobs APIs represent asynchronous batch operations associated with experience groups, primarily used for large‑scale participant uploads and updates. They enable safe, trackable processing of bulk user changes.
End-user benefits
- Tracking the status and progress of participant upload jobs
- Viewing success and failure counts for each job execution
- Retrieving detailed error information for failed records
- Listing and filtering jobs by group for operational monitoring
Integration capabilities
- API‑based job monitoring with access to status, success, and failure metrics
- Granular error retrieval endpoints to support retries, remediation, and audits
- Easy integration with automation and admin tools using standard enterprise API patterns
Job statuses
| Status | Description |
|---|---|
CREATED | Queued for processing |
PROCESSING | In progress |
SUCCESSFUL | All records processed |
PARTIAL_SUCCESS | Some failures — use errors endpoint |
FAILED | Job failed — use errors endpoint |
Scopes
| Scope | Description |
|---|---|
groups:read | Read jobs |
Required headers
| Header | Description |
|---|---|
Authorization | Bearer {ACCESS_TOKEN} |
transactionId | UUID (fish tag / tracing) |
Error codes
| Code | Message | HTTP Status Code |
|---|---|---|
| 2000 | e.g. job not found, invalid request | 400 |
| 2001 | Internal server error | 500 |
| 2003 | Invalid authorization | 401 |
Endpoints
Get Job by ID
Retrieves the status and details of a specific job. Use this endpoint to monitor the progress of user
Get Job Errors
Retrieves errors associated with a specific job. Use this endpoint to troubleshoot failed user imports
List Jobs
Retrieves a paginated list of jobs. Jobs represent batch operations such as user imports. Filter by group