API Reference
SetGet provides a REST API for programmatic access to workspaces, projects, issues, billing, and more.
Base URL
All API endpoints are relative to your SetGet instance URL:
https://app.setget.ai/api/For self-hosted installations, replace with your instance domain.
Authentication
Most endpoints require authentication via session cookie. Obtain a session by logging in:
bash
POST /auth/sign-in/
Content-Type: application/json
{
"email": "user@example.com",
"password": "your-password",
"medium": "email"
}The response sets a setget_session cookie. Include it in subsequent requests:
bash
Cookie: setget_session=<token>Admin Endpoints
Admin endpoints (/api/admin/*) require instance admin authentication:
bash
POST /api/instances/admins/sign-in/Request Format
- Content-Type:
application/jsonfor request bodies - Pagination: Use
?offset=0&per_page=20query parameters - Date format: ISO 8601 UTC (
2026-04-08T12:00:00Z)
Response Format
Successful responses return JSON:
json
{
"id": "abc123",
"name": "Example",
"created_at": "2026-04-08T12:00:00Z"
}List endpoints return paginated results:
json
{
"results": [...],
"total": 42
}Error responses:
json
{
"error": "description of the error"
}HTTP Status Codes
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 204 | No Content (successful delete) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Payment Required (billing limit) |
| 403 | Forbidden |
| 404 | Not Found |
| 409 | Conflict (duplicate) |
| 503 | Service Unavailable |
API Sections
- Billing & Payments — Checkout, subscriptions, invoices, coupons
- SLA Policies — Service level agreements and breach tracking
- Custom Properties — Custom fields on work items
- Project Baselines — Snapshot and deviation tracking
- Admin Billing — Admin subscription and revenue management