REST API

The Soxom dashboard is backed by an HTTP API rooted at /api/v1. This page documents those endpoints for reference — for understanding how the system fits together, for debugging, and for support conversations.

Caution

The API is not currently designed for programmatic use. Every endpoint requires a WorkOS-sealed session cookie, which is set when you sign in through the web app and is not suitable for CI, scripts, or third-party integrations. If you need automation, talk to us about your use case.

The API base URL depends on your deployment — substitute your Soxom API base URL for https://api.example.com in the snippets below.

Authentication

All endpoints authenticate via the user-session cookie set by the WorkOS sign-in flow.

Conventions

• All paths live under /api/v1.
• Requests and responses are JSON.
• Standard HTTP status codes: 200/201 on success, 400 for malformed input, 401 for missing auth, 403 for unauthorized, 404 for missing resources, 422 for validation errors, 5xx for server errors.
• Resource paths follow REST conventions (GET to read, POST to create or trigger, PATCH to update, DELETE to remove).

Note

Webhook endpoints under /api/v1/webhooks/* are reserved for GitHub and Stripe to call into Soxom. They are not intended for user consumption.

Organizations

Method	Path	Purpose
GET	/api/v1/auth/me	Current user and active Organization context (cookie auth).
GET	/api/v1/organizations	List Organizations the current user belongs to.
POST	/api/v1/organizations/switch	Switch the active Organization for the current session.
GET	/api/v1/members	List members of the active Organization.

Projects

Method	Path	Purpose
GET	/api/v1/projects	List Projects in the active Organization.
POST	/api/v1/projects	Create a Project and its config repository.
GET	/api/v1/projects/:id	Get a single Project.
PATCH	/api/v1/projects/:id	Update a Project.
DELETE	/api/v1/projects/:id	Delete a Project.

SDK Targets

Method	Path	Purpose
GET	/api/v1/projects/:projectId/sdk-targets	List SDK Targets for a Project.
POST	/api/v1/projects/:projectId/sdk-targets	Create an SDK Target. Provisions a Staging Repository and a Production Repository.
GET	/api/v1/projects/:projectId/sdk-targets/:id	Get a single SDK Target.
PATCH	/api/v1/projects/:projectId/sdk-targets/:id	Update an SDK Target.
DELETE	/api/v1/projects/:projectId/sdk-targets/:id	Delete an SDK Target.

Builds

Method	Path	Purpose
GET	/api/v1/projects/:projectId/sdk-targets/:id/sdk-builds	List SDK builds.
POST	/api/v1/projects/:projectId/sdk-targets/:id/sdk-builds/trigger	Manually trigger a new build.
POST	/api/v1/projects/:projectId/sdk-targets/:id/sdk-builds/:buildId/retry	Retry a failed build.

Releases

Method	Path	Purpose
GET	/api/v1/projects/:projectId/sdk-targets/:id/staging-releases	List staging releases.
POST	/api/v1/projects/:projectId/sdk-targets/:id/staging-releases	Create a staging release.
GET	/api/v1/projects/:projectId/sdk-targets/:id/releases	List production releases.
POST	/api/v1/projects/:projectId/sdk-targets/:id/releases	Create a production release and publish it.

GitHub

Method	Path	Purpose
GET	/api/v1/github/installations	List GitHub App installations connected to the Organization.
POST	/api/v1/github/installations/install	Start the GitHub App install flow.

Members

Method	Path	Purpose
GET	/api/v1/members	List members of the active Organization.

Billing

Method	Path	Purpose
GET	/api/v1/billing/plan	Current plan and usage for the active Organization.
POST	/api/v1/billing/checkout	Start a Stripe Checkout session.
POST	/api/v1/billing/portal	Open the Stripe Customer Portal.

Example request

For reference, the request shape is a normal cookie-authenticated JSON call:

curl -X POST "https://api.example.com/api/v1/projects/abc/sdk-targets/xyz/sdk-builds/trigger" \
  -H "Cookie: user-session=<session-cookie-from-browser>"

The same action in the dashboard — clicking Trigger build on an SDK Target — issues this request for you, with no cookie handling required.