# Brightpearl

## **Connector Overview**

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXc8g0zjLAU7PTLUs9WJsgnecyF3pYehuBgMqrcSy3Z2kwBl0PCsiFQT8BU_DVPZlvC863XblPsgBpazY6PBCXgj4lfT7WoubHKoiU1guKRj-eg3A3c-6PgAqnLUbuy_6DJMYnNHng?key=XIy8122ZNqmu67sUe4Q2WNF3" alt=""><figcaption></figcaption></figure>

Brightpearl by Sage is a retail-focused ERP that automates inventory, order management, and accounting. It streamlines operations, enhances efficiency, and scales with growing businesses.

## **Authentication Type**

Basic & OAuth2

## **Webhook Supported**

No

## **Secrets**

* Basic
  * PAN\_SEC\_BRIGHTPEARL-STAFF\_TOKEN
* Oauth
  * PAN\_SEC\_BRIGHTPEARL-OAUTH\_EXPIRES\_AT
  * PAN\_SEC\_BRIGHTPEARL-OAUTH\_TOKEN\_TYPE
  * PAN\_SEC\_BRIGHTPEARL-OAUTH\_EXPIRES\_IN
  * PAN\_SEC\_BRIGHTPEARL-OAUTH\_REFRESH\_TOKEN
  * PAN\_SEC\_BRIGHTPEARL-OAUTH\_ACCOUNT
  * PAN\_SEC\_BRIGHTPEARL-OAUTH\_ACCESS\_TOKEN
  * PAN\_SEC\_BRIGHTPEARL-OAUTH\_INSTALLATION\_INSTANCE\_ID
  * PAN\_SEC\_BRIGHTPEARL-OAUTH\_API\_DOMAIN

## **API Client Supported**

No

## **Requirements for Provisioning**

In order to provision your connector, the following Brightpearl by Sage information must be gathered:

* Basic - Basic - No provisioning is required for this connector.
* OAuth2
  * Client ID
  * Client Secret

To obtain the information required for setting up your Brightpearl by Sage Connector, perform the following steps:

1. Log into your Brightpeal [Developer Account](https://developer.brightpearl.com/login)
2. Navigate to Apps > New App
3. Complete the New App Form
4. Once completed, you will be provided your Client ID and Secret

## **How to Connect Your Integration**

Upon successfully creating a tenant, you will use the following information to connect to ActiveCampaign:

* Basic
  * Staff Token
* OAuth2
  * Account ID

*To obtain your Staff Token, log into your* [*BP Admin Account*](https://login.brightpearlapp.com/) *> App Store > Private Apps. For more information, please see* [*here*](https://help.brightpearl.com/s/article/4414311366545)*.*

## **API Resources**

For more information on how to utilize the Brightpearl by Sage API, feel free to reference the following [documentation](https://api-docs.brightpearl.com/).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pandium.com/connectors/connectors-101/brightpearl.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.