Account & organisation API
35 REST endpoints for account & organisation, each with its parameters, the response it returns and a runnable curl example. Starts with POST…
POST/api/billing/cancelCancel / downgrade
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/billing/checkoutCheckout
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
period | body | JSON request field |
plan | body | JSON request field |
coupon | body | JSON request field |
gateway | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/billing/coupon/checkCreate or update billing coupon check
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
period | body | JSON request field |
plan | body | JSON request field |
code | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/billing/gst-reportGST report for Indian accounting
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/billing/invoice/{id}Invoice (HTML, printable to PDF from the browser)
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/billing/pricingPricing info (used by the pricing page and the upgrade modal)
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/billing/resumeCreate or update billing resume
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/billing/subscriptionGet billing subscription
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/billing/trialA paid-plan trial is a real, time-bounded entitlement. It can be used once per organisation and needs no gateway round trip; attachContext returns the workspace to Free as soon as the end date is reached.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
plan | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/meSession / bootstrap info for the SPA
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/metadataPage metadata fetch (used by the create dialog to auto-fill titles)
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
url | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/org=================================================================== ORGANIZATION ===================================================================
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/orgCreate or update org
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
s3Enabled | body | JSON request field |
billingCountry | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/org/createCreate or update org create
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
name | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/org/detectGet org detect
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
DELETE/api/org/invites/{id}Delete org invites by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/org/invites/{id}/resendCreate or update org invites by ID resend
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
DELETE/api/org/members/{id}Delete org members by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/org/members/{id}/roleCreate or update org members by ID role
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
role | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/org/members/inviteCreate or update org members invite
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
email | body | JSON request field |
role | body | JSON request field |
teamId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/org/switchCreate or update org switch
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
orgId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/profileDelete profile
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
password | body | JSON request field |
confirm | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/profile=================================================================== PROFILE (5 tabs) ===================================================================
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/profile/avatarCreate or update profile avatar
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/profile/emailCreate or update profile email
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
email | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/profile/exportGDPR data export
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/profile/phone/send-otpCreate or update profile phone send otp
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
phone | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/profile/phone/verifyCreate or update profile phone verify
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
code | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/teams=================================================================== TEAMS ===================================================================
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/teamsCreate or update teams
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
name | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/teams/{id}Delete teams by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/teams/{id}Create or update teams by ID
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 5
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
name | body | JSON request field |
enforce2fa | body | JSON request field |
ownerId | body | JSON request field |
saml | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/teams/{id}/domainsCreate or update teams by ID domains
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
domainId | body | JSON request field |
attach | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/teams/{id}/membersCreate or update teams by ID members
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
email | body | JSON request field |
role | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/teams/{id}/members/{userId}Delete teams by ID members :userId
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
userId | path | Required path parameter |
Examples in 22 languages and Try it →