Authentication

To interact with the Salesbricks API, include the X-SALESBRICKS-KEY attribute in your request headers. The value for this attribute should be your unique Public API Token.

Obtain your Public API Token conveniently under Settings -> Integrations -> Public API.

Take me there

https://app.salesbricks.com/admin/settings/integrations/public-api

Example

cURL

curl https://api.salesbricks.com/api/v2/customers \
  -H "X-SALESBRICKS-KEY: <your-api-key>"

Endpoint URLs

REST API Endpoint

The REST API is the recommended endpoint for integrations, and covers customers, subscriptions, invoices, plans, payment methods, and usage.

Environment	Base URL
Production	https://api.salesbricks.com/api/v2
Staging	https://api.staging.salesbricks.com/api/v2

Usage API Endpoint

https://api.salesbricks.com/api/v2/usage

GraphQL API Endpoint

https://api.salesbricks.com/api/v1/graphql

The GraphQL API remains supported for existing integrations. New functionality is added to the REST API.

The same Public API Token authenticates all three endpoints.