API REFERENCE

Statuses API

A status is a stage in a work item's lifecycle. The same resource backs tickets, projects, project tasks, and interactions, so every status declares which kind of thing it applies to. Tickets reference a status by ID when you create or move them.

Create a status

Two fields are required: name and status_type. The type is one of ticket, project, project_task, or interaction, and it scopes where the status shows up. Scope a status to a single board with board_id, control where it sits in the list with order_number, and flag the terminal stages with is_closed so reporting knows when work is done.

curl
curl https://algapsa.com/api/v1/statuses \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Waiting on Customer",
    "status_type": "ticket",
    "order_number": 30,
    "is_closed": false,
    "color": "#f5a623"
  }'

Order and retire

Pull the current set with GET /statuses, then reorder by sending new order_number values through PUT /statuses/{id}. Rename, recolor, or change the closed flag the same way. DELETE /statuses/{id}removes a status; move any work off it first, since tickets can't point at a status that no longer exists.

Endpoints

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

GET/api/v1/statusesAlgaPSAAlgaDeskList statusesPOST/api/v1/statusesAlgaPSAAlgaDeskCreate statusGET/api/v1/statuses/{id}AlgaPSAAlgaDeskGet status by IDPUT/api/v1/statuses/{id}AlgaPSAAlgaDeskUpdate statusDELETE/api/v1/statuses/{id}AlgaPSAAlgaDeskDelete status