---
title: "Get prompt jobs."
method: GET
path: "/prompt_jobs"
tags: ["Prompt Job"]
---

# Get prompt jobs.

`GET /prompt_jobs`

## Request

- Base URL: `https://tb.paymentfusion.com`
- URL: `https://tb.paymentfusion.com/prompt_jobs`
- Auth: none declared. Required headers: `Authorization`, `Accept`

Called by the Independent Software Vendor. Lists all the prompt jobs in the database for the current organization.

## Query parameters

- `limit` integer
- `offset` integer

## Headers

- `Authorization` string, api_id:api_token, required
- `Accept` string, required

## Response `200`

Success

- object
  - `total` integer: The number of prompt jobs returned.
  - `limit` integer: Specifies the limit of the returned list items. Size range - `1..100`
  - `offset` integer: Specifies the offset of the returned list items. Size range - `0..`
  - `results` PromptJobEntity[]
    - `id` integer: ID of the returned prompt job.
    - `status` string: Status of the returned prompt job. Allowed values - `"in progress"`, `"finalized"`, `"error"`, `"timed out"`, `"canceled"`
    - `created_at` string: Timestamp of when the prompt job was created.
    - `remote_id` string: Optional remote id pertaining to the job.
  - `v` string: The API version that was used to handle the request.

## Other responses

- `4XX`: Possible errors - 1, 189

---

[API](https://skmtc.dev/bankofamerica/apis/transaction-broker-api.md) - [All operations](https://skmtc.dev/bankofamerica/apis/transaction-broker-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bankofamerica/apis/transaction-broker-api/revisions/6097bc689e41?raw)