Reference: Boards

Your server’s boards: lists, cards, checklists, comments and files.

Good to know

Every request needs your key: Authorization: Bearer tfy_…. Replace YOUR_SERVER_ID with your Discord server id. Errors are explained in Requests, errors and limits.

GET /boards

GET /guilds/{guildId}/boards

The boards the caller may open, in order, each with openCards. mayWrite, mayManage.

Key permissionAny key of this server.

No request body.

Example

curl -X GET "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

POST /boards

POST /guilds/{guildId}/boards

A new board: title, icon, color, visibility, roleIds, lists (the names it starts with, To do, Doing and Done when left out). Up to limits.boards (20 on the free plan). Audit boards.created.

Key permissionboards.manage (Make and manage boards)
Retry safelySend an Idempotency-Key header; a retry with the same one is not done twice.

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
titlestringYesThe board name.1 to 80 characters
iconstring or nullNoOne of the dashboard icons by name, such as kanban. Never emoji.at most 32 characters
color"red" | "orange" | "yellow" | "green" | "blue" | "purple" | "gray"NoThe colour the board is shown in.default "blue"
visibility"public" | "staff" | "roles"Nopublic: read only on the public page. staff: boards.read. roles: only roleIds.default "staff"
roleIdsarray of stringNoStaff roles that may open it, for roles.at most 20 items · default []
listsarray of stringNoNames of the lists the board starts with.at most 10 items · default ["To do","Doing","Done"]

Example

curl -X POST "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"title":"…"}'

GET /boards/{boardId}

GET /guilds/{guildId}/boards/{boardId}

The board with its open lists, labels and cards. Each card says its checklist progress, comments and files; people names everybody cards are assigned to.

Key permissionAny key of this server.

In the address

FieldTypeRequiredWhat it is
boardIdstringYes

No request body.

Example

curl -X GET "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

PATCH /boards/{boardId}

PATCH /guilds/{guildId}/boards/{boardId}

