Basic information

Requests

URL

General view of the URL: https://api.boardcrm.io/api/ENTITY/ACTION, where ENTITY is the entity, ACTION is the action over the entity, for example https://api.boardcrm.io/api/offer/create

Request parameters

All API methods can be accessed only by using the HTTP POST method

The parameters can be transferred in the following formats:

• application/x-www-form-urlencoded
• multipart/form-data
• JSON (with an HTTP header Content-Type: application/json)

All methods of the public API require transferring access_token

Getting board token for API

To create a token for connecting it to the board via API, go to the Board Settings, to the API Tokens section of the specific board.

You can remove tokens the same way — go to the Board Settings, to the API Tokens section of the specific board.

The created token allows you to access the board via API and perform all methods of the public API.

Main API methods and CRM entities

Deal - basic CRM entity with custom fields

Lead is a customer with a basic set of fields with contact details. The Lead is created together with the deal or attached to the deal

The general method creating a deal is used to create a lead. For your convenience, you can create a deal and a lead with one request:

• place a deal into the desired column
• attach a lead to it or create new
• set values of deal fields

Response fields

All API methods send a response in JSON format. The response object always has the status attribute which helps you identify if the request or error type was successfully processed

• Successful response
• Error

{
    "status": true,
    "data": {
        "id": 412
    }
}

{
    "status": false,
    "error": 4030
}

{
    "column_id": "Column not found",
    "lead": {
        "name": "Name must be a string"
    }
}

Special field types