Organization API: Organizations & Members

Create and configure reseller organizations, members, roles, and audit log.

View as Markdown

Create and configure reseller organizations, members, roles, and audit log.

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Organization API reference.

Pages in this area

Page	Operations
Audit log	1
Deletion	1
Dns	8
Gameproxy	2
Members	4
Customer link	3
Orgs	2
Settings	3
Staff	15

Operations

Section titled Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}`	Get organization
PATCH	`/api/v1/orgs/{org_slug}`	Update organization
DELETE	`/api/v1/orgs/{org_slug}`	Delete the organization, as its owner

Get organization

Section titled Get organization

GET /api/v1/orgs/{org_slug}

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`slug`	string
`name`	string
`owner_user_id`	integer
`parent_org_id`	integer or null
`tier`	string
`status`	string
`billing_mode`	string
`platform_fee_percent`	string
`max_customers`	integer
`max_services`	integer
`max_sub_resellers`	integer
`max_api_calls_month`	integer
`max_custom_products`	integer
`created_at`	string (date-time) or null
`updated_at`	string (date-time) or null
`my_role`	string or null

Update organization

Section titled Update organization

PATCH /api/v1/orgs/{org_slug}

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`name`	string or null	no
`billing_mode`	string or null	no
`tier`	string or null	no

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`slug`	string
`name`	string
`owner_user_id`	integer
`parent_org_id`	integer or null
`tier`	string
`status`	string
`billing_mode`	string
`platform_fee_percent`	string
`max_customers`	integer
`max_services`	integer
`max_sub_resellers`	integer
`max_api_calls_month`	integer
`max_custom_products`	integer
`created_at`	string (date-time) or null
`updated_at`	string (date-time) or null
`my_role`	string or null

Delete the organization, as its owner

Section titled Delete the organization, as its owner

DELETE /api/v1/orgs/{org_slug}

Delete the organization, as its owner.

It becomes deleted: its storefront, staff console and API stop answering, every staff and customer session into it ends, and it leaves the dashboard of every member. Nothing is erased, and the owner cannot undo it; platform staff can reactivate it, or delete it for good.

confirm must be the organization's slug (case and surrounding spaces do not count), or the answer is 422. While the organization still holds a live product the answer is 409, naming them (GET /deletion lists them with where each ends). 403 for anyone but the owner's own coritan.com session.

Parameters

Section titled Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`confirm`	query	string	yes	The organization's slug, typed by the owner to confirm.

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.