title, icon, color, visibility, roleIds, slug (409 slug_taken), notifyChannelId, notifyEvents and background ({ kind: 'gallery', itemId } for a published gallery picture, { kind: 'media', mediaId } for one of the server's pictures, or null). Boards answer backgroundUrl. Audit boards.changed.

Key permissionboards.manage (Make and manage boards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
titlestringNo1 to 80 characters
iconstring or nullNoOne of the dashboard icons by name, such as kanban. Never emoji.at most 32 characters
color"red" | "orange" | "yellow" | "green" | "blue" | "purple" | "gray"No
visibility"public" | "staff" | "roles"No
roleIdsarray of stringNoat most 20 items
slugstringNoWhere a public board is read beside the public page.at most 60 characters
notifyChannelIdstring or nullNoThe Discord text channel told about changes, or null for none.digits only
backgroundobject, one of the shapes below or nullNoThe picture behind the board: from the Technified gallery, or one of the server pictures. Null for its colour.
notifyEventsarray of "card_created" | "card_moved" | "card_completed" | "card_archived" | "card_assigned" | "card_due" | "checklist_checked" | "comment_added" | "file_added"NoWhich changes are posted to the notify channel.at most 9 items

background takes one of these shapes:

kind: "gallery"

FieldTypeRequiredWhat it is
kind"gallery"Yes
itemIdstringYes1 to 40 characters

kind: "media"

FieldTypeRequiredWhat it is
kind"media"Yes
mediaIdstringYes1 to 40 characters

Example

curl -X PATCH "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE /boards/{boardId}

DELETE /guilds/{guildId}/boards/{boardId}

Deletes it with every list, card and file. Audit boards.deleted.

Key permissionboards.manage (Make and manage boards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes

No request body.

Example

curl -X DELETE "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

GET /boards/{boardId}/archive

GET /guilds/{guildId}/boards/{boardId}/archive

Archived lists and the newest 500 archived cards.

Key permissionAny key of this server.

In the address

FieldTypeRequiredWhat it is
boardIdstringYes

No request body.

Example

curl -X GET "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/archive" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

POST /boards/{boardId}/cards

POST /guilds/{guildId}/boards/{boardId}/cards

A card: listId, title, optional index (the end when left out). Up to 1000 open cards per board.

Key permissionboards.write (Add, change and move cards)
Retry safelySend an Idempotency-Key header; a retry with the same one is not done twice.

In the address

FieldTypeRequiredWhat it is
boardIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
listIdstringYesThe list it goes on.1 to 40 characters
titlestringYesThe card title.1 to 200 characters
indexintegerNoWhere in the list, from 0.0 to 5000

Example

curl -X POST "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/cards" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"listId":"…","title":"…"}'

GET /boards/{boardId}/cards/{cardId}

GET /guilds/{guildId}/boards/{boardId}/cards/{cardId}

The card with its description, checklists, files, the newest 100 entries of its activity and the people named in them.

Key permissionAny key of this server.

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
cardIdstringYes

No request body.

Example

curl -X GET "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/cards/CARDID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

PATCH /boards/{boardId}/cards/{cardId}

PATCH /guilds/{guildId}/boards/{boardId}/cards/{cardId}

title and description with the version they were read at (409 changed when somebody saved in between); labelIds, assigneeIds (Discord user ids, up to 10), dueAt, completed and archived as given.

Key permissionboards.write (Add, change and move cards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
cardIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
titlestringNo1 to 200 characters
descriptionstringNoPlain text with line breaks.at most 5000 characters
versionstringNoThe version the text was read at.1 to 40 characters
labelIdsarray of stringNoat most 20 items
assigneeIdsarray of stringNoDiscord user ids of staff it is assigned to.at most 10 items
dueAtstring or nullNoWhen it is due, or null.ISO 8601 date and time
completedbooleanNoMarks it done, or not done.
archivedbooleanNoArchives it, or brings it back.

Example

curl -X PATCH "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/cards/CARDID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE /boards/{boardId}/cards/{cardId}

DELETE /guilds/{guildId}/boards/{boardId}/cards/{cardId}

Deletes it for good with its files. Audit boards.card_deleted.

Key permissionboards.manage (Make and manage boards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
cardIdstringYes

No request body.

Example

curl -X DELETE "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/cards/CARDID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

POST /boards/{boardId}/cards/{cardId}/checklists

POST /guilds/{guildId}/boards/{boardId}/cards/{cardId}/checklists

A checklist: title. Up to 5 per card.

Key permissionboards.write (Add, change and move cards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
cardIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
titlestringYes1 to 80 characters

Example

curl -X POST "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/cards/CARDID/checklists" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"…"}'

PUT /boards/{boardId}/cards/{cardId}/move

PUT /guilds/{guildId}/boards/{boardId}/cards/{cardId}/move

Moves it to index in listId.

Key permissionboards.write (Add, change and move cards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
cardIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
listIdstringYesThe list it moves to, which may be the one it is on.1 to 40 characters
indexintegerYesIts place in that list, from 0.0 to 5000

Example

curl -X PUT "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/cards/CARDID/move" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listId":"…","index":0}'

PUT /boards/{boardId}/checklists/{checklistId}

PUT /guilds/{guildId}/boards/{boardId}/checklists/{checklistId}

Key permissionboards.write (Add, change and move cards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
checklistIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
titlestringYes1 to 80 characters

Example

curl -X PUT "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/checklists/CHECKLISTID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"…"}'

DELETE /boards/{boardId}/checklists/{checklistId}

DELETE /guilds/{guildId}/boards/{boardId}/checklists/{checklistId}

Key permissionboards.write (Add, change and move cards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
checklistIdstringYes

No request body.

Example

curl -X DELETE "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/checklists/CHECKLISTID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

POST /boards/{boardId}/checklists/{checklistId}/items

POST /guilds/{guildId}/boards/{boardId}/checklists/{checklistId}/items

An item: text. Up to 50 per checklist.

Key permissionboards.write (Add, change and move cards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
checklistIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
textstringYes1 to 300 characters

Example

curl -X POST "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/checklists/CHECKLISTID/items" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"…"}'

PUT /boards/{boardId}/checklists/{checklistId}/order

PUT /guilds/{guildId}/boards/{boardId}/checklists/{checklistId}/order

The order of its items: every id once.

Key permissionboards.write (Add, change and move cards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
checklistIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
idsarray of stringYesEvery id, once, in the new order.at most 500 items

Example

curl -X PUT "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/checklists/CHECKLISTID/order" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["…"]}'

GET /boards/{boardId}/files/{fileId}

GET /guilds/{guildId}/boards/{boardId}/files/{fileId}

A file. A PDF is sent as a download.

Key permissionAny key of this server.

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
fileIdstringYesA file’s id inside the document or storage.

No request body.

Example

curl -X GET "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/files/FILEID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

DELETE /boards/{boardId}/files/{fileId}

DELETE /guilds/{guildId}/boards/{boardId}/files/{fileId}

Deletes a file.

Key permissionboards.write (Add, change and move cards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
fileIdstringYesA file’s id inside the document or storage.

No request body.

Example

curl -X DELETE "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/files/FILEID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

PATCH /boards/{boardId}/items/{itemId}

PATCH /guilds/{guildId}/boards/{boardId}/items/{itemId}

Key permissionboards.write (Add, change and move cards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
itemIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
textstringNo1 to 300 characters
donebooleanNoTicks it, or takes the tick away.

Example

curl -X PATCH "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/items/ITEMID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE /boards/{boardId}/items/{itemId}

DELETE /guilds/{guildId}/boards/{boardId}/items/{itemId}

Key permissionboards.write (Add, change and move cards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
itemIdstringYes

No request body.

Example

curl -X DELETE "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/items/ITEMID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

POST /boards/{boardId}/labels

POST /guilds/{guildId}/boards/{boardId}/labels

A label: name (may be empty) and color. Up to 20 per board.

Key permissionboards.manage (Make and manage boards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
namestringNoMay be empty: a colour alone is a label.at most 30 characters · default ""
color"red" | "orange" | "yellow" | "green" | "blue" | "purple" | "gray"YesThe label colour.

Example

curl -X POST "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/labels" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"color":"red"}'

PUT /boards/{boardId}/labels/{labelId}

PUT /guilds/{guildId}/boards/{boardId}/labels/{labelId}

Key permissionboards.manage (Make and manage boards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
labelIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
namestringNoMay be empty: a colour alone is a label.at most 30 characters · default ""
color"red" | "orange" | "yellow" | "green" | "blue" | "purple" | "gray"YesThe label colour.

Example

curl -X PUT "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/labels/LABELID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"color":"red"}'

DELETE /boards/{boardId}/labels/{labelId}

DELETE /guilds/{guildId}/boards/{boardId}/labels/{labelId}

Key permissionboards.manage (Make and manage boards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
labelIdstringYes

No request body.

Example

curl -X DELETE "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/labels/LABELID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

POST /boards/{boardId}/lists

POST /guilds/{guildId}/boards/{boardId}/lists

A list at the end: title. Up to 30 per board, archived ones included.

Key permissionboards.manage (Make and manage boards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
titlestringYesThe list name.1 to 60 characters

Example

curl -X POST "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/lists" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"…"}'

PATCH /boards/{boardId}/lists/{listId}

PATCH /guilds/{guildId}/boards/{boardId}/lists/{listId}

title, archived (an archived list hides its cards; one brought back goes to the end).

Key permissionboards.manage (Make and manage boards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
listIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
titlestringNo1 to 60 characters
archivedbooleanNoArchives the list with its cards, or brings it back.

Example

curl -X PATCH "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/lists/LISTID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE /boards/{boardId}/lists/{listId}

DELETE /guilds/{guildId}/boards/{boardId}/lists/{listId}

Deletes it with its cards and their files. Audit boards.list_deleted.

Key permissionboards.manage (Make and manage boards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
listIdstringYes

No request body.

Example

curl -X DELETE "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/lists/LISTID" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

PUT /boards/{boardId}/lists/{listId}/move

PUT /guilds/{guildId}/boards/{boardId}/lists/{listId}/move

Moves it to index.

Key permissionboards.manage (Make and manage boards)

In the address

FieldTypeRequiredWhat it is
boardIdstringYes
listIdstringYes

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
indexintegerYesIts place among the lists, from 0.0 to 100

Example

curl -X PUT "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/BOARDID/lists/LISTID/move" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"index":0}'

POST /boards/import

POST /guilds/{guildId}/boards/import

A board from Trello, as the dashboard reads Trello's JSON export: title, color, visibility, roleIds, lists (ref, title, archived, up to 30), labels (ref, name, color, up to 20) and cards (up to 2000, of which at most 1000 open) with list, title, description, labels, dueAt, completed, archived, checklists and comments (author, text, at). Nobody is put on a card; comments are kept under the author's name with "(Trello)". All or nothing. Answers board and imported counts. Audit boards.created.

Key permissionboards.manage (Make and manage boards)
Retry safelySend an Idempotency-Key header; a retry with the same one is not done twice.

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
titlestringYes1 to 80 characters
color"red" | "orange" | "yellow" | "green" | "blue" | "purple" | "gray"Nodefault "blue"
visibility"public" | "staff" | "roles"Nodefault "staff"
roleIdsarray of stringNoat most 20 items · default []
listsarray of objectsYes1 to 30 items
lists[].refstringYes1 to 64 characters
lists[].titlestringYes1 to 60 characters
lists[].archivedbooleanNodefault false
labelsarray of objectsYesat most 20 items
labels[].refstringYes1 to 64 characters
labels[].namestringYesat most 30 characters
labels[].color"red" | "orange" | "yellow" | "green" | "blue" | "purple" | "gray"Yes
cardsarray of objectsYesat most 2000 items
cards[].liststringYes1 to 64 characters
cards[].titlestringYes1 to 200 characters
cards[].descriptionstringNoat most 5000 characters · default ""
cards[].labelsarray of stringNoat most 20 items · default []
cards[].dueAtstring or nullNoISO 8601 date and time · default null
cards[].completedbooleanNodefault false
cards[].archivedbooleanNodefault false
cards[].checklistsarray of objectsNoat most 5 items · default []
cards[].checklists[].titlestringYes1 to 80 characters
cards[].checklists[].itemsarray of objectsYesat most 50 items
cards[].checklists[].items[].textstringYes1 to 300 characters
cards[].checklists[].items[].donebooleanYes
cards[].commentsarray of objectsNoat most 300 items · default []
cards[].comments[].authorstringYes1 to 80 characters
cards[].comments[].textstringYes1 to 2000 characters
cards[].comments[].atstringYesISO 8601 date and time

Example

curl -X POST "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/import" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"title":"…","lists":[{"ref":"…","title":"…"}],"labels":[{"ref":"…","name":"…","color":"red"}],"cards":[{"list":"…","title":"…"}]}'

PUT /boards/order

PUT /guilds/{guildId}/boards/order

The order of the boards: every id once.

Key permissionboards.manage (Make and manage boards)

Request body

JSON, sent with Content-Type: application/json.

FieldTypeRequiredWhat it is
idsarray of stringYesEvery id, once, in the new order.at most 500 items

Example

curl -X PUT "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/order" \
  -H "Authorization: Bearer $TECHNIFIED_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["…"]}'

GET /boards/people

GET /guilds/{guildId}/boards/people

The server's staff, with names and pictures, to put on cards.

Key permissionboards.write (Add, change and move cards)

No request body.

Example

curl -X GET "https://api.technified.xyz/v1/guilds/YOUR_SERVER_ID/boards/people" \
  -H "Authorization: Bearer $TECHNIFIED_KEY"

Still stuck? Get help from the Technified team.