SmartMatchApp

Retrieve Task Board

Retrieve the details of a specific task board including its list of statuses.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/tasks/boards/<board_id>/" \
    -u <token>: \
    -X GET
Example Success Response:
{
    "id": 1,
    "name": "Sales Pipeline",
    "statuses": [
        {
            "id": 1,
            "name": "To Do",
            "color": "#428BCA",
            "order": 0.0
        },
        {
            "id": 2,
            "name": "In Progress",
            "color": "#5CB85C",
            "order": 1.0
        },
        {
            "id": 3,
            "name": "Done",
            "color": "#D9534F",
            "order": 2.0
        }
    ]
}
Base Request:

Method: GET

Authentication: Basic Authentication. Requires a valid <token> passed.

Rate Limits:

30 requests within 5 seconds

Error Responses:
401 Unauthorized

This error occurs when the <token> is missing, invalid, or the API access is disabled.

Possible errors: "not authenticated" or "token is disabled" or "Agency API is disabled"
404 Not Found

This error occurs if the board with the specified ID does not exist or is archived.
Possible errors: "object does not exist"
405 Method Not Allowed

This error occurs if an HTTP method other than GET is used.
Possible errors: "wrong method"
429 Too Many Requests

This error occurs when the client has sent too many requests in a given amount of time, leading to rate limiting by the server.

Possible errors: "too many requests"
500 Server Error

Possible errors: "Internal server error"