# FOLIO Jobs API

**Canonical:** https://apis.io/apis/folio/folio-jobs-api/  
**Provider:** FOLIO — https://apis.io/providers/folio/  
**Base URL:** https://folio-snapshot-okapi.dev.folio.org  
**Documentation:** https://s3.amazonaws.com/foliodocs/api/edge-caiasoft/s/edge-caiasoft.html

FOLIO Jobs API is one of 355 APIs that [FOLIO](https://apis.io/providers/folio/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 117 JSON Schema definitions. Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, an API reference, and 117 JSON Schemas.

The Jobs API from FOLIO — 21 operation(s) for jobs.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| GET | `/erm/jobs` | Get a set of persistent job records |
| GET | `/erm/jobs/{jobId}` | Get a specified persistent job record |
| DELETE | `/erm/jobs/{jobId}` | Delete a specified persistent job record. |
| GET | `/erm/jobs/type/{jobType}` | Get a set of persistent job records of the specified type |
| POST | `/erm/jobs/comparison` | Create and queue a comparison job |
| POST | `/erm/jobs/coverageRegeneration` | Create and queue a coverage regeneration job |
| POST | `/erm/jobs/packageImport` | Create and queue a package import job |
| POST | `/erm/jobs/kbartImport` | Create and queue a KBART package import job |
| POST | `/erm/jobs/packageIngest` | Create and queue a package ingest job |
| POST | `/erm/jobs/supplementaryDocumentsCleaning` | Create and queue a supplementary documents cleaning job |
| GET | `/erm/jobs/{jobId}/fullLog` | Get the full (info and error) log for a specified job |
| GET | `/erm/jobs/{jobId}/fullLogStream` | Stream the full (info and error) log for a specified job |
| GET | `/erm/jobs/{jobId}/errorLog` | Get the error-level log entries for a specified job |
| GET | `/erm/jobs/{jobId}/errorLogStream` | Stream the error-level log entries for a specified job |
| GET | `/erm/jobs/{jobId}/infoLog` | Get the info-level log entries for a specified job |
| GET | `/erm/jobs/{jobId}/infoLogStream` | Stream the info-level log entries for a specified job |
| GET | `/erm/jobs/{jobId}/downloadFileObject` | Download the file object attached to a specified job |
| GET | `/jobs` | Get jobs |
| POST | `/jobs` | Upsert job |
| GET | `/jobs/{id}` | Get job by id |
| POST | `/jobs/{id}/resend` | Resend exported file |
| GET | `/jobs/{id}/download` | Download exported file by job id |
| POST | `/jobs/send` | Send job |

## Machine-readable artifacts (285)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/openapi/folio-jobs-api-openapi.yml
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-caiasoft/s/edge-caiasoft.html
- **GitHubRepository** — https://github.com/folio-org/edge-caiasoft
- **Reference** — https://dev.folio.org/reference/api/endpoints/
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-accession-item-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-return-item-response-schema.json
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-courses/s/edge-courses.html
- **GitHubRepository** — https://github.com/folio-org/edge-courses
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-instructors-schema.json
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-dcb/s/edge-dcb.html
- **GitHubRepository** — https://github.com/folio-org/edge-dcb
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-dematic/s/edge-dematic.html
- **GitHubRepository** — https://github.com/folio-org/edge-dematic
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-asr-requests-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-asr-items-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-update-asr-item-schema.json
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-erm/s/edge-erm.html
- **GitHubRepository** — https://github.com/folio-org/edge-erm
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-license-terms-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-license-terms-batch-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-request-ids-schema.json
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-fqm/s/edge-fqm.html
- **GitHubRepository** — https://github.com/folio-org/edge-fqm
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-entity-type-summaries-schema.json
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-ill/s/edge-ill.html
- **GitHubRepository** — https://github.com/folio-org/edge-ill
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-test-document-delivery-offer-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-test-document-delivery-register-schema.json
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-inn-reach/s/edge-inn-reach.html
- **GitHubRepository** — https://github.com/folio-org/edge-inn-reach
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-access-token-response-schema.json
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-inventory/s/edge-inventory.html
- **GitHubRepository** — https://github.com/folio-org/edge-inventory
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-rtac/s/edge-rtac.html
- **GitHubRepository** — https://github.com/folio-org/edge-rtac
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-batch-holdings-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-rtac-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/folio/refs/heads/main/json-schema/folio-instance-holdings-schema.json
- **Documentation** — https://s3.amazonaws.com/foliodocs/api/edge-users/s/edge-users.html
- **GitHubRepository** — https://github.com/folio-org/edge-users
- …and 245 more, listed in full on the page.

## Other FOLIO APIs (12)

- [FOLIO edge-oai-pmh](https://apis.io/apis/folio/edge-oai-pmh/)
- [FOLIO edge-orders](https://apis.io/apis/folio/edge-orders/)
- [FOLIO edge-patron](https://apis.io/apis/folio/edge-patron/)
- [FOLIO folio-custom-fields](https://apis.io/apis/folio/folio-custom-fields/)
- [FOLIO mod-audit](https://apis.io/apis/folio/mod-audit/)
- [FOLIO mod-circulation-storage](https://apis.io/apis/folio/mod-circulation-storage/)
- [FOLIO mod-circulation](https://apis.io/apis/folio/mod-circulation/)
- [FOLIO mod-configuration](https://apis.io/apis/folio/mod-configuration/)
- [FOLIO mod-copycat](https://apis.io/apis/folio/mod-copycat/)
- [FOLIO mod-courses](https://apis.io/apis/folio/mod-courses/)
- [FOLIO mod-data-import](https://apis.io/apis/folio/mod-data-import/)
- [FOLIO mod-di-converter-storage](https://apis.io/apis/folio/mod-di-converter-storage/)

## Tags

Jobs

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/folio/folio-jobs-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/folio/.
