Skip to main content
GET
/
api
/
settings
/
subdomain
/
:subdomain
Get Settings by Subdomain
curl --request GET \
  --url https://api.example.com/api/settings/subdomain/:subdomain
{
  "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

​
subdomain
string
required
The subdomain to look up (e.g., “myblog” from myblog.dyeink.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
Custom domain if configured (null otherwise)
​
subdomain
string
The blog’s subdomain
​
twitterLink
string
Twitter profile URL (null if not set)
​
linkedinLink
string
LinkedIn profile URL (null if not set)
​
githubLink
string
GitHub profile URL (null if not set)
​
websiteLink
string
Personal website URL (null if not set)
​
dribbbleLink
string
Dribbble profile URL (null if not set)
​
huggingfaceLink
string
Hugging Face profile URL (null if not set)
​
leetcodeLink
string
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/subdomain/myblog
JavaScript
const response = await fetch('https://api.dyeink.com/api/settings/subdomain/myblog');
const settings = await response.json();

​
Response Example

{
  "id": "65abc123def456789",
  "userId": "auth0|123456789",
  "siteName": "My Awesome Blog",
  "siteDescription": "Thoughts on technology and design",
  "customDomain": null,
  "subdomain": "myblog",
  "twitterLink": "https://twitter.com/username",
  "linkedinLink": "https://linkedin.com/in/username",
  "githubLink": "https://github.com/username",
  "websiteLink": null,
  "dribbbleLink": null,
  "huggingfaceLink": null,
  "leetcodeLink": null,
  "newsletterEmail": "newsletter@myblog.com",
  "domainStatus": null,
  "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 is useful for resolving subdomain-based blogs to their settings and metadata. It’s commonly used for rendering the public blog view.