API reference

Eight endpoints across five resources. Each page documents parameters, request bodies, response fields, and the errors that endpoint can return.

Base URL	`https://api.proxycharm.com/api/v1/public`
Authentication	Bearer API key on every request

All endpoints

Method	Path	Description
GET	`/organization`	Read the organization behind your API key, with its workspaces and members.

Method	Path	Description
GET	`/workspaces`	Every workspace in your organization.
GET	`/workspaces/{account_id}`	Read one workspace by id.
POST	`/workspaces`	Create a workspace, taking an open seat or adding a paid one.
DELETE	`/workspaces/{account_id}`	Retire a workspace and release its IPs.

Method	Path	Description
GET	`/proxies`	Every proxy assignment in the organization, optionally filtered to one workspace.
GET	`/proxies/{assignment_id}`	Read one proxy assignment by id.
GET	`/workspaces/{account_id}/proxies`	Proxies assigned to one workspace.

Method	Path	Description
GET	`/subscription`	Read the live subscription, or null when there is none.

Method	Path	Description
GET	`/invoices`	Paginated billing history, newest first.

The same surface is published as OpenAPI 3.1 if you would rather generate a client than write one. It covers only these public endpoints.

Schema URL

https://api.proxycharm.com/api/v1/public/openapi.json