Retrieve Custom Properties

Panora Documentation

Panora is an open-source, unified API for shipping customer-facing integrations

🌼 Welcome to Panora

This 5 minutes checklist helps you get all the requirements to start adding integrations to your product. 

Quick Start

Learn how to authenticate your requests to the Panora API.

Authentication

Use Magic Links to invite your users to grant you access to their data without a dedicated website. Create a full connection flow in just a few clicks. No code required.

Magic Links

Easily extend Panora's unified model to recognize specific fields

Custom Fields Mapping

Panora gives you flexibility about how often your data will get pulled from sources: periodic or real-time

Sync Strategies

Panora can send notifcations to your backend when the state of an object has changed. We use the concept of `events` to represent state changes in any object.

Webhooks Overview

Self-hosting Guide

We welcome all contributions to Panora; from small UI enhancements to brand new integrations. We love seeing community members level up and give people power-ups!

Build a connector

Get Help

Read and write data to multiple CRM platforms using a single API

Overview

Coming Soon

Read and write data to multiple ticketing platforms using a single API

Learn how to write and read data from your multiple ticketing platforms

Home

Marketing Automation

Ticketing

API Reference

Blog

Introduction to our CRM `contact` Unified Model

The Contact Object

Retrieve all contacts from all connected CRMs using one endpoint

List all contacts

Retrieve a contact by id from connected CRMs

Retrieve a contact

Create a contact in any CRM using this endpoint

Create a contact

Update a contact

List companies

Retrieve a company from any connected Crm software

Retrieve a company

Create a company in any supported Crm software

Create a company

Update a company

Introduction to our CRM `deal` Unified Model

The Deal Object

List Deals in any CRM Platform using this endpoint

List Deals

Retrieve a Deal in any CRM Platform using this endpoint

Retrieve a Deal

Create a Deal in any CRM Platform using this endpoint

Create a Deal

Update a Deal in any CRM Platform using this endpoint

Update a Deal

List Notes in any CRM Platform using this endpoint

List Notes

Retrieve a Note in any CRM Platform using this endpoint

Retrieve a Note

Create a Note in any CRM Platform using this endpoint

Create a Note

List Engagements in any CRM Platform using this endpoint

List Engagements

Retrieve an Engagement in any CRM Platform using this endpoint

Retrieve an Engagement

Create an Engagement in any CRM Platform using this endpoint

Create an Engagement

Update an Engagement in any CRM Platform using this endpoint

Update an Engagement

List Tasks in any CRM Platform using this endpoint

List Tasks

List Task in any CRM Platform using this endpoint

Retrieve a Task

List Users in any CRM Platform using this endpoint

List Users

Retrieve a User in any CRM Platform using this endpoint

Retrieve a User

Introduction to our Ticketing `ticket` Unified Model

The tickets object

List Tickets from any Ticketing Platform using this endpoint

List Tickets

List tickets in any Ticketing Platform using this endpoint

Create a ticket in any Ticketing Platform using this endpoint

Create a Ticket

Update a Ticket from any Ticketing Platform using this endpoint

Update a Ticket

Manipulate comments in any Ticketing Platform using these endpoint

List comments in any Ticketing Platform using this endpoint

List Comments

Retrieve a comment in any Ticketing Platform using this endpoint

Retrieve a Comment

Create a comment in any Ticketing Platform using this endpoint

Create a Comment

Update a comment in any Ticketing connection using this endpoint

Update a Comment

List Users from any Ticketing Platform using this endpoint

List users

Retrieve a User from any Ticketing Platform using this endpoint

Retrieve a user

List all contacts from any Ticketing Platform using this endpoint

List Contacts

Retrieve a contact in any Ticketing Platform using this endpoint

Retrieve a Contact

Create a contact in any Ticketing Platform using this endpoint

Create a Contact

Update a Contact from any Ticketing Platform using this endpoint

Update a Contact

List all accounts in any Ticketing Platform using this endpoint

List all accounts

Retrieve an account in any Ticketing Platform using this endpoint

Retrieve an account

Create an account in any Ticketing Platform using this endpoint

Create an account

Update an account in any Ticketing Platform using this endpoint

Update an account

List all tags in any Ticketing Platform using this endpoint

List all tags

Retrieve a tag in any Ticketing Platform using this endpoint

Retrieve a tag

List all teams from any Ticketing Platform using this endpoint

List Teams

Retrieve a Team from any Ticketing Platform using this endpoint

Retrieve a Team

Register

Log In

Get users

Retrieve API Keys

Create API Key

Capture oAuth callback

List Connections

Retrieve webhooks metadata 

Add webhook metadata

Update webhook status

Add Linked User

Retrieve Linked Users

Retrieve a Linked User

Retrieve Organisations

Create an Organisation

Retrieve projects

Create a project

Retrieve field mapping entities

Retrieve field mappings

Retrieve field mappings values

Define target Field

Map Custom Field

Retrieve Events

Create a Magic Link

Retrieve Magic Links

Retrieve a Magic Link

Make a passthrough request

List a batch of CRM Contacts

Create CRM Contact

Update a CRM Contact

Retrieve a contact from any connected CRM

Retrieve a CRM Contact

Add a batch of CRM Contacts

List a batch of Deals

Create a deal in any supported Crm software

Retrieve a deal from any connected Crm software

Add a batch of Deals

List a batch of Notes

Create a note in any supported Crm software

Retrieve a note from any connected Crm software

Add a batch of Notes

List a batch of Companies

Create a Company

Update a Company

Retrieve a Company

Add a batch of Companies

List a batch of Engagements

Create a engagement in any supported Crm software

Create a Engagement

Update a Engagement

Retrieve a engagement from any connected Crm software

Retrieve a Engagement

Add a batch of Engagements

List a batch of Stages

Retrieve a stage from any connected Crm software

Retrieve a Stage

List a batch of Tasks

Create a task in any supported Crm software

Create a Task

Update a Task

Retrieve a task from any connected Crm software

Add a batch of Tasks

List a batch of Users

Retrieve a user from any connected Crm software

List a batch of Tickets

Create a ticket in any supported Ticketing software

Retrieve a ticket from any connected Ticketing software

Retrieve a Ticket

Add a batch of Tickets

List a batch of Comments

Create a comment in any supported Ticketing software

Retrieve a comment from any connected Ticketing software

Add a batch of Comments

Retrieve a user from any connected Ticketing software

List a batch of Attachments

Create a attachment in any supported Ticketing software

Create a Attachment

Retrieve a attachment from any connected Ticketing software

API Reference

Query Parameters