Skip to main content
GET
/
api
/
public
/
v1
/
config
/
{section}
Read one tenant's publicly readable configuration section
const options = {method: 'GET'};

fetch('{protocol}://{host}/api/public/v1/config/{section}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "section": "<string>",
  "values": {},
  "publishedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
section
string
required

Configuration section id, e.g. widget.

Pattern: ^[a-z][a-z0-9_]*$

Query Parameters

​
publicKey
string
required

The widget's publishable key (also accepted as the X-Comerix-Public-Key header).

Response

Public values of the section

​
section
string
required

The requested section id.

​
values
object
required

Resolved values keyed by full field path, e.g. widget/appearance/accent.

​
publishedAt
string<date-time> | null
required

Publication time of the served edge document; null when the response was computed live.