📖 The Board Object

Field

Type

Description

keystringRequired

Identification key of the Board.

namestringRequired

Board custom name.

descriptionstringRequired

Board custom description.

type stringRequired

Type of the Board (example: api).

subtype stringRequired

Subtype of the Board (example: http_api or php).

environmentstring

Environment of the Board (example: production, staging, or test)

private boolean

Turn to 1 to prevent other Workspace members from accessing the Board. Private=0 by default.

disable boolean

Turn to 1 to stop accepting Jobs into the Board. Disable=0 by default.

status boolean

Technical uptime monitoring of the Board.

archived_at datetime ISO 8601

Archive date of the Board. The value is null for unarchived Boards.

updated_at datetime ISO 8601

Last update date of the Board.

created_at datetime ISO 8601

Creation date of the Board.

membersarray of strings

List of Board members' emails.

user

User

Creator of the Board.