List domain claims — Brigg developers

Access & visibility

Allow workspace.ListDomainClaims on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request

No parameters. Send an empty JSON object ({}).

Response

Returns 200 OK with a JSON body.

This operation has no continuation cursor. An empty items array means no matching visible results were returned.

This is a read-only view of signup routing. Claiming or releasing a domain and changing automatic joining require a person in Brigg Settings; they are not public API operations. A claim is separate from buying a domain or configuring website DNS.

availablearray of stringRequired

Email domains belonging to verified members that this workspace can currently claim. Already claimed domains and domains held by another workspace are excluded. These are email-domain strings, not network policies or domain-registration offers.

auto_joinbooleanRequired

Whether eligible signups from a claimed email domain can automatically join this workspace. A claim and automatic-join consent are separate settings.

itemsarray of Domain claimRequired

Email-domain claims associated with the workspace. This operation has no cursor pagination.

Item fields

domainstringRequired

Email domain claimed by this workspace for member joining.

sourcestringRequired

How the claim was established: primary for the workspace's primary domain, verified_member for a verified-member claim, or admin for an explicit administrator claim.

created_atnumberRequired

Time the claim was created, in Unix milliseconds.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "description": "What the org holds (`claimed`), what it could still take (`available`) and whether auto-join is on. The primary/branding domain is the profile's, not part of this view.",
  "properties": {
    "available": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Email domains belonging to verified members that this workspace can currently claim. Already claimed domains and domains held by another workspace are excluded. These are email-domain strings, not network policies or domain-registration offers."
    },
    "auto_join": {
      "type": "boolean",
      "description": "Whether eligible signups from a claimed email domain can automatically join this workspace. A claim and automatic-join consent are separate settings."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "description": "Email domain claimed by this workspace for member joining.",
            "examples": [
              "example.com"
            ]
          },
          "source": {
            "type": "string",
            "description": "How the claim was established: primary for the workspace's primary domain, verified_member for a verified-member claim, or admin for an explicit administrator claim.",
            "examples": [
              "primary"
            ]
          },
          "created_at": {
            "type": "number",
            "description": "Time the claim was created, in Unix milliseconds.",
            "examples": [
              1794301200000
            ]
          }
        },
        "required": [
          "domain",
          "source",
          "created_at"
        ],
        "additionalProperties": false,
        "title": "Domain claim"
      },
      "description": "Email-domain claims associated with the workspace. This operation has no cursor pagination."
    }
  },
  "required": [
    "items",
    "available",
    "auto_join"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "available": [
        "northstar.example"
      ],
      "auto_join": false,
      "items": [
        {
          "domain": "example.com",
          "source": "primary",
          "created_at": 1794301200000
        }
      ]
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Only items are already claimed. available lists candidates for an administrator to review in Brigg.

Request

cURL

curl 'https://api.brigg.app/v1/operations/workspace.ListDomainClaims' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/workspace.ListDomainClaims", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.ListDomainClaims",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/workspace.ListDomainClaims' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/workspace.ListDomainClaims", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.ListDomainClaims",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "available": [
    "northstar.example"
  ],
  "auto_join": false,
  "items": [
    {
      "domain": "example.com",
      "source": "primary",
      "created_at": 1794301200000
    }
  ]
}

Illustrative values, not a live response.