Align Public API v1

Free to read — API key required only to send live requests

Browse endpoints, schemas, and examples without signing in. To generate an API key and execute live requests from the interactive console, create a free developer account.

The Align Public API lets you read and write project data, submit and update entries, manage releases, subscribe to webhooks, and retrieve release evidence packages — all programmatically.

Base URL: https://app.alignsoft.us/api/v1

Authentication: Send your API key in either header:

• Authorization: Bearer <key>
• X-API-Key: <key>

Rate limit: 600 requests / minute per key (sliding window).

Pagination: List endpoints accept ?page= and ?pageSize= (max 100) and respond with { data, page, pageSize, total }.

Idempotency: POST endpoints accept an optional Idempotency-Key header (24 h cache).

Available Endpoints

Resource	Description
GET /me	API key identity and permissions
GET /projects	List all projects
POST /projects	Create a project
GET /projects/:id/entries	List project entries
POST /projects/:id/entries	Create an entry
GET /entries/:id	Get a single entry
PATCH /entries/:id	Update an entry
GET /entries/:id/comments	List comments
POST /entries/:id/comments	Add a comment
GET /entries/:id/attachments	List attachments
GET /projects/:id/releases	List releases
POST /projects/:id/releases	Create a release
GET /releases/:id/evidence	Release evidence package
GET /users	List organisation users
GET /webhooks	List webhook subscriptions
POST /webhooks	Create a webhook subscription
GET /audit-events	List audit events
GET /search	Global search

OpenAPI Specification

Download the full OpenAPI 3.1 specification: openapi.json

You can import this spec into any API client (Postman, Insomnia, Paw, Bruno) to get interactive documentation with your own API key.

Quick Start

# Check your key
curl https://app.alignsoft.us/api/v1/me \
  -H "Authorization: Bearer ako_your_key_here"

# List projects
curl https://app.alignsoft.us/api/v1/projects \
  -H "Authorization: Bearer ako_your_key_here"

# Create an entry
curl -X POST https://app.alignsoft.us/api/v1/projects/<id>/entries \
  -H "Authorization: Bearer ako_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"title": "Login bug on mobile", "type": "bug_report", "priority": "high"}'

For the full interactive API reference with Try-It support, the OpenAPI spec is auto-generated from the Align source and hosted on the app backend.

Error Reference

All errors follow this envelope:

{ "reason": "not_found", "message": "Resource not found." }

HTTP	reason	Meaning
401	missing_key	No auth header
401	invalid_key	Key not recognised
401	key_revoked	Key revoked
402	plan_limit	Plan quota exceeded
403	feature_disabled	API v1 not enabled
403	scope_violation	Project-scoped key acting outside its project
404	not_found	Resource not visible
422	validation_error	Body failed schema validation
429	rate_limit	Rate limit hit; see Retry-After header
500	internal_error	Server error

See the Partner Guide for key management and the API Changelog for recent changes.