List sites

GEThttps://api.norreach.app/v1/sites

The workspace's landing-page sites: their address, language, company details, look and custom domains.

pages:readOperation id: list_sites

GET/sites

curl -X GET "https://api.norreach.app/v1/sites" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

List sites

{
  "object": "list",
  "data": [
    {
      "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "object": "site",
      "name": "Acme Staffing",
      "subdomain": "acme",
      "primary_host": "acme.norreach.page",
      "default_language": "sv",
      "status": "active",
      "legal": {
        "company_name": "Acme Staffing AB"
      },
      "theme": {},
      "domains": []
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope pages:read. API keys and scopes

Response

200application/json— List sites

object"list"required

dataobject[]required

Show child attributes

data[].idstring (uuid)required

An id (UUID).

data[].object"site"required

data[].namestringrequired

data[].subdomainstringrequired

data[].primary_hoststringrequired

Where the site's pages are served.

data[].default_languageenumrequired

One of:ensv

data[].statusstringrequired

data[].legalobjectrequired

The company details every page shows.

data[].themeobjectrequired

data[].domainsobject[]required

Show child attributes

data[].domains[].idstring (uuid)required

An id (UUID).

data[].domains[].object"domain"required

data[].domains[].hostnamestringrequired

data[].domains[].statusstringrequired

Where setting it up has got to (e.g. pending, active, misconfigured).

data[].domains[].is_primarybooleanrequired

data[].domains[].redirect_tostring | nullrequired

data[].domains[].recordsanyrequired

The DNS records to set at your domain's provider.

data[].domains[].last_errorstring | nullrequired

data[].domains[].last_checked_atstring | nullrequired

has_morebooleanrequired

next_cursornullrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/sites

curl -X GET "https://api.norreach.app/v1/sites" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

List sites

{
  "object": "list",
  "data": [
    {
      "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "object": "site",
      "name": "Acme Staffing",
      "subdomain": "acme",
      "primary_host": "acme.norreach.page",
      "default_language": "sv",
      "status": "active",
      "legal": {
        "company_name": "Acme Staffing AB"
      },
      "theme": {},
      "domains": []
    }
  ],
  "has_more": false,
  "next_cursor": null
}