FOLIO

FOLIO Search Resources IDs API

Provides endpoints to retrieve record IDs by CQL queries, without returning the full record data.

Documentation GitHub OpenAPI

Operations 3

GET /search/resources/jobs/{jobId} Get Job #

POST /search/resources/jobs Trigger new Job #

GET /search/resources/jobs/{jobId}/ids Get Resource IDs #

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-search-resources-ids-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    name: Spitfire team
  description: 'API for searching, browsing, and managing facets for various record types, including instances, holdings, and authorities.

    It also provides endpoints for configuring search and browse features, as well as managing the search index.'
  title: Search Resources IDs API
  version: v4.1.0
servers:
- description: Development environments.
  url: https://{environment}-okapi.ci.folio.org
  variables:
    environment:
      default: folio-dev-spitfire
      enum:
      - folio-dev-spitfire
      - folio-perf-spitfire
- description: Reference environments.
  url: https://folio-{environment}-okapi.dev.folio.org
  variables:
    environment:
      default: snapshot
      enum:
      - snapshot
      - snapshot-2
tags:
- description: Provides endpoints to retrieve record IDs by CQL queries, without returning the full record data.
  name: search-resources-ids
paths:
  /search/resources/jobs/{jobId}:
    get:
      description: Get a job for the stream of resource ids.
      operationId: getIdsJob
      parameters:
      - description: X-Okapi-Tenant header value
        in: header
        name: x-okapi-tenant
        required: true
        schema:
          type: string
      - description: UUID of the job to get
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                streamIdsJobResponse:
                  $ref: '#/components/examples/streamIdsJobResponse'
              schema:
                $ref: '#/components/schemas/resourceIdsJob'
          description: Job for the stream of resource ids
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '500':
          content:
            application/json:
              examples:
                unknownError:
                  $ref: '#/components/examples/unknownError'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: When unhandled exception occurred during code execution, e.g. NullPointerException.
      summary: Get Job
      tags:
      - search-resources-ids
  /search/resources/jobs:
    post:
      description: Creates a job for the stream of resource ids.
      operationId: submitIdsJob
      parameters:
      - description: X-Okapi-Tenant header value
        in: header
        name: x-okapi-tenant
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              streamIdsJobRequest:
                $ref: '#/components/examples/streamIdsJobRequest'
            schema:
              $ref: '#/components/schemas/resourceIdsJob'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                streamIdsJobResponse:
                  $ref: '#/components/examples/streamIdsJobResponse'
              schema:
                $ref: '#/components/schemas/resourceIdsJob'
          description: Job for the stream of resource ids
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '500':
          content:
            application/json:
              examples:
                unknownError:
                  $ref: '#/components/examples/unknownError'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: When unhandled exception occurred during code execution, e.g. NullPointerException.
      summary: Trigger new Job
      tags:
      - search-resources-ids
  /search/resources/jobs/{jobId}/ids:
    get:
      description: Get a list of resource ids by job id
      operationId: getResourceIds
      parameters:
      - description: X-Okapi-Tenant header value
        in: header
        name: x-okapi-tenant
        required: true
        schema:
          type: string
      - description: UUID of the job to get
        in: path
        name: jobId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                idsResponse:
                  $ref: '#/components/examples/resourceIdsResult'
          description: Resources ids as a json stream
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '500':
          content:
            application/json:
              examples:
                unknownError:
                  $ref: '#/components/examples/unknownError'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: When unhandled exception occurred during code execution, e.g. NullPointerException.
      summary: Get Resource IDs
      tags:
      - search-resources-ids
components:
  examples:
    streamIdsJobResponse:
      value:
        id: eea1432c-beb8-4f4f-b96a-f8de977f1106
        query: title=*
        status: COMPLETED
        entityType: INSTANCE
        createdDate: '1974-12-03T00:00:00'
    unknownError:
      value:
        errors:
        - message: Illegal argument error
          type: IllegalArgumentException
          code: unknown_error
        total_records: 1
    resourceIdsResult:
      value:
        ids:
        - id: e7e7f4a4-ff8e-48f4-ae8e-25770b7ab4b9
        - id: e60063f6-db50-4a2a-93f6-6b27ab0420f2
        - id: 5fab345a-30a4-4aee-8667-1e33d4627ce9
        totalRecords: 3
    validationErrorResponse:
      value:
        errors:
        - message: must not be null
          type: MethodArgumentNotValidException
          code: validation_error
          parameters:
          - key: parameter
            value: 'null'
        total_records: 1
    streamIdsJobRequest:
      value:
        query: title=*
        entityType: INSTANCE
  schemas:
    error:
      description: An error
      properties:
        message:
          description: Error message text
          type: string
        type:
          description: Error message type
          type: string
        code:
          description: Error message code
          type: string
        parameters:
          items:
            $ref: '#/components/schemas/parameter'
          type: array
      type: object
    errorResponse:
      description: A set of errors
      example:
        errors:
        - message: Illegal argument error
          type: IllegalArgumentException
          code: unknown_error
        total_records: 1
      properties:
        errors:
          description: List of errors
          items:
            $ref: '#/components/schemas/error'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
        total_records:
          description: Total number of errors
          type: integer
      type: object
    parameter:
      description: List of key/value parameters of an error
      example:
        key: source
        value: 'null'
      properties:
        key:
          description: Parameter key
          type: string
        value:
          description: Parameter value
          type: string
      type: object
    resourceIdsJob:
      additionalProperties: false
      description: Job for the stream of entity ids.
      example:
        id: id
        query: query
        status: IN_PROGRESS
        entityType: INSTANCE
        createdDate: createdDate
      properties:
        id:
          description: Unique ID for the job record.
          readOnly: true
          type: string
        query:
          description: CQL query for getting ids.
          type: string
        status:
          description: Ids streaming status.
          enum:
          - IN_PROGRESS
          - ERROR
          - COMPLETED
          - DEPRECATED
          readOnly: true
          type: string
        entityType:
          description: Type of entity for streaming ids.
          enum:
          - INSTANCE
          - AUTHORITY
          - HOLDINGS
          type: string
        createdDate:
          description: Date and time when the record was created.
          readOnly: true
          type: string
      required:
      - entityType
      - query
      type: object

FOLIO Search Resources IDs API

Operations 3

Documentation

Specifications

SDKs

Schemas & Data

Other Resources