Field

Type

Description

key

string
Required

Identification key of the Board.

name

string
Required

Board custom name.

description

string
Required

Board custom description.

type

string
Required

Type of the Board (example: api).

subtype

string
Required

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

environment

string

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.

members

array of strings

List of Board members' emails.

user

User

Creator of the Board.