SmartMatchApp

List Board Fields

Retrieve all custom fields defined on a task board.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/tasks/boards/1/fields/" \
    -u <token>: \
    -X GET
Example Success Response:
{
    "objects": [
        {
            "id": 5,
            "name": "budget",
            "label": "Budget",
            "kind": 1,
            "order": 0.0
        },
        {
            "id": 6,
            "name": "region",
            "label": "Region",
            "kind": 2,
            "order": 1.0
        }
    ]
}

kind is a field-type integer — see Create Board Field for the type reference.

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"
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"