Skip to main content
GET
/
api
/
v1
/
settings
/
brand
Get brand settings
curl --request GET \
  --url https://nudgen.net/api/v1/settings/brand \
  --header 'Authorization: Bearer <token>'
{
  "brandName": "<string>",
  "brandDescription": "<string>",
  "brandEmail": "jsmith@example.com",
  "websiteUrl": "<string>",
  "emailLanguage": "<string>",
  "logoUrl": "<string>",
  "brandDesignSystem": {},
  "brandDesignMarkdown": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.nudgen.net/llms.txt

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

Authorizations

​
Authorization
string
header
required

Personal Access Token created from Settings -> API Keys.

Response

200 - application/json

Brand settings

​
brandName
string | null
​
brandDescription
string | null
​
brandEmail
string<email> | null
​
websiteUrl
string<uri> | null
​
emailLanguage
string | null
​
logoUrl
string<uri> | null
​
brandDesignSystem
object
​
brandDesignMarkdown
string | null