Skip to main content
GET
/
api
/
settings
/
domain
/
:domain
Get Settings by Custom Domain
curl --request GET \
  --url https://api.example.com/api/settings/domain/:domain
{
  "404": {},
  "500": {},
  "id": "<string>",
  "userId": "<string>",
  "siteName": "<string>",
  "siteDescription": "<string>",
  "customDomain": "<string>",
  "subdomain": "<string>",
  "twitterLink": "<string>",
  "linkedinLink": "<string>",
  "githubLink": "<string>",
  "websiteLink": "<string>",
  "dribbbleLink": "<string>",
  "huggingfaceLink": "<string>",
  "leetcodeLink": "<string>",
  "newsletterEmail": "<string>",
  "domainStatus": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/subratomandal/dyeink/llms.txt

Use this file to discover all available pages before exploring further.

Authentication

No authentication required. This is a public endpoint.

Path Parameters

domain
string
required
The custom domain to look up (e.g., “blog.example.com”)

Response

id
string
Unique identifier for the settings
userId
string
ID of the blog owner
siteName
string
Name of the blog
siteDescription
string
Description of the blog
customDomain
string
The custom domain
subdomain
string
The blog’s subdomain (fallback)
Twitter profile URL (null if not set)
LinkedIn profile URL (null if not set)
GitHub profile URL (null if not set)
Personal website URL (null if not set)
Dribbble profile URL (null if not set)
Hugging Face profile URL (null if not set)
LeetCode profile URL (null if not set)
newsletterEmail
string
Newsletter contact email (null if not set)
domainStatus
string
Custom domain verification status: “pending”, “verified”, “active”, “failed”, or null
createdAt
string
ISO 8601 timestamp of settings creation
updatedAt
string
ISO 8601 timestamp of last update

Example

cURL
curl -X GET https://api.dyeink.com/api/settings/domain/blog.example.com
JavaScript
const response = await fetch('https://api.dyeink.com/api/settings/domain/blog.example.com');
const settings = await response.json();

Response Example

{
  "id": "65abc123def456789",
  "userId": "auth0|123456789",
  "siteName": "My Awesome Blog",
  "siteDescription": "Thoughts on technology and design",
  "customDomain": "blog.example.com",
  "subdomain": "myblog",
  "twitterLink": "https://twitter.com/username",
  "linkedinLink": "https://linkedin.com/in/username",
  "githubLink": "https://github.com/username",
  "websiteLink": "https://example.com",
  "dribbbleLink": null,
  "huggingfaceLink": null,
  "leetcodeLink": null,
  "newsletterEmail": "newsletter@example.com",
  "domainStatus": "active",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Error Responses

404
object
Blog not found
{
  "error": "Blog not found"
}
500
object
Server error
{
  "error": "Failed to get settings"
}
This endpoint performs a case-insensitive lookup. Domain matching ignores case differences.
This endpoint is essential for custom domain resolution. When a request comes in on a custom domain, this endpoint determines which blog to serve.

Build docs developers (and LLMs) love