Skip to main content
Project Witness logo

Public API

Read-only public API for released archival records, collections, entities, exhibits, and exports. Tenant resolution uses the request host; no API key is required.

Tenant resolution

The Host or X-Forwarded-Host header resolves one active organization. Every data response is scoped to that organization; an unmapped host receives 404 except on health and documentation endpoints.

Rate limit

200 requests per minute per IP address

Endpoints

  • GET /api/public/records

    Paginated list of released records.

    Query parameters
    page
    integer, default 1
    limit
    integer, maximum 100
    collection
    collection slug; includes descendants
    language
    ISO language code
  • GET /api/public/records/:slug

    Released record detail with visible entities, ancestors, siblings, and previous/next links.

  • GET /api/public/collections

    Released top-level fonds and collections with cover images and date aggregates.

  • GET /api/public/collections/:slug

    Released collection detail with visible children, descendant count, and breadcrumbs.

  • GET /api/public/collections/:slug/ead.xml

    EAD3 XML finding-aid export for an eligible released collection.

  • GET /api/public/collections/:slug/finding-aid.pdf

    PDF finding aid for an eligible released collection.

  • GET /api/public/entities

    Authority entries linked to released records.

    Query parameters
    page
    integer
    limit
    integer
    entity_type
    person|corporate_body|place|subject|family
    search
    text
    letter
    one character
  • GET /api/public/entities/:slugOrId

    Visible authority detail with public notes and linked released records.

  • GET /api/public/entities/:slugOrId/records

    Released records linked to a visible authority entry, ordered by confidence.

    Query parameters
    limit
    integer
    exclude
    record UUID to omit
  • GET /api/public/entities/:slug/eac.xml

    EAC-CPF XML export for an eligible authority entry.

  • GET /api/public/search

    Search over released public records. Supports person:, place:, and subject: field prefixes.

    Query parameters
    q
    query text
    collection
    collection slug; includes descendants
    person
    entity name
    place
    entity name
    subject
    entity name
    date_start
    start year
    date_end
    end year
    language
    ISO language code
    sort
    relevance|date|date_desc|title|quality
    page
    integer
    limit
    integer
  • GET /api/public/cite/:slug

    Chicago 17, APA 7, and MLA 9 citation strings for a released record.

  • GET /api/public/images/:orgId/:recordId/thumb

    Public JPEG thumbnail, maximum edge 400 pixels, when media access permits.

  • GET /api/public/images/:orgId/:recordId/original

    Original uploaded file only when the effective media-access decision permits it.

  • GET /api/public/iiif/:orgId/:recordId/manifest.json

    IIIF Presentation API 3.0 manifest for an eligible released image. This is not an IIIF Image API claim.

  • GET /api/public/oai

    OAI-PMH 2.0 endpoint with the six protocol verbs. Metadata prefixes: oai_dc, oai_qdc, oai_ead.

  • GET /api/public/exhibits

    Published curated exhibits.

  • GET /api/public/health

    Public service health probe.

  • GET /api/public/docs

    This machine-readable API documentation.

    Query parameters
    lang
    en|he

Raw JSON

The machine-readable version of this page is available at:

/api/public/docs