Only the operations listed on API reference accept an API token. Everything below is called by the app with a cookie session. A Bearer request to any of these paths under /api/w/{slug} answers 403 forbidden with the message "This operation is not available to API keys"; a Bearer request outside /api/w/{slug} (for example /api/me) answers 403 forbidden with "API keys cannot access global account operations". Client management, billing configuration, members, settings, and token management are administrative surfaces that stay behind an interactive login on purpose. Automated provisioning of people uses SCIM instead.
Paths in the tables are relative to /api/w/{slug} unless they start with /api/. Every write here also fails with read_only (403) while the workspace is read-only, except removals of members and tokens, export, deletion, and the organisation billing operations.
Clients and people
Owner or Admin for every change. Workspace users may list clients and people; a client user sees only their own client.
| Operation | Contract | Purpose |
|---|---|---|
GET /api/w/{slug}/photos, GET /api/w/{slug}/people/{id}/photo |
Photos, bytes |
Who has a profile photo (with the version to request), and the photo of a person while they are a member or client user here; former members answer 404 |
GET /clients?archived=true |
ClientSummary[] |
List clients |
GET /people |
People |
People who may be mentioned or assigned |
POST /clients |
ClientInput → ClientDetail |
Create a client |
GET /clients/{id} |
ClientDetail |
Client with users, contacts, billing recipients, projects |
PATCH /clients/{id} |
UpdateClient → ClientDetail |
Change name, currency, locale, timesheet layout, rounding |
DELETE /clients/{id} |
Archive a client (never deleted) | |
POST /clients/{id}/users |
AddClientUser → ClientUser |
Add a client user and email them a welcome; a contact's tickets move to the login (recent re-authentication) |
POST /clients/{id}/users/{userId}/link-tickets |
→ { ticketCount } |
Move the tickets a client user corresponds on as a contact to their login (recent re-authentication) |
PATCH /clients/{id}/users/{userId} |
{ billingContact } |
Set the Billing contact flag (recent re-authentication) |
DELETE /clients/{id}/users/{userId} |
Remove a client user (recent re-authentication) | |
POST /clients/{id}/contacts |
ContactInput → Contact |
Add or attach a contact |
DELETE /clients/{id}/contacts/{contactId} |
Delete a contact | |
POST /clients/{id}/billing-recipients |
{ email } → { id } |
Designate a timesheet recipient (recent re-authentication) |
DELETE /clients/{id}/billing-recipients/{recipientId} |
Remove a recipient (recent re-authentication) |
Workspaces, members, and invitations
| Operation | Contract | Purpose |
|---|---|---|
GET /api/workspaces |
Membership[] |
The workspaces the signed-in person belongs to |
GET /api/w/{slug} |
WorkspaceSummary |
Workspace summary and the entry check (MFA, forced SSO) |
GET /members |
MembersResponse |
Members and, for Owner or Admin, pending invitations |
POST /invitations |
CreateInvitationRequest → Invitation |
Invite by email with a role; Owner or Admin, recent re-authentication, seat check |
DELETE /invitations/{id} |
Revoke an invitation | |
PATCH /members/{id} |
UpdateMemberRequest |
Change a member's role (last_owner, owner_only rules) and the expected work week |
DELETE /members/{id} |
Remove a member, or leave the workspace |
Settings
| Operation | Contract | Purpose |
|---|---|---|
GET /settings/general, PATCH /settings/general |
GeneralSettings, UpdateGeneralSettings |
Name, ticket prefix, timezone, locale, currency, period length; Owner or Admin |
GET /settings/features, PATCH /settings/features |
FeatureSettings, UpdateFeatureSettings |
Time and billing, resource planning; Owner or Admin. See Turn features on or off |
GET /workflow changes and the kind, state, priority, label operations |
see Workflow | Owner or Admin |
GET /settings/auth |
AuthSettings |
Verified domains, SSO connection, SCIM settings; Owner or Admin |
POST /settings/auth/domains, POST …/domains/{id}/verify, PATCH …/domains/{id}, DELETE …/domains/{id} |
Domain |
Domain verification and forced SSO |
PUT /settings/auth/sso, POST /settings/auth/sso/deactivate, DELETE /settings/auth/sso |
SsoConnection |
The OpenID Connect connection |
PUT /settings/auth/scim, POST /settings/auth/scim/tokens, DELETE /settings/auth/scim/tokens/{id} |
ScimSettings |
SCIM provisioning and its bearer tokens |
Recurring series
| Operation | Contract | Purpose |
|---|---|---|
POST /recurrences/{id}/pause |
Recurrence |
Stop a series creating tickets until resumed |
POST /recurrences/{id}/resume |
Recurrence |
Continue from the first occurrence on or after today; nothing is backfilled |
POST /recurrences/{id}/archive |
Recurrence |
Close a series for good; its tickets stay. Creating and editing a series are token operations, see Recurring tickets |
Workspace users; connecting a mailbox and reading its status is Owner or Admin with recent re-authentication; mailbox retention and purge are Owner only.
| Operation | Purpose |
|---|---|
GET /mail/health |
Mailbox connection status |
POST /mail/connect |
Connect Microsoft 365 or IMAP/SMTP |
GET /mail/status |
Live mailbox storage next to what SAQ holds |
PUT /mail/secret-expiry |
Record or clear the date the mailbox credential expires (recent re-authentication) |
PUT /mail/retention |
Set mailbox retention (Owner, recent re-authentication) |
POST /mail/purge |
Purge held mail older than a period, one bounded pass (Owner, recent re-authentication) |
GET /mail/messages |
Messages waiting in the Inbox or in restricted review |
POST /mail/messages/{id}/route |
Route a message into a project as a new ticket |
POST /mail/messages/{id}/merge |
Merge a message into an existing ticket at an audience |
POST /mail/messages/{id}/retry |
Retry a paused message |
POST /mail/sends/{id}/resolve |
Resolve a failed outbound send |
Billing configuration and runs
Owner or Admin throughout. Billing runs, voids, period close, and redaction refuse every token in core as well as at the edge.
| Operation | Contract | Purpose |
|---|---|---|
GET /billing/categories, POST /billing/categories, PATCH /billing/categories/{id} |
CategoryList, CategoryInput, CategoryPatch |
Consultant categories |
PUT /billing/members/{id}/category, PUT /projects/{id}/members/{identityId}/category |
{ categoryId } |
Default and per-project category of a person |
GET /settings/billing, PATCH /settings/billing |
BillingSettings, UpdateBillingSettings |
Workspace default policies per kind, period length, reopen window |
GET /clients/{id}/rates, POST /clients/{id}/rates, DELETE /billing/client-rates/{id} |
RateCard, RateInput |
Client rate cards (hourlyRate in integer minor units) |
POST /projects/{id}/rates, DELETE /billing/project-rates/{id} |
RateInput |
Project rate overrides |
GET /clients/{id}/policies, PUT /clients/{id}/policies |
PolicyList, PolicyInput |
Billing policies per kind (paid, free, bank:<id>) at client or project level |
GET /billing/bank-names?clientId= |
{ banks: [{ id, name }] } |
Bank names for the ticket policy picker |
GET /clients/{id}/banks, POST /clients/{id}/banks, PATCH /billing/banks/{id} |
BankList, BankInput, BankPatch |
Time banks |
GET /billing/banks/{id}/ledger, POST /billing/banks/{id}/adjustments |
BankLedger, AdjustmentInput |
Ledger and manual adjustments |
GET /billing/runs?clientId=, GET /billing/runs/{id} |
RunList, Run |
Billing runs |
GET /billing/runs/preview?clientId=&periodId= |
RunPreview |
Blockers, lines, banks, totals before a run (20 per minute, shared with creation) |
POST /billing/runs |
RunInput (clientId, periodId, idempotencyKey 8–200, confirmation) → { id, replayed } |
Create a run; recent re-authentication |
POST /billing/runs/{id}/void |
{ confirmation } → { ok, unresolvedDeliveries } |
Void a run; recent re-authentication |
GET /clients/{id}/document-grants, PUT /clients/{id}/document-grants |
DocumentGrantList |
Client-wide document access for a workspace user |
POST /tickets/{id}/redact |
{ reason } |
Redact a ticket; see Tickets |
GET /resources, GET /exports/resources.xlsx |
ResourceReport |
Resource planning per member and bucket, and its Excel workbook; workspace users, while resource planning is on. See Plan resources |
GET /periods/{id}/reviews, PUT /periods/{id}/reviews/{identityId}, DELETE /periods/{id}/reviews/{identityId} |
PeriodReviews |
Reviewed marks on one member's time in a period; Owner or Admin. See Close a period |
GET /periods, GET /periods/{id}/preview, POST /periods/{id}/close, GET /reports |
see Periods and reports | Period close and reports |
Organisation
Owner only, except reading entitlements and the plan list (Owner or Admin).
| Operation | Contract | Purpose |
|---|---|---|
GET /organization |
Entitlements |
Plan, subscription state, seats used, features, API rate, read-only and deletion dates, the company details (company), and the end of the paid period (currentPeriodEnd, cancelAtPeriodEnd) |
GET /organization/plans |
Plan[] |
The plan catalogue |
PUT /organization/company |
CompanyDetailsInput |
Record the buying company, confirm it is a business, and accept the Terms of Service (recent re-authentication). invalid with reason country_unsupported, org_number_invalid, or registration_number; conflict with terms_outdated |
POST /organization/checkout |
CheckoutRequest → { url } |
Start a subscription (recent re-authentication). planKey, and optionally locale (en or nb) for the Checkout page. conflict with reason company_details_required until the company details are complete |
PUT /organization/invoice |
InvoiceDetails |
Ask to be invoiced instead (recent re-authentication) |
POST /organization/portal |
PortalRequest → { url } |
Open the billing portal |
GET /audit |
WorkspaceAuditRow[] |
The 200 most recent audit rows |
POST /export |
ExportWorkspaceResponse (key, url) |
Build the workspace export package (recent re-authentication, 3 per 10 minutes) |
GET /export/file?key= |
NDJSON stream | Download the latest export |
POST /delete |
DeleteWorkspaceRequest → { deletedAt, purgeAfter } |
Schedule deletion after a recent export (typed slug, recent re-authentication) |
Tickets and time, browser-only parts
| Operation | Purpose |
|---|---|
POST /tickets/{ref}/archive, DELETE /tickets/{ref} |
Archive, restore, delete |
POST /tickets/{ref}/viewers, DELETE /tickets/{ref}/viewers/{identityId}, POST /tickets/{ref}/visibility |
Sharing and the visibility preview |
POST /render |
Markdown preview |
GET /github/links |
Workspace-wide GitHub link list |
DELETE /time/{id}, POST /time/{id}/corrections, POST /time/tickets/{id}/reattribute |
Delete, correct, re-attribute time |
POST /projects, PATCH /projects/{key}, DELETE /projects/{key}, PUT /projects/{key}/members, DELETE /projects/{key}/members/{identityId} |
Project changes |
GET /tokens, DELETE /tokens/{id}, GET /agents, POST /agents, POST /agents/{identityId}/rotate, GET /mcp |
Token registry, agent accounts, MCP setup |
GET /boards, POST /boards, PATCH /boards/{id}, DELETE /boards/{id} |
The caller's saved boards (SavedBoard: name, icon or null, stateIds or null for every state, filters); personal, at most 20. Their contents are read through GET /board with the same stateIds and filters |
Account (/api/me)
Never reachable with a token.
| Operation | Contract | Purpose |
|---|---|---|
GET /api/me, PATCH /api/me |
Me, UpdateProfileRequest |
Profile: name, locale, timezone, notifications |
GET /api/me/photo, POST /api/me/photo, DELETE /api/me/photo |
bytes, multipart file, Me |
Profile photo: fetch, upload (10 per minute), remove |
GET /api/me/sessions, DELETE /api/me/sessions/{id}, POST /api/me/sessions/revoke-others |
SessionList |
Active sessions |
POST /api/me/reauth |
ReauthRequest |
Re-authenticate with the password (20 per minute per address) |
POST /api/me/delete |
DeleteAccountRequest |
Delete the global account (typed email) |
GET /api/me/sso-tests/{state} |
SsoTestResult |
Result of an SSO connection test |
GET /api/me/tokens, POST /api/me/tokens, DELETE /api/me/tokens/{id} |
see API tokens and agents | Personal tokens |
Excel downloads
The Download as Excel buttons on the ticket list, a board, and the Reports page. Each takes the query of the read it mirrors plus locale (en or nb) for the header row, walks the pages server-side, and answers an .xlsx workbook (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet). A workbook holds at most 5 000 rows; the response header x-saq-export-truncated: true says when the selection was longer. Ten downloads per minute per person, one budget for the three. Integrations read the JSON operations instead.
| Operation | Contract | Purpose |
|---|---|---|
GET /exports/tickets.xlsx |
query of GET /tickets, bytes |
One row per ticket, one field per column, in list order |
GET /exports/board.xlsx |
query of GET /board, bytes |
A Board sheet with one column per state and its cards downwards, and a Tickets sheet of every card |
GET /exports/report.xlsx |
query of GET /reports, bytes |
The report rows and a total row; one pair of amount columns per currency (workspace users only) |