Aveiro API
Authentication
Sites
List Sites
List Templates
Create Site
Pages
Create a Page
Delete a Page
List Pages
Reorder Pages
Update a Page
Audience
Newsletter API Overview
Newsletter Campaigns
Social
Social API Overview
Social Accounts
Social Media
Social Posts
TrademarkTrademark
Ctrl k
Search...
Sign up
Aveiro API
Authentication
Sites
List Sites
List Templates
Create Site
Pages
Create a Page
Delete a Page
List Pages
Reorder Pages
Update a Page
Audience
Newsletter API Overview
Newsletter Campaigns
Social
Social API Overview
Social Accounts
Social Media
Social Posts
TrademarkTrademark
AveiroBlogContact
© Aveiro. All rights reserved.
Built with Aveiro
Sites

List Sites

GET /api/v1/sites — return every site your API token can access.
Updated 5d ago
List Templates
In short
GET /api/v1/sites returns the sites your token can read. Requires the sites:read scope. Use the site id from the response for page endpoints.

Request

Required scope: sites:read

Example (curl)

Example (fetch)

Response

200 OK
Field
Type
Description
iduuidSite ID — use in /api/v1/sites/{siteId}/… routes
namestringDashboard display name
slugstringPreview subdomain slug (slug.aveiro.page)
public_content_livebooleanWhether any published content is live
updated_atISO 8601Last site update timestamp
Sites are sorted by name ascending. Soft-deleted sites are omitted.

Get one site

For a single site’s metadata (including organization_id): Required scope: sites:read

Errors

HTTP
Code
When
401UNAUTHORIZEDToken missing or invalid
403FORBIDDENToken lacks sites:read scope

Related

  • List pages
  • List templates
  • Create site
  • Create a page
GET /api/v1/sites
Authorization: Bearer av_live_…
curl -s 'https://help.aveiro.app/api/v1/sites' \
  -H 'Authorization: Bearer av_live_…'
const res = await fetch("https://help.aveiro.app/api/v1/sites", {
  headers: { Authorization: `Bearer ${process.env.AVEIRO_API_TOKEN}` },
});
const { sites } = await res.json();
{
  "sites": [
    {
      "id": "224eeebe-974f-4cfa-96ce-75fb5166c7b0",
      "name": "Aveiro API",
      "slug": "aveiro-api",
      "public_content_live": false,
      "updated_at": "2026-07-08T08:42:01.353156+00:00"
    }
  ]
}
GET /api/v1/sites/{siteId}
Authorization: Bearer av_live_…
{
  "id": "224eeebe-974f-4cfa-96ce-75fb5166c7b0",
  "organization_id": "org-uuid",
  "name": "Aveiro API",
  "slug": "aveiro-api",
  "public_content_live": false
}