Knowledge Base

Browse the concepts behind Truestamp. Follow the links between concepts, or search across everything.

JSON:API

Truestamp's authenticated REST surface at /api/json following the JSON:API specification, with API-key or OAuth 2.1 bearer authentication, an OpenAPI spec rendered by Swagger UI and ReDoc, and resource endpoints with standard filtering, sorting, and pagination.

Overview

In Truestamp, JSON:API refers to the authenticated REST surface served under /api/json, which follows the JSON:API specification for resource endpoints, relationship includes, filtering, sorting, and page[limit] / page[offset] pagination. Every request carries an Authorization: Bearer header holding either an API key or an OAuth 2.1 access token; the one exception is the machine-readable OpenAPI document, which the hosted Swagger UI and ReDoc pages render so you can survey the API before wiring up credentials. Resources such as items, proofs, teams, and webhook endpoints appear as conventional JSON:API endpoints, all documented in the JSON:API reference. Its companion query surface is GraphQL.