Paragon Sync API
Enable, monitor, and read records from Managed Sync pipelines.
Paragon Sync API is one of 10 APIs that Paragon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include Sync. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.
This API exposes 5 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://actionkit.useparagon.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Paragon Sync API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Paragon User Token. A signed JWT token used to authenticate a Connected User.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Enable, monitor, and read records from Managed Sync pipelines.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are SyncedRecord (7 properties), SyncStatus (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Paragon 9
Other APIs Paragon publishes across the network.