App API

BRIX API is a tool for integrating BRIX with third-party systems. Web requests using API methods allow you to fetch app items, execute actions on them, import data from files, and more. For a full list of available methods, see BRIX public API reference.

To view the main methods for working with an app, click the gear icon next to the app name and select API.

On the opened page, you can view detailed information about the methods and test your request.

API method list

Each method is displayed in a collapsible block. Expand it to view full details. The block includes:

1. Header:

• The HTTP request method used, such as GET or POST.
• The relative URL of the API method.
• Action name.
• Buttons for managing the method:
  • copies the full URL to use in requests.
  • opens the detailed method description in the BRIX public API documentation.

2. Parameters section. View the format of passed values and the request structure. If an example request is provided, copy it by clicking in the upper right corner of the field.
3. Responses section. View status codes and descriptions of possible server responses.

Testing requests

You can build and test API requests directly on this page.

Note that test requests execute directly in the system. For example, testing methods that create or edit app items will modify actual data.

To test a request:

1. Expand the method information block and click Try it out in the upper right corner.
2. In the Parameters section, depending on the method:
   • Enter required values, such as an app item ID.
   • Provide the request body based on the template.

To reset a field to its initial value, click . To copy the request body, click .

3. Click Execute below the parameters list.

The Responses section displays:

• Request URL. The request URL generated with the specified parameters. Click on the right to copy it.
• Server response. The status code and response body. Click to copy the response body.

To clear test data from the page, click Clear at the bottom of the Parameters section.

To exit testing mode, click Cancel in the upper right corner of the block.