API reference: boards
List the service desk boards an API agent can see, with each board's id and name.
Last updated
A board is a queue of tickets. Board ids appear on every ticket the API returns. Every sample reads the key from CURRENT_API_KEY and calls https://api.current.day/v1.
GET
/v1/boardsNeeds the tickets:read scope.
Lists the service desk boards this agent can see, by id and name. It never changes anything.
Parameters
No parameters.
Errors
| Status | Code and meaning |
|---|---|
| 400 | bad_requestThe request was not in the expected shape. |
| 401 | unauthorizedThis token was not accepted. |
| 403 | not_allowed, frozen, module_offThis agent is not allowed to do that. This workspace is read only right now, so nothing can be changed. The API is not switched on for this workspace. |
| 404 | not_foundNothing was found with that id, or this agent cannot see it. |
| 405 | bad_request (method_not_allowed)That address does not accept this method. The Allow header lists the ones it does. |
| 429 | rate_limited, send_cappedToo many requests from this token. Wait, then try again. This token has sent its limit of customer emails for now. Try again later. |
| 503 | degradedCurrent is busy. Try again in a minute. |
Request
curl -sS --fail-with-body "https://api.current.day/v1/boards" \
-H "Authorization: Bearer $CURRENT_API_KEY"
# A refusal exits non-zero and prints the error: read .error.code and .error.reason,
# for example with jq -r '.error.code, .error.reason'200 answer · a list
{
"data": [
{
"id": "5b3e8d2a-7c41-4f96-a0d7-1e9c6b4f2a85",
"name": {
"untrusted_text": "Front line",
"source": "staff"
},
"is_default": true
}
]
}Was this helpful?