REST routes overview
This page lists all REST routes along with brief descriptions and links to detailed pages.
It's a good idea to check out Working with Server before exploring the individual routes.
For easy navigation, you can use either the tabs below or the side menu:
- The side menu organizes routes by HTTP methods
- The tabs below help you quickly identify which routes correspond to different operations
- cards
- rows
- columns
- links
- uploads
These routes handle operations related to cards:
| HTTP method | Route | Description |
|---|---|---|
GET | /cards | Retrieves all cards and returns a JSON object containing an array of card objects |
POST | /cards | Adds a new card and returns a JSON object with the new card's ID |
PUT | /cards | Updates a specific card's data and returns an empty JSON object |
PUT | /cards/id/move | Moves cards to a designated position |
DELETE | /cards | Removes a card's data |
These routes cover operations on rows (swimlanes):
| HTTP method | Route | Description |
|---|---|---|
GET | /rows | Retrieves all rows and returns a JSON object with an array of swimlane data objects |
POST | /rows | Adds a new row and returns a JSON object containing the row ID |
PUT | /rows | Updates a specific row's data and returns an empty JSON object |
PUT | /rows/id/move | Moves a row to a specified position |
DELETE | /rows | Deletes data for a row |
These routes handle operations on columns:
| HTTP method | Route | Description |
|---|---|---|
GET | /columns | Retrieves all columns and returns a JSON object with an array of column data objects |
POST | /columns | Adds a new column and returns a JSON object with the column ID |
PUT | /columns | Updates data for a specific column and returns an empty JSON object |
PUT | /columns/id/move | Moves a column to a chosen position |
DELETE | /columns | Deletes a column's data |