| GET | /api/v1/public/workspaces | List the workspaces the signed-in user belongs to |
| POST | /api/v1/public/workspaces | Create a workspace owned by the signed-in user |
| GET | /api/v1/public/workspaces/features | List the workspace features members can toggle |
| PATCH | /api/v1/public/workspaces/settings | Refuses a change to the organization's workspace settings |
| GET | /api/v1/public/workspaces/{workspaceId} | Get one workspace the signed-in user belongs to |
| PUT | /api/v1/public/workspaces/{workspaceId} | Update a workspace's name or image |
| DELETE | /api/v1/public/workspaces/{workspaceId} | Delete a workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/affiliate-programs | List the workspace's affiliate programs |
| POST | /api/v1/public/workspaces/{workspaceId}/affiliate-programs | Create an affiliate program for the workspace's items |
| POST | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/approve | Approve a pending affiliate of one of the workspace's programs |
| POST | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/ban | Ban an affiliate of one of the workspace's programs |
| POST | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/pause | Pause an active affiliate of one of the workspace's programs |
| POST | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/affiliates/{id}/resume | Resume a paused affiliate of one of the workspace's programs |
| GET | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/payouts/wise.csv | Download the Wise batch file of the workspace's pending Wise payouts |
| POST | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/payouts/{id}/mark-paid | Mark a manual or Wise payout as paid |
| GET | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/payouts/{id}/wise.csv | Download the Wise batch file of one pending Wise payout |
| GET | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id} | Get one of the workspace's affiliate programs |
| PATCH | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id} | Update one of the workspace's affiliate programs |
| DELETE | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id} | Delete one of the workspace's affiliate programs |
| GET | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/affiliates | List the affiliates of one of the workspace's programs |
| POST | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/affiliates | Add a person to an affiliate program directly (refused for workspaces) |
| GET | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/commissions | List the commissions of one of the workspace's programs |
| POST | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/invitations | Invite a person to one of the workspace's affiliate programs |
| GET | /api/v1/public/workspaces/{workspaceId}/affiliate-programs/{id}/payouts | List the payouts of one of the workspace's programs |
| POST | /api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/cancel | Remove a recurring add-on from the workspace subscription |
| POST | /api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/cancel/preview | Preview removing a recurring add-on |
| POST | /api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/decrease | Lower the quantity of a recurring add-on |
| POST | /api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/decrease/preview | Preview lowering the quantity of a recurring add-on |
| POST | /api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/future-versions | Opt a lifetime add-on out of or back into future versions |
| GET | /api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/upgrade | Quote upgrading a one-time or lifetime add-on to its current version |
| POST | /api/v1/public/workspaces/{workspaceId}/billing/add-ons/{grantId}/upgrade | Upgrade a one-time or lifetime add-on to its current version |
| POST | /api/v1/public/workspaces/{workspaceId}/billing/checkout | Buy an add-on for the workspace |
| POST | /api/v1/public/workspaces/{workspaceId}/billing/checkout/preview | Preview the cost of buying a recurring add-on |
| GET | /api/v1/public/workspaces/{workspaceId}/billing/offers | List the add-ons on sale to the workspace |
| POST | /api/v1/public/workspaces/{workspaceId}/billing/payment-method/default | Make a saved card the workspace's default payment method |
| POST | /api/v1/public/workspaces/{workspaceId}/billing/payment-method/setup | Start a card setup for the workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/calendars | List the workspace's shared booking calendars |
| POST | /api/v1/public/workspaces/{workspaceId}/calendars | Create a shared booking calendar for the workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/calendars/{id} | Get one of the workspace's calendars with the items booked on it |
| PUT | /api/v1/public/workspaces/{workspaceId}/calendars/{id} | Replace a calendar's name, grid and settings |
| DELETE | /api/v1/public/workspaces/{workspaceId}/calendars/{id} | Delete a calendar that no item is booked on |
| GET | /api/v1/public/workspaces/{workspaceId}/coupons | List the workspace's coupons |
| POST | /api/v1/public/workspaces/{workspaceId}/coupons | Create a coupon for the workspace's items |
| GET | /api/v1/public/workspaces/{workspaceId}/coupons/{id} | Get one of the workspace's coupons |
| PATCH | /api/v1/public/workspaces/{workspaceId}/coupons/{id} | Update the terms of one of the workspace's coupons |
| DELETE | /api/v1/public/workspaces/{workspaceId}/coupons/{id} | Delete one of the workspace's coupons |
| GET | /api/v1/public/workspaces/{workspaceId}/credits | Get the workspace's credit balance |
| GET | /api/v1/public/workspaces/{workspaceId}/credits/auto-top-up | Get the workspace's automatic credit top-up setting |
| PATCH | /api/v1/public/workspaces/{workspaceId}/credits/auto-top-up | Update the workspace's automatic credit top-up setting |
| GET | /api/v1/public/workspaces/{workspaceId}/credits/buckets | List the workspace's credit buckets |
| POST | /api/v1/public/workspaces/{workspaceId}/credits/consume | Consume credits from the workspace balance |
| GET | /api/v1/public/workspaces/{workspaceId}/credits/expiring | List credits expiring soon |
| GET | /api/v1/public/workspaces/{workspaceId}/credits/holds | List the workspace's credit holds |
| POST | /api/v1/public/workspaces/{workspaceId}/credits/holds/{holdId}/release | Release a credit hold in full |
| POST | /api/v1/public/workspaces/{workspaceId}/credits/holds/{holdId}/settle | Settle a credit hold at its final cost |
| GET | /api/v1/public/workspaces/{workspaceId}/credits/packages | List the credit packages on sale |
| POST | /api/v1/public/workspaces/{workspaceId}/credits/payment-method-setup | Start a Stripe page that saves a card for credit top-ups |
| POST | /api/v1/public/workspaces/{workspaceId}/credits/purchase | Start a Stripe Checkout session for a credit package |
| POST | /api/v1/public/workspaces/{workspaceId}/credits/reserve | Put workspace credits on hold |
| GET | /api/v1/public/workspaces/{workspaceId}/credits/transactions | List the workspace's credit transactions |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise | Get the enterprise SSO status of a workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/admins | List the company admins and their company roles |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/admins | Name a company admin |
| PATCH | /api/v1/public/workspaces/{workspaceId}/enterprise/admins/{userId} | Change a company admin's company role |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/admins/{userId} | Remove a company admin |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/agent-access | Get the company's agent access settings |
| PATCH | /api/v1/public/workspaces/{workspaceId}/enterprise/agent-access | Turn agent access on or off, or change its token lifetime |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/agent-access/check | Re-read the agent issuer's discovery document and keys |
| PUT | /api/v1/public/workspaces/{workspaceId}/enterprise/agent-access/issuer | Set the identity provider trusted to approve agents |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/agent-access/issuer | Stop trusting the company's agent issuer |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/audit | List the company's sign-in audit trail |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/audit/export | Export the company's audit trail as CSV |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/audit/exports | Request an export of the company's WorkOS audit log |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/audit/exports/{exportId} | Get a WorkOS audit log export and its download link |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/claim | Bring accounts on the company's domains into the company |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/connected-apps | List the apps and agents the company's people have connected |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/connected-apps/revoke | Disconnect an app or agent for one person or the whole company |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/connected-apps/{clientId} | List one app's grants among the company's people |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/domains/sync | Re-read the company's verified domains from WorkOS |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/groups | List the company's groups |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/groups | Create a company group |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId} | Get a company group |
| PATCH | /api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId} | Update a company group's name, people, workspaces or role |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId} | Delete a company group |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/candidates | Search the company's people who can be added to a group |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/managers | Name a group manager |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/managers/{userId} | Remove a group manager |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/members | Add or remove the people named in a group |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/groups/{groupId}/people | List the people in a group |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/insights | Get the company's identity insights |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/join-requests | List requests to join the company |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/join-requests/{requestId}/approve | Approve a request to join the company |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/join-requests/{requestId}/decline | Decline a request to join the company |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/keys | List the company's API keys |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/keys | Create a company API key |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/keys/{keyId} | Revoke a company API key |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/log-stream | Get the company's WorkOS log stream |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/log-streams | List the company's log streams to its SIEM |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/log-streams | Add a log stream for the company |
| PATCH | /api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId} | Update one of the company's log streams |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId} | Remove one of the company's log streams |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId}/rotate-secret | Rotate a log stream's signing secret |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/log-streams/{streamId}/test | Send a test event to one of the company's log streams |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/outsiders | List members of the company's workspaces who are outside the company |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/people | List the company's people, newest first |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/people/{userId}/passkeys/reset | Reset a person's passkeys and sign them out |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/people/{userId}/sessions | List one of the company's people's live sessions |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/people/{userId}/sessions/{sessionRef} | End one of a person's sessions |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/policy | Get the company's access policy |
| PUT | /api/v1/public/workspaces/{workspaceId}/enterprise/policy | Update the company's access policy |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces | List the company's per-workspace policy exceptions |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces/{targetId} | Get the stricter policy for one of the company's workspaces |
| PUT | /api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces/{targetId} | Set the stricter policy for one of the company's workspaces |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/policy/workspaces/{targetId} | Remove a workspace's policy exception |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/roles | List the roles the company can give, with who holds each |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/roles | Create a company role |
| PATCH | /api/v1/public/workspaces/{workspaceId}/enterprise/roles/{roleId} | Rename a company role or change what it allows |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/roles/{roleId} | Delete a company role |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/service-accounts | List the company's service accounts |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/service-accounts | Create a service account for the company |
| PATCH | /api/v1/public/workspaces/{workspaceId}/enterprise/service-accounts/{serviceAccountId} | Update one of the company's service accounts |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/service-accounts/{serviceAccountId} | Delete a service account and revoke its keys |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/setup-link | Create a short-lived setup link for the company's IT admin |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/sign-out | Sign out one or all of the company's people |
| PUT | /api/v1/public/workspaces/{workspaceId}/enterprise/sso/routing | Replace which identity provider signs in each verified domain |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/unclaimed | List accounts on the company's domains that are not its people yet |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity | List the company's workload credentials and exchange details |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/check | Dry-run an issuer's discovery and keys for a workload credential |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/credentials | Trust a CI job or cloud workload for a company service account |
| PATCH | /api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/credentials/{credentialId} | Update a workload credential |
| DELETE | /api/v1/public/workspaces/{workspaceId}/enterprise/workload-identity/credentials/{credentialId} | Delete a workload credential and end its live tokens |
| GET | /api/v1/public/workspaces/{workspaceId}/enterprise/workos-roles | Get the company's WorkOS roles sync status |
| POST | /api/v1/public/workspaces/{workspaceId}/enterprise/workos-roles/refresh | Refresh the company's roles from WorkOS |
| GET | /api/v1/public/workspaces/{workspaceId}/features | Get the workspace's feature flags |
| PATCH | /api/v1/public/workspaces/{workspaceId}/features | Toggle the workspace's user-managed features |
| GET | /api/v1/public/workspaces/{workspaceId}/files | List the workspace's files for buyers |
| POST | /api/v1/public/workspaces/{workspaceId}/files/uploads | Start an upload of a file for buyers |
| POST | /api/v1/public/workspaces/{workspaceId}/files/uploads/{uploadId}/complete | Finish a file upload and return the stored file |
| GET | /api/v1/public/workspaces/{workspaceId}/files/{fileId} | Get one of the workspace's files for buyers |
| DELETE | /api/v1/public/workspaces/{workspaceId}/files/{fileId} | Delete a file that no release holds |
| GET | /api/v1/public/workspaces/{workspaceId}/grants | List what the workspace holds beyond its plan |
| GET | /api/v1/public/workspaces/{workspaceId}/invitations | List the workspace's invitations |
| POST | /api/v1/public/workspaces/{workspaceId}/invitations | Invite someone to the workspace by email |
| DELETE | /api/v1/public/workspaces/{workspaceId}/invitations/{id} | Revoke a pending invitation |
| POST | /api/v1/public/workspaces/{workspaceId}/invitations/{id}/resend | Send an invitation email again |
| GET | /api/v1/public/workspaces/{workspaceId}/items | List the workspace's items |
| POST | /api/v1/public/workspaces/{workspaceId}/items | Create a draft item sold by the workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/items/{id} | Get one of the workspace's items |
| PUT | /api/v1/public/workspaces/{workspaceId}/items/{id} | Replace the content of one of the workspace's items |
| DELETE | /api/v1/public/workspaces/{workspaceId}/items/{id} | Delete an item that was never listed or sold |
| POST | /api/v1/public/workspaces/{workspaceId}/items/{id}/archive | Archive one of the workspace's items |
| POST | /api/v1/public/workspaces/{workspaceId}/items/{id}/booking/calendar-move | Move an item's upcoming bookings onto one of the workspace's calendars |
| POST | /api/v1/public/workspaces/{workspaceId}/items/{id}/booking/calendar-move/preview | Preview moving an item's bookings onto one of the workspace's calendars |
| POST | /api/v1/public/workspaces/{workspaceId}/items/{id}/publish | Publish one of the workspace's items, or submit it for review |
| POST | /api/v1/public/workspaces/{workspaceId}/items/{id}/unlist | Unlist one of the workspace's items |
| GET | /api/v1/public/workspaces/{workspaceId}/limits/{slug} | Get one of the workspace's limits and its claims standing |
| POST | /api/v1/public/workspaces/{workspaceId}/limits/{slug}/claim | Claim one unit of a workspace limit for a resource |
| GET | /api/v1/public/workspaces/{workspaceId}/limits/{slug}/claims | List the active claims on a workspace limit |
| POST | /api/v1/public/workspaces/{workspaceId}/limits/{slug}/release | Release a claim on a workspace limit |
| GET | /api/v1/public/workspaces/{workspaceId}/notification-events | List the notification events members can manage |
| GET | /api/v1/public/workspaces/{workspaceId}/notification-preferences | Get the workspace's default notification preferences |
| PATCH | /api/v1/public/workspaces/{workspaceId}/notification-preferences | Update the workspace's default notification preferences |
| GET | /api/v1/public/workspaces/{workspaceId}/notification-preferences/me | Get the caller's own notification preferences in the workspace |
| PATCH | /api/v1/public/workspaces/{workspaceId}/notification-preferences/me | Update the caller's own notification preferences in the workspace |
| DELETE | /api/v1/public/workspaces/{workspaceId}/notifications/scheduled/{scheduledId} | Cancel a scheduled notification send |
| POST | /api/v1/public/workspaces/{workspaceId}/notifications/send | Send a notification event to one member or the whole workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/permissions | Get the workspace's permission overrides by role |
| PATCH | /api/v1/public/workspaces/{workspaceId}/permissions | Set the workspace's permission overrides by role |
| GET | /api/v1/public/workspaces/{workspaceId}/permissions/me | Get the permissions the caller holds in the workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/quotas/{slug} | Get the workspace's standing on one quota |
| PATCH | /api/v1/public/workspaces/{workspaceId}/quotas/{slug} | Set the workspace's spend cap and partition caps on a quota |
| GET | /api/v1/public/workspaces/{workspaceId}/releases | List the workspace's file releases |
| POST | /api/v1/public/workspaces/{workspaceId}/releases | Create a draft file release for the workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/releases/{id} | Get one of the workspace's file releases |
| PATCH | /api/v1/public/workspaces/{workspaceId}/releases/{id} | Update a file release |
| DELETE | /api/v1/public/workspaces/{workspaceId}/releases/{id} | Delete a draft file release |
| POST | /api/v1/public/workspaces/{workspaceId}/releases/{id}/publish | Publish a draft file release |
| GET | /api/v1/public/workspaces/{workspaceId}/sales | List the workspace's sales as a seller |
| GET | /api/v1/public/workspaces/{workspaceId}/sales/bookings | List the bookings made on the workspace's items |
| GET | /api/v1/public/workspaces/{workspaceId}/sales/bookings/{id} | Get a booking made on one of the workspace's items |
| PUT | /api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}/attendance | Mark whether the buyer attended a booking, or clear it |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}/cancel | Cancel a booking made on one of the workspace's items |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/bookings/{id}/reschedule | Move a booking to another slot of its item |
| GET | /api/v1/public/workspaces/{workspaceId}/sales/export | Export the workspace's sales as a CSV file |
| GET | /api/v1/public/workspaces/{workspaceId}/sales/subscriptions | List the subscriptions the workspace has sold |
| GET | /api/v1/public/workspaces/{workspaceId}/sales/subscriptions/{id} | Get a subscription the workspace has sold |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/subscriptions/{id}/cancel | Cancel a subscription the workspace has sold |
| GET | /api/v1/public/workspaces/{workspaceId}/sales/{id} | Get one of the workspace's sales |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/{id}/lines/{lineKey}/fulfil | Mark a sale's line fulfilled or in progress |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/{id}/parts/{index}/charge | Charge the balance of a sale paid by deposit |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/{id}/refund | Refund one of the workspace's sales |
| GET | /api/v1/public/workspaces/{workspaceId}/sales/{id}/returns | List the returns requested on one of the workspace's sales |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/{id}/returns/{returnId}/approve | Approve a requested return on one of the workspace's sales |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/{id}/returns/{returnId}/refund | Refund a return on one of the workspace's sales |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/{id}/returns/{returnId}/reject | Reject a requested return on one of the workspace's sales |
| GET | /api/v1/public/workspaces/{workspaceId}/sales/{id}/shipments | List the shipments of one of the workspace's sales |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/{id}/shipments | Create a shipment for one of the workspace's sales |
| GET | /api/v1/public/workspaces/{workspaceId}/sales/{id}/shipments/{shipmentId}/label | Download a shipment's label |
| POST | /api/v1/public/workspaces/{workspaceId}/sales/{id}/shipments/{shipmentId}/status | Set a shipment's status by hand |
| GET | /api/v1/public/workspaces/{workspaceId}/selling | Get the workspace's seller account and the app's selling settings |
| POST | /api/v1/public/workspaces/{workspaceId}/selling | Start selling as the workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/selling/co-sellers | List the workspace's co-seller invitations |
| POST | /api/v1/public/workspaces/{workspaceId}/selling/co-sellers | Invite another seller to share an item's sales |
| POST | /api/v1/public/workspaces/{workspaceId}/selling/co-sellers/{invitationId}/accept | Accept a co-seller invitation sent to the workspace |
| POST | /api/v1/public/workspaces/{workspaceId}/selling/co-sellers/{invitationId}/decline | Decline a co-seller invitation sent to the workspace |
| POST | /api/v1/public/workspaces/{workspaceId}/selling/co-sellers/{invitationId}/withdraw | Withdraw a co-seller invitation the workspace sent |
| POST | /api/v1/public/workspaces/{workspaceId}/selling/debit-terms/accept | Accept the app owner's account debit terms for the workspace |
| POST | /api/v1/public/workspaces/{workspaceId}/selling/session | Create a Stripe embedded components session for the seller |
| GET | /api/v1/public/workspaces/{workspaceId}/selling/shipping | Get the workspace's seller shipping settings |
| PUT | /api/v1/public/workspaces/{workspaceId}/selling/shipping | Save the workspace's seller shipping settings |
| POST | /api/v1/public/workspaces/{workspaceId}/selling/sync | Refresh the workspace's seller account from Stripe |
| GET | /api/v1/public/workspaces/{workspaceId}/selling/tax | Get the workspace's own tax choice as a seller |
| PUT | /api/v1/public/workspaces/{workspaceId}/selling/tax | Choose whether Stripe Tax works out the tax on the workspace's sales |
| GET | /api/v1/public/workspaces/{workspaceId}/shipping-rates | List the workspace's shipping rates |
| POST | /api/v1/public/workspaces/{workspaceId}/shipping-rates | Create a shipping rate for the workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/shipping-rates/{id} | Get one of the workspace's shipping rates |
| PUT | /api/v1/public/workspaces/{workspaceId}/shipping-rates/{id} | Replace one of the workspace's shipping rates |
| DELETE | /api/v1/public/workspaces/{workspaceId}/shipping-rates/{id} | Delete one of the workspace's shipping rates |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription | Get the workspace's current subscription, plan and capabilities |
| PATCH | /api/v1/public/workspaces/{workspaceId}/subscription | Change the workspace's plan |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/billing-contacts | List the workspace's billing contacts |
| PUT | /api/v1/public/workspaces/{workspaceId}/subscription/billing-contacts | Replace the workspace's billing contacts |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/billing-portal | Create a Stripe Customer Portal session for the workspace |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/cancel-at-period-end | Cancel the workspace's subscription at the end of the billing period |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/cancel-now | Cancel the workspace's subscription immediately |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/checkout | Create a Stripe checkout session for the workspace |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/convert-to-paid | End the workspace's trial now and pay for the plan |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/invoices | List the workspace's invoices |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/invoices/{invoiceId} | Get one of the workspace's invoices |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/invoices/{invoiceId}/pay | Pay an open invoice of the workspace's subscription |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/move-to-user | Move the workspace's plan onto the signed-in user |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/pause | Pause the workspace's subscription after the paid period ends |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/plan-group | Get the plan group shown in the workspace's plan picker |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/plan-group/versions | List the workspace's plan group version and any newer versions |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/preview | Preview what a plan change or ending the trial now will cost |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/resume | Resume the workspace's subscription |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/retention-offer | Get what the cancel dialog shows before cancelling |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/retention-offer/accept | Accept the retention offer instead of cancelling |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/select-free-plan | Put the workspace on a free plan without checkout |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/transfer-payer | Move the workspace's subscription to another payer |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/trial-eligibility | Check whether the signed-in user would get a trial in this workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/upcoming-invoice | Get the workspace's next invoice |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/usage | Record quota usage for the workspace |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/usage/all | Get usage status for every quota of the workspace |
| POST | /api/v1/public/workspaces/{workspaceId}/subscription/usage/batch | Record several quota usage entries in one request |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/usage/logs | List the workspace's usage log entries |
| GET | /api/v1/public/workspaces/{workspaceId}/subscription/usage/status | Get the usage status of one quota |
| GET | /api/v1/public/workspaces/{workspaceId}/users | List the members of a workspace |
| POST | /api/v1/public/workspaces/{workspaceId}/users/add | Add a user to the workspace by email, or invite them |
| PATCH | /api/v1/public/workspaces/{workspaceId}/users/{userId} | Change a member's role |
| DELETE | /api/v1/public/workspaces/{workspaceId}/users/{userId} | Remove a member from the workspace, or leave it |