GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints

📖 The Board Object

FieldTypeDescription
keystringRequiredIdentification key of the Board.
namestringRequiredBoard custom name.
descriptionstringRequiredBoard custom description.
type stringRequiredType of the Board (example: api).
subtype stringRequiredSubtype of the Board (example: http_api or php).
environmentstringEnvironment of the Board (example: production, staging, or test)
private booleanTurn to 1 to prevent other Workspace members from accessing the Board. Private=0 by default.
disable booleanTurn to 1 to stop accepting Jobs into the Board. Disable=0 by default.
status booleanTechnical uptime monitoring of the Board.
archived_at datetime ISO 8601Archive date of the Board. The value is null for unarchived Boards.
updated_at datetime ISO 8601Last update date of the Board.
created_at datetime ISO 8601Creation date of the Board.
membersarray of stringsList of Board members' emails.
user UserCreator of the Board.