GET
/
organisations
/
{organisationId}
/
boards

Authorizations

Authorization
string
headerrequired

Path Parameters

organisationId
string
required

Query Parameters

search
string
first
integer
default: 20
before
string
after
string
tags
string
sort
string

Response

200 - application/json
totalCount
integer
required
next
string
prev
string
items
object[]
items.id
string
required
items.orgId
string
required
items.name
string
required
items.hubId
string
items.status
enum<string>
required

BoardStatus is used to indicate the status of a board. The "unknown" status is used in case of inconsistencies in the database with the Board scheduler and the API cannot deduce the correct status without administrator intervention.

If the status is "unknown", then clients should assume it's in a draft/published state based on whether the board has an "activePublishInfo" field. If a board cannot be published due to it already being published and the "activePublishInfo" field is null, users should contact support.

Available options:
unknown,
draft,
publishing,
published,
unpublishing
items.activePublishInfo
object

BoardPublishInfo provides information on a published board instance

items.recentPublishHistory
object[]

RecentPublishHistory is an array of BoardPublishInfo containing up to the last 5 publishes for a board. If full history is required, users should use the ListPublishHistory operation for a paginated view.

items.createdAt
string
required
items.updatedAt
string
required
items.deletedAt
string
items.tags
object
items.thumbnailUrl
string