FOLIO Reports API

The Reports API from FOLIO — 3 operation(s) for reports.

GitHub OpenAPI

Operations 3

GET /oa/reports/openApcChargesReport Get an open-access charges CSV report #
GET /oa/reports/openApcBpcReport Get a book processing charges CSV report #
GET /oa/reports/openApcTransformativeAgreementReport Get a transformative agreement CSV report #

Documentation

📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-caiasoft/s/edge-caiasoft.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-courses/s/edge-courses.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-dcb/s/edge-dcb.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-dematic/s/edge-dematic.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-erm/s/edge-erm.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-fqm/s/edge-fqm.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-ill/s/edge-ill.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-inn-reach/s/edge-inn-reach.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-inventory/s/edge-inventory.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-rtac/s/edge-rtac.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/edge-users/s/edge-users.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/folio-query-tool-metadata/s/queryTool.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/folio-spring-support/s/tenant.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/folio-vertx-lib/s/tenant-2.0.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mgr-applications/s/am.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mgr-tenant-entitlements/s/mgr-tenant-entitlements.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mgr-tenants/s/mgr-tenants.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-agreements/s/agreements.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-authtoken/s/token-1.0.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-batch-print/s/batchPrint.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-bulk-operations/s/bulk-operations.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-calendar/s/calendar.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-camunda/s/openapi.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-circulation-bff/s/circulationBff.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-circulation-item/s/circulation-item.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/consortia.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/consortia_configuration.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/kafka_message_schemas.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/publications.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/self.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/sharing_instances.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/sharing_policies.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/sharing_roles.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/sharing_settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/tenants.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia-keycloak/s/user_tenants.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/consortia.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/consortia_configuration.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/kafka_message_schemas.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/publications.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/self.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/sharing_instances.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/sharing_settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/tenants.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-consortia/s/user_tenants.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-spring/s/export-configs.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-spring/s/job-deletion-intervals.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-spring/s/jobs.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/authority-control.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/bursar-export.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/circulation-log.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/e-holdings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/email.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/order-export.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export-worker/s/refresh-presigned-url.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-data-export/s/data-export.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-dcb/s/dcb_transaction.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-ebsconet/s/ebsconet.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-entities-links/s/mod-entities-links.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-entities-links/s/tenant-settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-eusage-reports/s/eusage-reports-1.0.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-fqm-manager/s/mod-fqm-manager.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-inn-reach/s/circulation.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-inn-reach/s/contribution.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-inn-reach/s/settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-inventory-update/s/inventory-import-1.0.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-inventory-update/s/inventory-update-5.0.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-licenses/s/licenses.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-linked-data-import/s/mod-linked-data-import.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-linked-data/s/mod-linked-data.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-lists/s/list.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-locations/s/mod-locations.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-login-keycloak/s/mod-login-keycloak.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-marc-migrations/s/marc-migrations.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-mosaic/s/mosaic.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-notes/s/notes.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-oa/s/oa.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-okapi-facade/s/okapi-facade.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-password-validator/s/password-validator.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-password-validator/s/validator-registry.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-quick-marc/s/marc-specifications.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-quick-marc/s/records-editor.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-reading-room/s/patron_permission.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-reading-room/s/reading_room.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-record-specifications/s/mod-record-specifications.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-remote-storage/s/remote-storage.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-requests-mediated/s/requests-mediated.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-roles-keycloak/s/mod-roles-keycloak.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-rtac-cache/s/mod-rtac-cache.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-scheduler/s/mod-scheduler.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-search/s/mod-search.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-serials-management/s/serials-management.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-settings/s/settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tags/s/tags.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/allowed-service-points.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/ecs-loans.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/ecs-request-external.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/ecs-tlr.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/staff-slips.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-tlr/s/tlr-settings.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-users-keycloak/s/users-keycloak.html
📖
Documentation
https://s3.amazonaws.com/foliodocs/api/mod-workflow/s/openapi.html

Specifications

SDKs

