API REFERENCE

Boards API

A board groups tickets and sets the defaults they inherit: which category and priority model applies, who gets new work, and whether the live timer runs. Tickets reference a board by ID, so most integrations resolve or create one here first.

Create a board

Only board_name is required. The two fields worth setting deliberately are category_type and priority_type: each is either custom or itil, and the choice decides whether the board uses your own categories and priorities or the ITIL model. Set is_default to make this the board new tickets land on, and default_assigned_to to auto-assign them.

curl
curl https://algapsa.com/api/v1/boards \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "board_name": "Network Operations",
    "category_type": "itil",
    "priority_type": "itil",
    "is_default": false,
    "enable_live_ticket_timer": true
  }'

Read and maintain

List every board with GET /api/v1/boards to map names to IDs, or fetch one with GET /api/v1/boards/{id}. Adjust defaults, the ITIL display toggles, or the assignee through PUT /api/v1/boards/{id}. Retire a board you no longer route to by setting is_inactive; delete it outright with DELETE /api/v1/boards/{id} only when nothing still references it.

Notification rules

A board can have notification rules that automatically send in-app and email notifications to specific users and teams when a ticket is created on the board, or when a ticket enters one or more of the board's statuses. These rules fire AlgaPSA's native notification path (in-app bell and email), not outbound webhooks.

Each rule specifies one or more trigger events — ticket created on this board, and/or ticket enters a chosen set of statuses — and one or more recipients: individual users or teams. Teams expand to their active internal members at notification time, so the rule stays correct as team membership changes over time.

Rules are created and managed in the board's settings editor under the Notifications section. When you copy a board, status-triggered rule entries are remapped to the new board's matching statuses by name (falling back by position if no name matches); unmatched statuses are flagged in the UI before tickets start arriving.

Default watchers

A board can also carry a list of default watchers: users who are automatically subscribed to every ticket created on the board (recorded with source board_default). Default watchers receive the same email notifications as manually-added watchers and can unsubscribe from individual tickets at any time. Configure the default watcher list in the board's settings editor alongside the notification rules.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.

GET/api/v1/boardsAlgaPSAAlgaDeskList boardsPOST/api/v1/boardsAlgaPSAAlgaDeskCreate boardGET/api/v1/boards/{id}AlgaPSAAlgaDeskGet board by IDPUT/api/v1/boards/{id}AlgaPSAAlgaDeskUpdate boardDELETE/api/v1/boards/{id}AlgaPSAAlgaDeskDelete board