Paragon

Proxy API

Send requests directly to an integration provider, on behalf of Connected Users. The Proxy API allows you to access any third-party provider's API methods via Paragon's managed credential handling. Supports any HTTP verb and accepts JSON request bodies. Along with Workflows, the Proxy API is one of two primary ways to build integrations with Paragon.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.useparagon.com/apis/making-api-requests

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/openapi/paragon-proxy-api-openapi.yml

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/json-ld/paragon-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/examples/proxy-request-example.json
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/arazzo/paragon-disconnect-integration-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/arazzo/paragon-discover-and-run-action-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/arazzo/paragon-enable-sync-and-pull-records-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/arazzo/paragon-find-and-replay-failed-execution-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/arazzo/paragon-manage-trigger-subscription-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/arazzo/paragon-permissioned-record-retrieval-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/arazzo/paragon-subscribe-to-trigger-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/paragon/refs/heads/main/arazzo/paragon-verify-integration-and-proxy-request-workflow.yml

OpenAPI Specification

paragon-proxy-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Paragon ActionKit Credentials Proxy API
  description: ActionKit is an API to give your AI agent or app access to Paragon's catalog of pre-built Integration Tools across 130+ SaaS applications. ActionKit exposes a Universal API (Tools API) for listing and executing synchronous CRUD actions, and is paired with a Triggers API for event subscriptions. Paragon also publishes an MCP server (github.com/useparagon/paragon-mcp) that wraps ActionKit so agents can call integration tools via the Model Context Protocol. Requests are scoped to a Connected User via Paragon User Token (JWT) Bearer authentication.
  version: 1.0.0
  contact:
    name: Paragon
    url: https://www.useparagon.com
  license:
    name: Proprietary
    url: https://www.useparagon.com/terms-of-service
servers:
- url: https://actionkit.useparagon.com
  description: Paragon ActionKit API (Cloud)
security:
- bearerAuth: []
tags:
- name: Proxy
  description: Proxy requests to third-party integration APIs.