📦
GitHubRepository
https://github.com/folio-org/edge-caiasoft
📦
GitHubRepository
https://github.com/folio-org/edge-courses
📦
GitHubRepository
https://github.com/folio-org/edge-dcb
📦
GitHubRepository
https://github.com/folio-org/edge-dematic
📦
GitHubRepository
https://github.com/folio-org/edge-erm
📦
GitHubRepository
https://github.com/folio-org/edge-fqm
📦
GitHubRepository
https://github.com/folio-org/edge-ill
📦
GitHubRepository
https://github.com/folio-org/edge-inn-reach
📦
GitHubRepository
https://github.com/folio-org/edge-inventory
📦
GitHubRepository
https://github.com/folio-org/edge-rtac
📦
GitHubRepository
https://github.com/folio-org/edge-users
📦
GitHubRepository
https://github.com/folio-org/folio-query-tool-metadata
📦
GitHubRepository
https://github.com/folio-org/folio-spring-support
📦
GitHubRepository
https://github.com/folio-org/folio-vertx-lib
📦
GitHubRepository
https://github.com/folio-org/mgr-applications
📦
GitHubRepository
https://github.com/folio-org/mgr-tenant-entitlements
📦
GitHubRepository
https://github.com/folio-org/mgr-tenants
📦
GitHubRepository
https://github.com/folio-org/mod-agreements
📦
GitHubRepository
https://github.com/folio-org/mod-authtoken
📦
GitHubRepository
https://github.com/folio-org/mod-batch-print
📦
GitHubRepository
https://github.com/folio-org/mod-bulk-operations
📦
GitHubRepository
https://github.com/folio-org/mod-calendar
📦
GitHubRepository
https://github.com/folio-org/mod-camunda
📦
GitHubRepository
https://github.com/folio-org/mod-circulation-bff
📦
GitHubRepository
https://github.com/folio-org/mod-circulation-item
📦
GitHubRepository
https://github.com/folio-org/mod-consortia-keycloak
📦
GitHubRepository
https://github.com/folio-org/mod-consortia
📦
GitHubRepository
https://github.com/folio-org/mod-data-export-spring
📦
GitHubRepository
https://github.com/folio-org/mod-data-export-worker
📦
GitHubRepository
https://github.com/folio-org/mod-data-export
📦
GitHubRepository
https://github.com/folio-org/mod-dcb
📦
GitHubRepository
https://github.com/folio-org/mod-ebsconet
📦
GitHubRepository
https://github.com/folio-org/mod-entities-links
📦
GitHubRepository
https://github.com/folio-org/mod-eusage-reports
📦
GitHubRepository
https://github.com/folio-org/mod-fqm-manager
📦
GitHubRepository
https://github.com/folio-org/mod-inn-reach
📦
GitHubRepository
https://github.com/folio-org/mod-inventory-update
📦
GitHubRepository
https://github.com/folio-org/mod-licenses
📦
GitHubRepository
https://github.com/folio-org/mod-linked-data-import
📦
GitHubRepository
https://github.com/folio-org/mod-linked-data
📦
GitHubRepository
https://github.com/folio-org/mod-lists
📦
GitHubRepository
https://github.com/folio-org/mod-locations
📦
GitHubRepository
https://github.com/folio-org/mod-login-keycloak
📦
GitHubRepository
https://github.com/folio-org/mod-marc-migrations
📦
GitHubRepository
https://github.com/folio-org/mod-mosaic
📦
GitHubRepository
https://github.com/folio-org/mod-notes
📦
GitHubRepository
https://github.com/folio-org/mod-oa
📦
GitHubRepository
https://github.com/folio-org/mod-okapi-facade
📦
GitHubRepository
https://github.com/folio-org/mod-password-validator
📦
GitHubRepository
https://github.com/folio-org/mod-quick-marc
📦
GitHubRepository
https://github.com/folio-org/mod-reading-room
📦
GitHubRepository
https://github.com/folio-org/mod-record-specifications
📦
GitHubRepository
https://github.com/folio-org/mod-remote-storage
📦
GitHubRepository
https://github.com/folio-org/mod-requests-mediated
📦
GitHubRepository
https://github.com/folio-org/mod-roles-keycloak
📦
GitHubRepository
https://github.com/folio-org/mod-rtac-cache
📦
GitHubRepository
https://github.com/folio-org/mod-scheduler
📦
GitHubRepository
https://github.com/folio-org/mod-search
📦
GitHubRepository
https://github.com/folio-org/mod-serials-management
📦
GitHubRepository
https://github.com/folio-org/mod-settings
📦
GitHubRepository
https://github.com/folio-org/mod-tags
📦
GitHubRepository
https://github.com/folio-org/mod-tlr
📦
GitHubRepository
https://github.com/folio-org/mod-users-keycloak
📦
GitHubRepository
https://github.com/folio-org/mod-workflow

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/folio:folio-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

