FeaturesHow it worksPricingIntegrationsDocsAboutContactSign inStart free
API reference

Clients

Group domains into clients, which is what a limited member is limited to.

  1. GET/v1/domain-groups
  2. POST/v1/domain-groups
  3. DELETE/v1/domain-groups/{id}
GET/v1/domain-groups

List domain groups (with domain counts)

Needs: A signed-in panel session, sent as Authorization: Bearer <access token>.

Responses
StatusBodyWhen
200DomainGroupDto[]
200 body · DomainGroupDto[]
FieldTypeWhat it is
id requiredstring
name requiredstring
color requiredstring | null
domainCount requirednumber
createdAt requiredstring
POST/v1/domain-groups

Create a domain group

Needs: A signed-in panel session, sent as Authorization: Bearer <access token>.

Request body · CreateDomainGroupDto
FieldTypeWhat it is
name requiredstring
colorstring
Responses
StatusBodyWhen
201DomainGroupDto
201 body · DomainGroupDto
FieldTypeWhat it is
id requiredstring
name requiredstring
color requiredstring | null
domainCount requirednumber
createdAt requiredstring
DELETE/v1/domain-groups/{id}

Delete a group (its domains are ungrouped)

Needs: A signed-in panel session, sent as Authorization: Bearer <access token>.

Parameters
NameWhereTypeWhat it is
id requiredpathstring
Responses
StatusBodyWhen
204—

Next groupBanners