Get board by id

Get board information by ID.

Gets a board's information using the ID specified, optionally including all post, section, and comment data. Returns board object.

📘

API key

You will need to include your API key found here.

Please include the key in your header. {"X-API-KEY": <api_key>}

To include the data of all post, section, and comment objects on a board, please ensure ?include=posts,sections,comments is added to the end of the url.

🔒

Authorization required

This endpoint requires admin access to the board. You must be an admin or owner of the board to access its data.

Query parameters

ParameterDescription
include=posts, =sections, =comments, or any combination (e.g., =posts,sections,comments).
Includes post object, section object, or comment object in returned JSON.
Path Params
string
required
length between 16 and 22

ID of board where you are admin. You can find how to get this on our Introduction page.

Query Params
string
Defaults to posts,sections,comments

comma-separated list of which related resources should be included

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json