Boards

Get a board

GET/api/boards/{boardId}

Returns the specified board and its configuration.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Path parameters

Name	Type	Description
boardIdrequired	string	ID of the board.

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
descriptionrequired	string	Description of the resource.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
parametersrequired	anyOf	Configuration parameters for the resource.

teamIdrequired	string	ID of the associated team.
typerequired	string
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the associated user.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "parameters": "string",
  "teamId": "string",
  "type": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string"
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/boards/{boardId}' \
  -H 'Authorization: Bearer <token>'

PreviousDelete a board NextList my boards