# List a job's results as they complete

Jobs

GET `/v1/jobs/{id}/results`

The job's results in the order they completed, cursor-paged: one per page an item fetched (a single-item endpoint has one page), and one with the item's final status when it ended without a result (canceled, expired). `result` is exactly the synchronous response's envelope, `error` exactly its error object. Results of a running job can be read as they arrive: keep the last `page.next_cursor` and continue from it. Kept `results_retention_s` (7 days) after the job ends. Free.

**Auth:** an API key with the `jobs` scope, or the dashboard session.

**Test mode:** A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.

## Example

cURL:

```shell
curl 'https://staging.socialtap.dev/v1/jobs/<id>/results' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

## Authorizations

`x-api-key`stringheaderrequired

Your API key, with the `jobs` scope. [Authentication](https://staging.socialtap.dev/docs/authentication/index.md)

## Path parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `id` required | `string` | Job ID (job_…). | — |

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `status` optional | `string` | Only results in this status (e.g. failed, to resubmit them).<br>One of `succeeded`, `failed`, `canceled`, `expired` | — |
| `limit` optional | `integer`<br>min 1<br>max 100 | Results per page (default and maximum 100). | — |
| `cursor` optional | `string`<br>max 200 chars | page.next_cursor of the previous page; omit to start from the first result. | — |

## Response

### 200

List a job's results as they complete

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object[]` | This page's items. |
| `data[].completed_at` | `string` (date-time) |  |
| `data[].custom_id` | `string` |  |
| `data[].endpoint` | `string` | One of `facebook.search_ads`, `facebook.transcript`, `instagram.post`, `instagram.profile`, `instagram.transcript`, `tiktok.comments`, `tiktok.post`, `tiktok.posts`, `tiktok.profile`, `tiktok.transcript`, `youtube.comments`, `youtube.post`, `youtube.posts`, `youtube.profile`, `youtube.transcript` |
| `data[].error` | `object` or `null` | Exactly the synchronous error object; null on success and for the job's own cancel or deadline. |
| `data[].error.charged` | `boolean` | Whether the request was charged: always false, failed requests are free. |
| `data[].error.code` | `string` | Machine-readable error code (see the error codes list); stable. |
| `data[].error.details` | `object` | The code's dynamic values (the error codes list documents each code's keys); {} when none. |
| `data[].error.doc_url` | `string` | URL of this code's documentation. |
| `data[].error.message` | `string` | What went wrong and how to fix it, for humans and agents; wording may change. |
| `data[].error.param` | `string` or `null` | The query parameter or header the error is about; null when it is not about one input. |
| `data[].error.remediation` | `string` | What to do about this code, one sentence. |
| `data[].error.request_id` | `string` | Unique request ID; include it when contacting support. |
| `data[].error.retryable` | `boolean` | True when repeating the same request later may succeed (after details.retry_after when present). |
| `data[].error.status` | `integer` | The HTTP status of the response, repeated for clients that only see the body. |
| `data[].object` | `string` | Always job_result.<br>One of `job_result` |
| `data[].page_index` | `integer` | 0 for a single-item endpoint and a list's first page; n for the list's page n+1. |
| `data[].result` | `object` or `null` | Exactly the synchronous success envelope; null unless succeeded. |
| `data[].result.data` | `any` | The endpoint's data: its resource, or a list page's items. |
| `data[].result.meta` | `object` |  |
| `data[].result.page?` | `object` or `null` | List endpoints only. |
| `data[].status` | `string` | The page's outcome; an item's status is its last result's. canceled and expired results carry no result (error says why when it is not the job's cancel or deadline).<br>One of `succeeded`, `failed`, `canceled`, `expired` |
| `data[].status_code` | `integer` or `null` | The HTTP status the synchronous request answered; null when it did not run. |
| `meta` | `object` | The shared route meta (see the API reference introduction). |
| `page` | `object` |  |
| `page.end_reason` | `string` or `null` | Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.<br>One of `end`, `platform_limit`, `max_pages` |
| `page.has_more` | `boolean` | True when another page exists; then next_cursor is set. An empty page with has_more true is not the end. |
| `page.next_cursor` | `string` or `null` | Pass as cursor, with the same other parameters, to get the next page; null at the end. |
| `page.next_cursor_expires_at` | `string` (date-time) or `null` | When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors. |

### 400

400 Bad Request.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | The request parameters are missing or malformed, or the URL is not a supported link for this endpoint. | Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names. |
| `invalid_cursor` | 400 | No | The cursor is malformed, expired, belongs to another endpoint, or the other parameters differ from the request that issued it. | Repeat the original request without cursor to start the list again. |

### 401

401 Unauthorized.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired). | Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url). |

### 403

403 Forbidden.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code. | Do what details.reason says: if suspended, contact [support](https://staging.socialtap.dev/docs/index.md); otherwise use a key whose scopes cover the route (details.required_scope), have the owner confirm the emailed link, create a new key, or call from an allowed IP. |

### 404

404 Not Found.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `job_not_found` | 404 | No | No job with this ID exists for the account: unknown, or past its retention. | Check the job ID; finished jobs are kept for a limited time. |

### 429

429 Too Many Requests.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead. | Wait for the number of seconds in the retry-after header, then retry; ask [support](https://staging.socialtap.dev/docs/index.md) to raise the ceiling if your sustained traffic needs more (calls without an API key: use one). |

## Test mode

A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.

operationId `jobs.results.list`

---

[HTML version](https://staging.socialtap.dev/docs/reference/jobs/results-list/) · [Docs index for AI agents](https://staging.socialtap.dev/llms.txt) · [All docs in one file](https://staging.socialtap.dev/llms-full.txt)
