Skip to main content
GET
/
organization
/
custom-data
Get custom data configuration
curl --request GET \
  --url https://api.getfernand.com/organization/custom-data \
  --header 'X-API-Key: <api-key>'
{
  "endpoint": "https://api.piedpiper.com/customer-data",
  "headers": {
    "Authorization": "Bearer token123",
    "X-API-Key": "key456"
  },
  "template": "<div>{{ customer.name }}</div>",
  "is_enabled": true,
  "test_email": "test@customer.com"
}
Returns the organization’s custom data panel settings.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Response

200 - application/json

Custom data configuration retrieved successfully.

​
endpoint
string<uri>

API endpoint URL to fetch custom data.

Example:

"https://api.piedpiper.com/customer-data"

​
headers
object

Custom HTTP headers for API requests.

Example:
{
  "Authorization": "Bearer token123",
  "X-API-Key": "key456"
}
​
template
string

Jinja2 template for rendering custom data.

Example:

"<div>{{ customer.name }}</div>"

​
is_enabled
boolean

Whether custom data panel is enabled.

Example:

true

​
test_email
string<email>

Test email address for template validation.

Example:

"test@customer.com"