v1.0 · Stable · AGPL-3.0

Alga PSA developer
documentation.

API reference, examples, and integration notes for working with tickets, billing, projects, assets, and related workflows in Alga PSA.

REST + JSON
API keys
Signed webhooks
cURL + TS + C# examples
~/list-tickets.sh
# List one page of tickets curl "https://algapsa.com/api/v1/tickets?page=1&limit=25" \ -H "X-API-Key: $ALGA_API_KEY"
GET STARTED

Make a first request.

Create a key, store it safely, and call the API.

01

Create an API key

In your Alga PSA instance, open Profile → API Keys and create a key for this integration.

# Profile → API Keys → "Create key" ALGA_API_KEY="sk_live_01HN…"
02

Store the key safely

Copy the key into your secret manager or environment file right away. Treat it like a long-lived password.

# .env.local ALGA_API_KEY="sk_live_01HN…"
03

Call an endpoint

Start with a read endpoint, send your API key, and inspect the JSON response.

curl https://algapsa.com/api/v1/boards \ -H "X-API-Key: $ALGA_API_KEY"
View guides
COVERAGE

Common API areas

The reference is organized by resource group.

TICKETS

Read and update tickets

Create tickets, update fields, add comments, and inspect related activity.

BILLING

Work with invoices

Read invoice and billing records exposed through the API.

PROJECTS

Read projects and tasks

Access project records, tasks, and related metadata.

WEBHOOKS

Receive webhook events

Handle events from supported parts of the platform.

ASSETS

Access asset records

Read asset inventory, maintenance, documents, and related data.

WORKFLOWS

Use workflow endpoints

Start or inspect workflow-related operations where available.

CODE EXAMPLES

Common starting points

TS
TypeScript
fetch + typed helpers
Read the TypeScript guide
Auth
Authentication
X-API-Key header
Review authentication
Key
API keys
Profile → API Keys
Set up credentials
cURL
First request
cURL + JSON response
Make a first API call
NEXT STEPS

Use the reference or set up an API key.

Start with the API reference for endpoints and schemas. If you need credentials, follow the API-key setup guide for the Alga PSA app.