/boards/:boardId/guests
Board Guests API
To retrieve the list of guests on a specific board, you can use the following cURL command:
curl --request GET \
--url https://api.air.inc/v1/boards/boardId/guests \
--header 'accept: application/json'
Request Parameters
- boardId (string, required): The id of the board.
- email (string, optional): To filter with email.
Response Format
The response will be in JSON format:
{
"status": 200,
"message": "Successful request",
"data": [
{
"id": "guestId",
"name": "Guest Name",
"email": "guest@example.com"
}
]
}
Additional Notes
- This API call will return all guests associated with the specified board.
- Be sure to replace
boardIdin the URL with the actual ID of the board you wish to query.