folio-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 3.2.0
  title: Folio Open Access Management Reports API
  description: API for the Folio library services platform mod-oa app
  contact:
    name: Knowledge Integration
    url: https://www.k-int.com
servers:
- url: https://folio-snapshot-okapi.dev.folio.org
- url: https://folio-snapshot-2-okapi.dev.folio.org
- url: https://folio-etesting-snapshot-kong.ci.folio.org
security:
- accessToken: []
- okapiToken: []
tags:
- name: Reports
paths:
  /oa/reports/openApcChargesReport:
    description: 'Exports a CSV report of open-access charges (APC) for the given filters. Streams the CSV body directly to the response - there is no pagination, and the server does not set a `Content-Type` header on the response (only `Content-Disposition: attachment; filename=export.csv`).'
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    get:
      tags:
      - Reports
      summary: Get an open-access charges CSV report
      operationId: getOpenApcChargesReport
      parameters:
      - in: query
        name: institution
        description: Not used to filter the underlying query - included verbatim as the `institution` column value on every output row.
        schema:
          type: string
      - in: query
        name: paymentPeriod
        schema:
          type: string
      - in: query
        name: chargeCategory
        description: Comma-separated list of Charge category refdata values.
        schema:
          type: string
      - in: query
        name: chargeStatus
        description: Comma-separated list of Charge status refdata values.
        schema:
          type: string
      responses:
        '200':
          description: 'OK. CSV body with columns: institution, period, euro, doi, is_hybrid, publisher, journal_full_title, issn, url. Invalid paymentPeriod or other failures in the query result in a CSV with header but  no rows, or missing whatever rows the failure prevented'
          content:
            text/csv:
              schema:
                type: string
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /oa/reports/openApcBpcReport:
    description: 'Exports a CSV report of book processing charges (BPC) for the given filters. Streams the CSV body directly to the response - there is no pagination, and the server does not set a `Content-Type` header on the response (only `Content-Disposition: attachment; filename=export.csv`).'
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    get:
      tags:
      - Reports
      summary: Get a book processing charges CSV report
      operationId: getOpenApcBpcReport
      parameters:
      - in: query
        name: institution
        description: Not used to filter the underlying query - included verbatim as the `institution` column value on every output row.
        schema:
          type: string
      - in: query
        name: paymentPeriod
        schema:
          type: string
      - in: query
        name: chargeCategory
        description: Comma-separated list of Charge category refdata values.
        schema:
          type: string
      - in: query
        name: chargeStatus
        description: Comma-separated list of Charge status refdata values.
        schema:
          type: string
      responses:
        '200':
          description: 'OK. CSV body with columns: institution, period, euro, doi, backlist_oa, book_title, isbn. Invalid paymentPeriod or other failures in the query result in a CSV with header but  no rows, or missing whatever rows the failure prevented'
          content:
            text/csv:
              schema:
                type: string
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /oa/reports/openApcTransformativeAgreementReport:
    description: 'Exports a CSV report of publication requests billed under a specific transformative agreement. Streams the CSV body directly to the response - there is no pagination, and the server does not set a `Content-Type` header on the response (only `Content-Disposition: attachment; filename=export.csv`).'
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    get:
      tags:
      - Reports
      summary: Get a transformative agreement CSV report
      operationId: getOpenApcTransformativeAgreementReport
      parameters:
      - in: query
        name: institution
        description: Not used to filter the underlying query - included verbatim as the `institution` column value on every output row.
        schema:
          type: string
      - in: query
        name: paymentPeriod
        schema:
          type: string
      - in: query
        name: publicationStatus
        description: PublicationStatus refdata value to filter on.
        schema:
          type: string
      - in: query
        name: agreementId
        description: Remote ID of the agreement to report on.
        schema:
          type: string
      responses:
        '200':
          description: 'OK. CSV body with columns: institution, period, doi, is_hybrid, publisher, journal_full_title, issn, url. Invalid paymentPeriod or other failures in the query result in a CSV with header but  no rows, or missing whatever rows the failure prevented'
          content:
            text/csv:
              schema:
                type: string
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
components:
  parameters:
    x-okapi-tenant:
      in: header
      name: x-okapi-tenant
      required: true
      schema:
        type: string
  securitySchemes:
    okapiToken:
      type: apiKey
      in: header
      name: x-okapi-token
    accessToken:
      type: apiKey
      in: cookie
      name: folioAccessToken