paths:
  /projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}:
    get:
      operationId: proxyGetRequest
      summary: Paragon Proxy GET request to integration
      description: Send a GET request to a third-party integration API on behalf of a Connected User. The request is proxied through Paragon to the integration provider.
      tags:
      - Proxy
      parameters:
      - name: projectId
        in: path
        required: true
        description: Your Paragon Project ID.
        schema:
          type: string
      - name: integrationType
        in: path
        required: true
        description: The type of integration to proxy the request to (e.g., salesforce, hubspot, slack).
        schema:
          type: string
      - name: apiPath
        in: path
        required: true
        description: The API path of the third-party provider to send the request to.
        schema:
          type: string
      responses:
        '200':
          description: Successful proxy response from the integration provider.
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized. Invalid or missing Paragon User Token.
        '404':
          description: Integration not found or not enabled for the user.
        '429':
          description: Rate limit exceeded.
    post:
      operationId: proxyPostRequest
      summary: Paragon Proxy POST request to integration
      description: Send a POST request to a third-party integration API on behalf of a Connected User.
      tags:
      - Proxy
      parameters:
      - name: projectId
        in: path
        required: true
        description: Your Paragon Project ID.
        schema:
          type: string
      - name: integrationType
        in: path
        required: true
        description: The type of integration to proxy the request to.
        schema:
          type: string
      - name: apiPath
        in: path
        required: true
        description: The API path of the third-party provider to send the request to.
        schema:
          type: string
      requestBody:
        description: The request body to send to the third-party provider API.
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Successful proxy response from the integration provider.
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized. Invalid or missing Paragon User Token.
        '404':
          description: Integration not found or not enabled for the user.
        '429':
          description: Rate limit exceeded.
    put:
      operationId: proxyPutRequest
      summary: Paragon Proxy PUT request to integration
      description: Send a PUT request to a third-party integration API on behalf of a Connected User.
      tags:
      - Proxy
      parameters:
      - name: projectId
        in: path
        required: true
        description: Your Paragon Project ID.
        schema:
          type: string
      - name: integrationType
        in: path
        required: true
        description: The type of integration to proxy the request to.
        schema:
          type: string
      - name: apiPath
        in: path
        required: true
        description: The API path of the third-party provider to send the request to.
        schema:
          type: string
      requestBody:
        description: The request body to send to the third-party provider API.
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Successful proxy response from the integration provider.
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized. Invalid or missing Paragon User Token.
        '404':
          description: Integration not found or not enabled for the user.
        '429':
          description: Rate limit exceeded.
    patch:
      operationId: proxyPatchRequest
      summary: Paragon Proxy PATCH request to integration
      description: Send a PATCH request to a third-party integration API on behalf of a Connected User.
      tags:
      - Proxy
      parameters:
      - name: projectId
        in: path
        required: true
        description: Your Paragon Project ID.
        schema:
          type: string
      - name: integrationType
        in: path
        required: true
        description: The type of integration to proxy the request to.
        schema:
          type: string
      - name: apiPath
        in: path
        required: true
        description: The API path of the third-party provider to send the request to.
        schema:
          type: string
      requestBody:
        description: The request body to send to the third-party provider API.
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Successful proxy response from the integration provider.
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized. Invalid or missing Paragon User Token.
        '404':
          description: Integration not found or not enabled for the user.
        '429':
          description: Rate limit exceeded.
    delete:
      operationId: proxyDeleteRequest
      summary: Paragon Proxy DELETE request to integration
      description: Send a DELETE request to a third-party integration API on behalf of a Connected User.
      tags:
      - Proxy
      parameters:
      - name: projectId
        in: path
        required: true
        description: Your Paragon Project ID.
        schema:
          type: string
      - name: integrationType
        in: path
        required: true
        description: The type of integration to proxy the request to.
        schema:
          type: string
      - name: apiPath
        in: path
        required: true
        description: The API path of the third-party provider to send the request to.
        schema:
          type: string
      responses:
        '200':
          description: Successful proxy response from the integration provider.
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized. Invalid or missing Paragon User Token.
        '404':
          description: Integration not found or not enabled for the user.
        '429':
          description: Rate limit exceeded.
  /projects/{projectId}/sdk/proxy/custom/{integrationId}/{apiPath}:
    get:
      operationId: proxyCustomGetRequest
      summary: Paragon Proxy GET request to custom integration
      description: Send a GET request to a custom integration API on behalf of a Connected User.
      tags:
      - Proxy
      parameters:
      - name: projectId
        in: path
        required: true
        description: Your Paragon Project ID.
        schema:
          type: string
      - name: integrationId
        in: path
        required: true
        description: The ID of the custom integration.
        schema:
          type: string
      - name: apiPath
        in: path
        required: true
        description: The API path of the custom integration to send the request to.
        schema:
          type: string
      responses:
        '200':
          description: Successful proxy response from the custom integration.
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized. Invalid or missing Paragon User Token.
        '404':
          description: Integration not found or not enabled for the user.
        '429':
          description: Rate limit exceeded.
    post:
      operationId: proxyCustomPostRequest
      summary: Paragon Proxy POST request to custom integration
      description: Send a POST request to a custom integration API on behalf of a Connected User.
      tags:
      - Proxy
      parameters:
      - name: projectId
        in: path
        required: true
        description: Your Paragon Project ID.
        schema:
          type: string
      - name: integrationId
        in: path
        required: true
        description: The ID of the custom integration.
        schema:
          type: string
      - name: apiPath
        in: path
        required: true
        description: The API path of the custom integration to send the request to.
        schema:
          type: string
      requestBody:
        description: The request body to send to the custom integration API.
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Successful proxy response from the custom integration.
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized. Invalid or missing Paragon User Token.
        '404':
          description: Integration not found or not enabled for the user.
        '429':
          description: Rate limit exceeded.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Paragon User Token. A signed JWT token used to authenticate a Connected User.