Recomly APIEndpoints
Get branding
Retrieve the organization's current branding settings.
GET /api/app/branding
Returns the organization's current branding configuration — logo URL, primary color, and social media handles. Returns null for branding if no branding has been saved yet.
Requires the customBranding feature entitlement.
Request
See API Basics for required headers.
This endpoint takes no request body or query parameters.
Sample request
curl https://api.recomly.com/api/app/branding \
-H "Authorization: Bearer rk_live_abc123:def456"Sample response
Status: 200 OK
{
"branding": {
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"updatedAt": "2026-04-07T18:30:00.000Z",
"primaryColor": "#2563eb",
"logoUrl": "https://app.recomly.com/logos/a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0/1744051800000-550e8400-e29b-41d4-a716-446655440000.png",
"instagram": "mybusiness",
"twitterX": "mybusiness",
"facebook": "https://facebook.com/mybusiness",
"nextdoor": "https://nextdoor.com/pages/mybusiness"
}
}When no branding has been configured:
{
"branding": null
}Response fields
| Field | Type | Description |
|---|---|---|
orgId | string | Your organization ID. |
updatedAt | string (ISO 8601) | When branding was last saved. |
primaryColor | string | Hex color used for buttons and accents on hosted pages. Omitted if not set. |
logoUrl | string | CDN URL of the uploaded logo. Omitted if no logo is set. |
instagram | string | Instagram handle without the leading @. Omitted if not set. |
twitterX | string | X (Twitter) handle without the leading @. Omitted if not set. |
facebook | string | Facebook page URL. Omitted if not set. |
nextdoor | string | Nextdoor business page URL. Omitted if not set. |
Error responses
See API Basics for standard status codes and error response format.
| Status | When |
|---|---|
403 Forbidden | Caller does not have the admin role, or the customBranding feature is not enabled for this organization. |