Skip to content
Node client for the Briq API
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


Node client for the Briq API


In your terminal, type:

$ npm install briq-api --save

Then, in your node application, you can require the module and create a new client instance.

const Briq = require('briq-api').Client;
const briq = new Briq(process.env.BRIQ_ACCESS_TOKEN);


The Briq client requires an access token, used to validate and restrict resource access. A token is uniquely bound to a Briq team. If you're building a custom Briq application, you'll find your access token in the application config screen. It is recommended that your token is stored in a safe place and not committed with your source code. If (when?) your application becomes public and is offered on the Marqet (got it?), you will receive an access token for each new install of your app.

const briq = new Briq(process.env.BRIQ_ACCESS_TOKEN);


The Briq API client is Promise-based. The API surface is pretty narrow. You can do much of the work with only a few methods.

const briq = new Briq(process.env.BRIQ_ACCESS_TOKEN);

return briq.organization('YOUR_ORGANIZATION_NAME').users()
  .then(users => {
    return users;


The Briq API is documented at (getting started) and (detailed documentation).

The following methods are exposed by this API client:

  • .organization(name).info() returns the info about your organization
  • .organization(name).users() returns a list of the users in your organization (paging available)
  • .organization(name).user(username) returns information about a user of your organization
  • .organization(name).transactions() returns a list of the latest transactions in your organization, from most recent to oldest (paging available)
  • .organization(name).transaction(transactionId) returns the details of a transaction
  • .organization(name).createTransaction(transactionObject) creates a new transaction in your organization
  • .organization(name).refundTransaction(transactionId) refunds and deletes a transaction
You can’t perform that action at this time.