DATE:
AUTHOR:
The SafetyChain Team
Spotlight New Features Release Notes

Documents API

DATE:
AUTHOR: The SafetyChain Team

What's New

Getting document data out of SafetyChain and into the rest of your enterprise stack just got easier. The new Documents API gives you a single, flexible endpoint for pulling your document inventory, including metadata, relationships, and reference URLs, into BI tools, data warehouses, supplier portals, and internal applications.

The Documents API joins the Record Data Extracts (RDE) family of public APIs and is published in the SafetyChain Developer Hub as getDocuments. It returns a list of documents (including supplier records, uploaded files, and questionnaire responses) based on filters such as resource, document type, location, user, or specific document ID. Each response includes the document's metadata, the relationships SafetyChain maintains for it, and the reference URLs needed to retrieve or display it in an external system, all in a single payload.

One API, Multiple Document Types

SafetyChain treats a wide range of items as documents, including supplier submissions, uploaded files, questionnaire responses, certifications, and plant procedures. Rather than calling several specialized endpoints, the Documents API returns the full set of matching items through one request, simplifying integration design and ongoing maintenance.

Flexible Filtering on a Single Endpoint

Each request requires at least one filter: document ID, resource, document type, location, or user. The same endpoint supports narrow lookups (a single document by ID) and broader exports (all documents tied to a given resource, type, location, or user), so the same API covers everything from a single-record fetch in an internal portal to a recurring warehouse load.

Built for What's Next

The response structure is forward-compatible. Planned filters such as includeHistory and includeDocumentLinks can be introduced without breaking existing integrations, so work you do today won't need to be redone when those capabilities ship.

Benefits

  • External reporting systems, supplier portals, and data warehouses can stay current with the document inventory in SafetyChain. No more manual exports or screen-scraping.

  • Document metadata, relationships, and reference URLs come back in a single response, reducing chained calls when you're assembling an external view of a resource, supplier, or location.

  • One endpoint covers narrow lookups and broad exports, so your team doesn't have to design and maintain different integration patterns for different use cases.

  • Consistent authentication, conventions, and documentation with the rest of the RDE API family means a shorter learning curve for integration developers already working with SafetyChain extracts.

  • Centralized programmatic access supports enterprise data governance and audit-readiness without standing up a separate process to pull documents.

Availability

Available with the 26A.1 release to customers on the Essential and Advanced packages. Documentation is published in the SafetyChain Developer Hub as getDocuments, alongside the other Record Data Extracts (RDE) APIs.

Powered by LaunchNotes