Organizations

12 endpoints

GET /organizations

List Orgs

List organizations the current user belongs to.

Parameters:

Response:

`any`

POST /organizations

Create Org

Create a new organization and add the current user as admin.

Parameters:

Request body:

{
  name: `string`
  description?: `string` | `null`
}

Response:

`any`

GET /organizations/\{org_id\}

Get Org

Parameters:

Response:

`any`

PUT /organizations/\{org_id\}

Update Org

Parameters:

Request body:

{
  name?: `string` | `null`
  description?: `string` | `null`
  active?: `boolean` | `null`
}

Response:

`any`

DELETE /organizations/\{org_id\}

Delete Org

Parameters:

Response:

`any`

GET /organizations/\{org_id\}/members

Get Members

List all members of an organization.

Parameters:

Response:

`any`

POST /organizations/\{org_id\}/members

Add Org Member

Add a user to the organization by email.

Parameters:

Request body:

{
  email: `string`
}

Response:

`any`

DELETE /organizations/\{org_id\}/members/\{user_id\}

Remove Org Member

Remove a user from the organization.

Parameters:

Response:

`any`

GET /organizations/\{org_id\}/license

Get License

Get the organization’s license. No license = free plan.

Parameters:

Response:

`any`

PUT /organizations/\{org_id\}/license

Assign License

Assign a license to the organization (replaces any existing one).

Parameters:

Request body:

{
  license_id: `string`
}

Response:

`any`

DELETE /organizations/\{org_id\}/license

Unassign License

Remove the license from the organization (downgrade to free plan).

Parameters:

Response:

`any`

GET /organizations/\{org_id\}/deployments

Get Org Deployments

List all deployments for the organization (via its license).

Parameters:

Response:

`any`