Briq API

Base URL: https://www.givebriq.com/v0, Version: v0

Power up your team with peer recognition

This is the detailed technical documentation of the Briq API.

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Tag: Organizations

Operation Description
GET /organizations/{key}

Get an organization

Tag: Users

Operation Description
GET /organizations/{key}/users

List the users of an organization

Tag: Transactions

Operation Description
GET /organizations/{key}/transactions

List the transactions of an organization

POST /organizations/{key}/transactions

Create a transaction in the organization

GET /organizations/{key}/transactions/{id}

Get the details of a transaction

DELETE /organizations/{key}/transactions/{id}

Delete a transaction and reverts its effects

Security

Authentication

Type: basic
Description:

To authenticate with Briq API, you will need the API token provided for your custom integration. Get it from your Briq admin section.

You have to use HTTP basic access authentication. Use your access token as the username and leave the password field empty. Don't forget that Basic auth credentials have to be Base64 encoded (This is handled for you if you use our API client)

Paths

Get an organization

GET /organizations/{key}

Tags: Organizations

Returns an Organization based on its key

key

The key of the Organization to get

path string #/parameters/OrganizationKey

Uses default content-types: application/json

200 OK

An object representing the organization

default

Unexpected error

List the transactions of an organization

GET /organizations/{key}/transactions

Tags: Transactions
key

The key of the Organization to get

path string #/parameters/OrganizationKey

Uses default content-types: application/json

200 OK

An array of transactions

Create a transaction in the organization

POST /organizations/{key}/transactions

Tags: Transactions

Uses default content-types: application/json

The transaction to create

key

The key of the Organization to get

path string #/parameters/OrganizationKey

Uses default content-types: application/json

201 Created

The transaction was created

Location

The URL at which the created transaction can be found

string
Delete a transaction and reverts its effects

DELETE /organizations/{key}/transactions/{id}

Tags: Transactions
key

The key of the Organization to get

path string #/parameters/OrganizationKey
id

The id of the transaction

path string

Uses default content-types: application/json

204 No Content

The transaction was deleted

Get the details of a transaction

GET /organizations/{key}/transactions/{id}

Tags: Transactions
key

The key of the Organization to get

path string #/parameters/OrganizationKey
id

The id of the transaction

path string

Uses default content-types: application/json

200 OK

The details of the transaction

List the users of an organization

GET /organizations/{key}/users

Tags: Users
key

The key of the Organization to get

path string #/parameters/OrganizationKey

Uses default content-types: application/json

200 OK

An array of users

Parameter definitions

PaginationPage page

The page to load in case the results are paginated

query integer
PaginationPerPage per_page

The number of results to load on page in case the results are paginated

query integer
OrganizationKey key

The key of the Organization to get

path string

Schema definitions

Error: object

code: string
message: string
fields: string

Organization: object

{
"externalRef": "T000001",
"key": "a-team",
"platform": "slack",
"settingsMaxGiftBriqs": 6,
"settingsMaxInactiveBriqs": 42,
"settingsNewDailyBriqs": 6
}
key: string

A unique human-readable name for the organization. Serves as subdomain.

externalRef: string

The id of this organization in the platform

platform: string

The platform through which this organization interacts with Briq.

settingsNewDailyBriqs: integer

The number of new inactive Briqs given to user every day.

settingsMaxGiftBriqs: integer

The maximum number of Briqs a user can give another user in one transaction.

settingsMaxInactiveBriqs: integer

The maximum number of inactive Briqs a user can have.

Transaction: object

{
"amount": 5,
"app": "give",
"comment": "I love it when a plan comes together",
"from": "hannibal",
"to": "faceman"
}
amount: integer

The amount of the transaction

app: string

An identifier for the app that created the transaction

from: string

The name of the user who initiated the transaction

to: string

The name of the user who is the recipient of the transaction

comment: string

An optional comment accompanying the transaction

User: object

{
"activeBalance": 421,
"email": "hannibal@the-a-team.com",
"externalRef": "U0000001",
"firstName": "John",
"inactiveBalance": 23,
"lastName": "Smith",
"username": "hannibal"
}
username: string

The name of the user. Must be unique per organization.

firstName: string

The first name of the user.

lastName: string

The last name of the user.

email: string (email)

The email adress of the user.

activeBalance: integer

The number of briqs the user can spend.

inactiveBalance: integer

The number of briqs the user can give to other users.

externalRef: string

An identifier for the user in the external system where users are stored (see Organization#platform)