About the Admin API

Introduction

The Admin API lets you integrate your Brikl store with applications that are important to your business, such as CRM, ERP, and back-office applications.

Use Brikl's GraphQL API to build integrations for reporting and bring data from Brikl to your system.

If you're new to GraphQL, visit our Learn GraphQL guides.

Requirements

All GraphQL Admin API queries require a valid personal access token (PAT) and a shop ID.

If you don't have an access token, please contact Brikl Support to request it.

You can get your shop ID by logging into your dashboard and copying it from the URL. For example:

In the URL above the shop ID is 63d6af47-5d4d-41cb-92f0-2455f4c3dc6f.

Once you have your access token and shop ID, include both in the request header on all API queries:

Endpoint

All Admin API operations are made on a single GraphQL endpoint, which only accepts POST requests:

You can explore the Brikl Admin API using the GraphQL Playground.

If you need help to set up your GraphQL Playground, please refer to Using the GraphQL Playground.