Aula is in early access. These docs grow as it does.
Skip to Content
Aula
API ReferenceSite config

Read the site config

Needs a `site:read` token.

GET
/api/v1/site-config

Needs a site:read token.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Response Body

The stored site, as the dashboard exports it.

application/json
  1. response
version*number
identity?
design?
locale?
classPolicy?
fees?
faq?array<>

Questions and answers in page order; each question and answer takes a string or a map from locale to string.

Itemsitems <= 12
sections?array<|||||||||||>

The home's blocks in page order; hero, teachers, about and faq read their text from identity and faq. Headings, rich text bodies, call to action text and labels, and image alt text and captions take a string or a map from locale to string. An image's key is the storage key of an image this school uploaded, never a URL.

Itemsitems <= 30
navigation?

Header and footer links in order; sign in, the locale switcher and Aula's own links always show besides them.

pages?array<>

The school's own pages in order, each served at its slug with blocks as in sections. Titles and descriptions take a string or a map from locale to string. A slug is unique and never one of Aula's own paths.

Itemsitems <= 20
emails?

The school's own email text: a footer of address, contact and policy lines, and per email kind and locale a subject, heading, body and call to action label with the placeholders each kind allows. Plain text; a body link is label. Left out, an email keeps Aula's text. The document replaces the stored text as a whole.

sites?array<>

The school's extra branded sites in order, each with its own name, design and the part of the offer it shows: lesson types and classes by id, and lesson types by subject. The list replaces the stored one as a whole: a key left out archives that site and naming it again restores it. A design token left out is Aula's default.

Itemsitems <= 10
domain?|

Exported for reference; an import never changes it.

Example Request
curl -X GET 'https://aula.sferarc.com/api/v1/site-config'
Example Response
{  "version": 1,  "identity": {    "name": "string",    "tagline": "string",    "about": "string",    "translations": {      "tagline": {        "property1": "string",        "property2": "string"      },      "about": {        "property1": "string",        "property2": "string"      }    },    "logo": "string",    "darkLogo": "string",    "mark": "string"  },  "design": {    "accentColor": "string",    "background": "string",    "secondary": "string",    "radius": "none",    "headingFont": "instrument-sans",    "bodyFont": "instrument-sans",    "textSize": "medium",    "buttonStyle": "solid"  },  "locale": {    "defaultLocale": "en",    "timeZone": "string",    "currency": "EUR"  },  "classPolicy": {    "makeupNoticeHours": 0,    "makeupValidDays": 1,    "makeupCapPerTerm": 1,    "makeupSameLessonType": true  },  "fees": {    "feeDay": 1,    "firstMonth": "prorated",    "returnedDebitFee": 1  },  "faq": [    {      "question": "string",      "answer": "string"    }  ],  "sections": [    {      "type": "hero",      "enabled": true,      "heading": "string",      "text": "string",      "label": "string",      "href": "string"    }  ],  "navigation": {    "header": [      {        "kind": "builtin",        "target": "teachers",        "label": null      }    ],    "footer": [      {        "kind": "builtin",        "target": "teachers",        "label": null      }    ]  },  "pages": [    {      "slug": "string",      "title": "string",      "description": null,      "sections": [        {          "type": "hero",          "enabled": true,          "heading": "string",          "text": "string",          "label": "string",          "href": "string"        }      ]    }  ],  "emails": {    "footer": {      "address": "string",      "contact": "string",      "policy": "string"    },    "kinds": {      "property1": {        "property1": {          "subject": "string",          "heading": "string",          "body": "string",          "cta": "string"        },        "property2": {          "subject": "string",          "heading": "string",          "body": "string",          "cta": "string"        }      },      "property2": {        "property1": {          "subject": "string",          "heading": "string",          "body": "string",          "cta": "string"        },        "property2": {          "subject": "string",          "heading": "string",          "body": "string",          "cta": "string"        }      }    }  },  "sites": [    {      "key": "string",      "identity": {        "name": "string",        "tagline": "string",        "about": "string",        "logo": "string",        "darkLogo": "string",        "mark": "string"      },      "design": {},      "offer": {        "lessonTypes": [          "75d3b751-43cf-48e4-ba3f-6f3585979e88"        ],        "classes": [          "48d0c1aa-3e03-4ed5-b27c-a58a53d88085"        ],        "subjects": []      }    }  ],  "domain": {    "hostname": "string"  }}

Apply a site config document PUT

Applies every path the document names in one transaction; a path it leaves out stays as it is. A currency change that relabels lesson type prices answers 409. Needs a `site:write` token.