#top-aligned-table td {
  vertical-align: top;
  padding: 8px;
}


Get metadata for a specific record in a Sync.

Get Synced Record

Get metadata for a specific record in a Sync

bearerAuth

Paragon Documentation

Embedded integration infrastructure for B2B SaaS & AI products

Welcome to Paragon

Start testing your Paragon integrations without embedding our SDK

Hosted Demo Environment

Platform

Focus on building out your integration logic and leave integration authentication to Paragon.

Overview

Control your end-user integration experience by customizing Connect Portal.

Customizing the Connect Portal

Control the visibility or customize the description of workflows that appear in the Connect Portal.

Displaying Workflows

Restrict the visibility of workflows to specific users or groups with Workflow Permissions.

Workflow Permissions

Use a Field Mapping User Setting to allow your users to define a mapping between objects in your application and their integration.

Field Mapping

Bring your existing components or design system into your Paragon integrations experience with the Headless Connect Portal.

Headless Connect Portal

Quickly view a timeline and status of previous workflow executions.

Viewing Task History

Manage connected users and their integrations.

Managing Connected Users

Search, view, and trace logs for all Paragon events.

Viewing Event Logs

Event Logs

Use Release Environments to test and deploy new integrations and integration updates.

Release Environments

Create unique spaces for different teams to collaborate.

Working with Multiple Projects

Create your own custom integration with any app provider on Paragon.

Custom Integrations

Create your own custom webhook with any integration provider on Paragon.

Custom Webhooks

Quickstart Sample App

Send requests directly to an integration provider, on behalf of Connected Users.

Proxy API

Users API

Task History API

Update your Account Settings, like email, password, and MFA options.

Managing Account Settings

Invite your team to create integrations on Paragon.

Working with Team Members

Assign roles to team members working together on Paragon.

Role Based Access Control

In this tutorial, we'll build a basic Salesforce integration that syncs leads from your app to your customers' Salesforce accounts.

Building a Salesforce Integration

In this tutorial, we'll build a basic HubSpot integration that syncs contacts from your app to your customers' HubSpot accounts.

Building a HubSpot Integration

In this tutorial, we'll build a basic Slack integration that sends notifications from your app to your customers' Slack accounts.

Building a Slack Integration

In this tutorial, we'll build a basic Marketo integration that syncs leads from your app to lists in your customers' Marketo accounts.

Building a Marketo Integration

In this tutorial, we'll build a basic BambooHR integration that syncs employees from your app to your customers' BambooHR accounts.

Building a BambooHR Integration

In this tutorial, we'll use the Paragon SDK to build an integrations catalog into your app.

Building an In-App Integrations Catalog

Learn how Connected Users are counted in Paragon.

Connected Users

Task Usage

Learn how concurrency is calculated in Paragon.

Concurrency SLA

Paragon's Security and Change Management Procedures.

Security

Trust Center

GDPR

Service Level Agreement

Contacting Support

Learn about deploying Paragon on your own infrastructure.

Hosting Paragon On Premise

Choosing a Hosting Solution

System Requirements

Infrastructure Architecture

Application Architecture

System Metrics and Alarms

On Premise Costs

Data Access & Controls

Incident Response

Managed Sync provides pipelines to sync data from your users' integration sources to your app or RAG pipeline.

Managed Sync

Try Managed Sync in our Playground environment or using the API.

Getting Started

Receive webhooks when records are created, updated, or deleted from your Sync.

Webhooks

Learn how to use and implement Sync API in your app.

Sync API

Start a Sync for a Connected User with a specific configuration

Enable a Sync

Once you have a Sync enabled for a particular Connected User, you can start to poll its status.

Get Sync Status

Pull Synced Records

Download the file associated with a File-type Synced Object.

Download File Content

Learn how to use and implement Permissions API in your app.

Permissions API

Check if a user has a specific role for an object

Check Access

Check access for a list of users and objects

Batch Check Access

List users that have access to an object with an optional role filter

List Users

List objects that a user has access to with an optional role filter

List Objects

ActionKit is an API to give your agentic AI product access to Paragon's catalog of pre-built Integration Actions as tools.

ActionKit

Search, view, and trace logs for all of your ActionKit requests.

Logs and Errors

Supported Integrations

Use ActionKit to provide your AI agent with hundreds of Integration Actions.

ActionKit for Tool Calling

Try ActionKit in the AI Agent Playground, a sandbox to test chatting with an agent that has access to ActionKit tools.

AI Agent Playground

Paragon MCP Server

Reference for API endpoints available in ActionKit.

API Reference

Schema Formats

Workflows allow you to build and automate complex integration logic across your SaaS stack—without managing infrastructure or writing custom code.

Workflows

Workflows connect data between your users' apps and your application

Building Workflows

Integration Actions

Using Functions

Add conditional branching logic to your workflows

Using Conditionals

Run a sequence of steps over each object in an array.

Using Fan Out

Pass data from your application, the Connect Portal, and previous steps.

Using Dynamic Variables

Working with Files

Add API Resources to your project to build reusable Triggers and Steps for your API in Workflows.

API Resources

Automatically retry failed step executions.

Auto Retries

Learn how Workflows automatically recover from integration API rate limits.

Smart Rate Limits

Review and restore previous versions of your workflow. Check or revert to earlier workflow versions.

Version History

Securely store and access credentials across your workflows.

Environment Secrets

Paragraph allows you to author and maintain Paragon integrations as code, which can be synced with a Git repository to track revisions over time.

Getting Started with Paragraph

Learn how to define and configure workflows as code within a Paragraph project.

Defining Integrations

Learn how to define workflows as code within a Paragraph project.

Defining Workflows

Learn how to define App Event schemas in Paragraph projects.

Defining App Events

Build and Push

Connect your Git repository to sync changes made in Paragon to a version control system.

Setting up Git Sync

JavaScript Libraries

Workflow Templates

Paragon User Token Generator

Connect to your users' ActiveCampaign accounts.

ActiveCampaign

Connect to your users' Adobe Acrobat Sign accounts.

Adobe Acrobat Sign

Connect to your users' Adobe Experience Manager accounts.

Adobe Experience Manager

Connect to your users' ADP Workforce Now accounts.

ADP Workforce Now

Connect to your users' Airtable accounts.

Airtable

Connect to your users' Amazon S3 accounts.

Amazon S3

Connect to your users' Amplitude accounts.

Amplitude

Connect to your users' Apollo.io accounts.

Apollo.Io

Asana

Connect to your users' Azure DevOps accounts.

Azure DevOps

Connect to your users' BambooHR accounts.

BambooHR

Connect to your users' BigQuery accounts.

BigQuery

Connect to your users' Calendly accounts.

Calendly

ClickUp

Close

Coda

Connect to your users' Confluence accounts.

Confluence

Copper

Connect to your users' DocuSign accounts.

DocuSign

Dropbox

Connect to your users' Dropbox Sign accounts.

Dropbox Sign

Connect to your users' Dynamics 365 Business Central accounts.

Dynamics 365 Business Central

Connect to your users' Dynamics 365 Finance accounts.

Dynamics 365 Finance

Emarsys

Connect to your users' Facebook Ads accounts.

Facebook Ads

Connect to your users' Facebook Pages accounts.

Managed Sync

Sync API

Permissions API

Integrations Reference

Get Synced Record

Authorizations

Path Parameters

Response