REST API

Introduction

Our REST API is meant for people who require the highest level of integration between Brick and their own application, website, or database.

The REST API uses plain JSON or XML over HTTP. Resources (such as Users or Groups) are manipulated individually using the 4 HTTP verbs: GET, POST, PUT, and DELETE.

Accessing the API

The base URL for all API requests is https://SUBDOMAIN.brickftp.com/api/rest/v1, where SUBDOMAIN is your site’s subdomain. Be sure that you are connecting via https://. Two extensions – .json and .xml are supported as extensions to be appended to the request endpoint for the purpose of determining the response type. So a request ending in .json will send back application/json and .xml will return application/xml.