GoLink

Domains API

REST API specification for managing, listing, and setting primary branded domains.

Domains API Reference

The Domains API allows you to retrieve registered custom domains for your organization and configure which domain acts as the primary default.

1. List Domains

Fetch all domains connected to the organization, including the default platform domain and link count aggregates.

Request
GET /api/domains HTTP/1.1
Host: golink.buzz
Authorization: Bearer <TOKEN>
x-organization-id: <ORG_ID>

Response (200 OK)

Response
{
  "success": true,
  "domains": [
    {
      "_id": "default",
      "domain": "go.golink.buzz",
      "primary": true,
      "verified": true,
      "linksCount": 35
    },
    {
      "_id": "67b0e8c148201948ba2904ef",
      "organizationId": "org_acme_corp",
      "domain": "links.acme.com",
      "verified": true,
      "primary": false,
      "linksCount": 12,
      "createdAt": "2026-02-15T18:00:00.000Z"
    }
  ]
}

2. Set Primary Domain

Set a designated domain as the primary domain for link creation. When set, all newly created links will pre-select this domain.

Request
PATCH /api/domains/67b0e8c148201948ba2904ef HTTP/1.1
Host: golink.buzz
Authorization: Bearer <TOKEN>
x-organization-id: <ORG_ID>

Response (200 OK)

Response
{
  "success": true,
  "domain": {
    "_id": "67b0e8c148201948ba2904ef",
    "organizationId": "org_acme_corp",
    "domain": "links.acme.com",
    "verified": true,
    "primary": true
  }
}

To reset the default platform domain (go.golink.buzz) as primary, pass default as the :domainId in the URL: PATCH /api/domains/default.

Domain Verification

Newly added custom domains show verified: false until verified by our engineering team. After configuring your DNS CNAME record pointing to cname.golink.buzz, email contact@golink.buzz with your domain name and organization slug to complete verification and SSL certificate provisioning.

Last updated on October 20, 2026

Previous

Links API

Next

Analytics API