Skip to content
Connect an agent

Organisations

List the open requests for access to boards

The requests for the boards the caller manages, newest first: who asked, for which board, and the note they wrote.

GET/orgs/{org}/board-requests

TL;DR

QuestionAnswer
What does it do?List the open requests for access to boards.
What does it take?org in the path.
What does it return?Status 200 with a body of type BoardAccessRequestList.
What can go wrong?401 not signed in; 403 boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes; 404 no such organisation, board or tab, or the board is not open to the caller: the cases look alike; 429 too many requests; 503 organisations or boards are not set up on this server. Every failure uses the one error envelope.

What it does

The requests for the boards the caller manages, newest first: who asked, for which board, and the note they wrote. A request from a person outside the organisation is shown to the owner and the admins only.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.

Responses

StatusMeaningBody
200The requests.BoardAccessRequestList
401Not signed in.ErrorResponse
403Boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes.ErrorResponse
404No such organisation, board or tab, or the board is not open to the caller: the cases look alike.ErrorResponse
429Too many requests.ErrorResponse
503Organisations or boards are not set up on this server.ErrorResponse

Response body

A 200 answer has the type BoardAccessRequestList.

FieldTypeRequiredDescription
itemsBoardAccessRequest[]yes
items[].idstringyes
items[].boardstringyesat least 22 characters; at most 22 characters; pattern ^[0-9A-Za-z]+$.
items[].boardNamestringyes
items[].emailstringyes
items[].notestring | nullyes
items[].memberbooleanyesFalse for a person outside the organisation: approving invites them.
items[].createdAtintegeryes

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools