Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Encore

List Book copy jobs

This API retrieves a list of <glossary:Book> copy jobs and their details. By default, it returns outbound jobs—requests your organization sent. You can also fetch inbound jobs—requests sent to your organization.

📘 Note This API is intended for small and medium business (SMB) funders.

get/v1/book/copy-jobs

Query parameters

job_type'OUTBOUND' | 'INBOUND'

Type of job to retrieve. By default, the API returns OUTBOUND jobs. The available options are:

  • OUTBOUND: Books you're sending to others.
  • INBOUND: Books others are sending to you.
org_uuidstring uuid

A unique identifier (UUID) of the organization.

offsetinteger

The starting point (number of records to skip) from the latest record to fetch results.

limitinteger

The maximum number of records to be fetched starting from the specified offset value.

Response

Success

totalinteger

Total number of copy jobs.

offsetinteger

The starting index of the result.

limitinteger

The maximum number of transactions returned per page starting from the specified offset value.

Example response

{
  "copy_jobs": [
    {
      "job_id": "1234abcd-5678-90ef-1234-567890abcdef",
      "book_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "org_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "IN_PROGRESS",
      "created_ts": "2025-01-15T10:30:00Z",
      "shared_book_label": "Recipient_Label_1"
    }
  ],
  "total": 42,
  "limit": 50
}