# Get bulk job status

Check whether a match prediction bulk update job is queued, running or finished, with its item counts.

- Endpoint: `GET https://api.returning.ai/v1/match-predictions/bulk-jobs/{jobId}`
- Section: Gamification / Match predictions
- Authentication: `Authorization: Bearer <API_KEY>` (Community API key)
- Permission: `matchPredictions` (Shown in the dashboard as "Match Prediction")
- Retries: Read-only; poll with backoff
- Guide: hand-written
- Verified: code, 2026-09-27
- Last updated: 26 Sep 2026
- Web page: https://docs.returning.ai/api-reference/gamification-match-predictions/get-bulk-job-status

## When to use this

- Poll after Bulk update match predictions until the job finishes.
- Show how many items of a batch were applied and how many failed.

**Instead:** Use [Get bulk job results](https://docs.returning.ai/api-reference/gamification-match-predictions/get-bulk-job-results.md) instead to see which items failed and why.

**Availability:** api.returning.ai doesn't serve this route yet: requests return an empty `404`. Ask Returning.AI before you build on it.

## Authentication

- Header: `Authorization: Bearer <API_KEY>`
- Permission: `matchPredictions`

Use a Community API key with `matchPredictions`, shown in the dashboard as Match Prediction, and keep it on your server. The key decides the community: you only see and change match predictions in that community, and you can only read jobs created with a key from that community. Personal API keys are rejected with `403`. A job from another community returns `404`, the same as an unknown ID.

## Behaviour

api.returning.ai doesn't serve this route yet: requests return an empty `404`. Ask Returning.AI before you build on it.

A job moves from `queued` to `processing`, then ends as `completed`, `completed_with_errors` or `failed`. A job that ends `failed` isn't picked up again: read its results, and send the items it didn't reach as a new job. Jobs are kept for 7 days; after that the ID returns `404`.

## Request

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `jobId` | `string` | Yes | The job ID, `operationId` from Bulk update match predictions. (`mpbu_` and 32 hex characters) |

### Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Authorization` | `string` | Yes | Community API key with `matchPredictions`. (`Bearer <API_KEY>`) |
| `X-Request-Id` | `string` | No | Your own ID for this request, returned in `meta.requestId`. Without it, a `req_...` ID is generated. |

### Example request

```bash
curl --request GET \
  --url https://api.returning.ai/v1/match-predictions/bulk-jobs/mpbu_66f00000000000000000000000000802 \
  --header 'Authorization: Bearer <API_KEY>'
```

## Response

A `200` returns the job's state and counts. This endpoint doesn't list items; use Get bulk job results for them.

### Response fields

| Field | Type | Presence | Description |
| --- | --- | --- | --- |
| `meta` | `object` | always | Result details. |
| `meta.status` | `string` | always | Result of the request. (`success`) |
| `meta.statusCode` | `integer` | always | The HTTP status, repeated. |
| `meta.code` | `string` | always | Machine-readable result code. (`MATCH_PREDICTION_BULK_JOB_RETRIEVED`) |
| `meta.requestId` | `string` | always | Your `X-Request-Id` if you sent one, otherwise a generated `req_...` ID. Quote it when you contact support. |
| `message` | `string` | always | Human-readable summary. Do not branch on it. |
| `data` | `object` | always | The job. |
| `data.jobId` | `string` | always | The job ID. |
| `data.type` | `string` | always | Always `bulk_update`. |
| `data.status` | `string` | always | Where the job is. `completed_with_errors` means at least one item failed. `failed` means the job stopped part way: items it reached are applied, the rest are not. (`queued`, `processing`, `completed`, `completed_with_errors` or `failed`) |
| `data.submitted` | `integer` | always | Items in the job. |
| `data.processed` | `integer` | always | Items handled so far. |
| `data.succeeded` | `integer` | always | Items applied. |
| `data.failed` | `integer` | always | Items that failed. |
| `data.createdAt` | `string` | always | When the job was accepted. |
| `data.startedAt` | `string` | always | When the job started. `null` while `queued`. |
| `data.completedAt` | `string` | always | When the job finished. `null` until then, and for a `failed` job. |

### Example response (200)

```json
{
  "meta": {
    "status": "success",
    "statusCode": 200,
    "code": "MATCH_PREDICTION_BULK_JOB_RETRIEVED",
    "requestId": "req_66f00000000000000000000000000811"
  },
  "message": "Bulk job status retrieved.",
  "data": {
    "jobId": "mpbu_66f00000000000000000000000000802",
    "type": "bulk_update",
    "status": "completed_with_errors",
    "submitted": 2,
    "processed": 2,
    "succeeded": 1,
    "failed": 1,
    "createdAt": "2026-09-28T10:00:00.000Z",
    "startedAt": "2026-09-28T10:00:02.000Z",
    "completedAt": "2026-09-28T10:00:03.000Z"
  }
}
```

## Errors

Every error carries its code in `meta.code` and the request's ID in `meta.requestId`. Validation errors list each problem in `details`, with a `field`, `code` and `message`. The API key checks (`401`, `403`, `404 COMMUNITY_NOT_FOUND` and `500 AUTHENTICATION_FAILED`) return `detail` and `solution` instead. A `404` with an empty body means the route isn't available on api.returning.ai yet.

### Fix the request

| Status | Code | What to do |
| --- | --- | --- |
| 404 | - | The body is empty: api.returning.ai doesn't serve this route yet. Ask Returning.AI before you build on it. |
| 401 | `AUTHENTICATION_REQUIRED` | The key is missing, invalid or expired. Send `Authorization: Bearer <API_KEY>` with a current Community API key. |
| 403 | `API_KEY_PERMISSION_DENIED` | The key lacks `matchPredictions`, or it is a personal key. Use a Community API key and add Match Prediction in Settings > Integration > API Keys. |

### Fix the data

| Status | Code | What to do |
| --- | --- | --- |
| 404 | `MATCH_PREDICTION_BULK_JOB_NOT_FOUND` | No job in your community has this ID, or the job is more than 7 days old. Check the `operationId` from Bulk update match predictions. |
| 404 | `COMMUNITY_NOT_FOUND` | The community this key belongs to no longer exists. Contact Returning.AI support. |

### Retry with backoff

| Status | Code | What to do |
| --- | --- | --- |
| 429 | `RATE_LIMITED` | Your community is over its [rate limit](https://docs.returning.ai/how-it-works.md#rate-limits). Wait for the seconds in `Retry-After`, then retry. |
| 500 | `INTERNAL_ERROR` | The job could not be read. Retry with exponential backoff. |
| 500 | `AUTHENTICATION_FAILED` | The key could not be checked. Retry with backoff; nothing changed. |
| 503 | `MATCH_PREDICTION_FROZEN` | Returning.AI has paused match prediction requests. Nothing changed. Retry later with backoff. |

**Retries:** This endpoint is read-only, so polling it is safe. Wait a few seconds between polls, back off as the job runs longer, and stop at a sensible limit. Returning.AI can set a request limit for your community on these endpoints, counted per community and calling IP address. Over it, requests return `429 RATE_LIMITED` with a `Retry-After` header in seconds; wait that long, then retry.

## Next step

- [Get bulk job results](https://docs.returning.ai/api-reference/gamification-match-predictions/get-bulk-job-results.md): `GET /v1/match-predictions/bulk-jobs/{jobId}/results`. Once the job has finished, read each item's result and fix the ones that failed.