CorefinityCorefinityDocs
Open the Control PanelControl Panel
Sites · 17 of 18

List your company's websites

Lists the websites of your own company and the CoreStack sites you can open that belong to another company: a client's site your company manages as its agency. Each comes with its environments, most recently changed first. A client's other websites are the client's own and are not listed. Paged by page number: page, up to 100000, and per_page.

GET/api/corestack/websites

Query parameters

searchstring

Part of the website's name or address, its company's name, or an environment's name or address. Up to 200 characters.

kindstring

Only websites of this product.

enterprisecorestackcoreclustermixed
statusinteger

Only websites in this status: 0 inactive, 1 pending setup, 2 onboarding, 3 active.

0123
platformstring

Only websites on this platform, such as wordpress.

regionstring

Only websites in this region, by its code, such as uk.

cluster_idinteger

Only websites in this CoreCluster of yours. One that is not yours is refused 422 on cluster_id. At least 1.

attentionboolean

Send 1 for only the websites that need attention.

sortstring

What to sort by. Defaults to updated.

namecompanystatuskindupdated
dirstring

The direction to sort in. Defaults to desc.

ascdesc
pageinteger

The page to read, starting at 1. Defaults to 1.

per_pageinteger

Items a page: 25, 50 or 100, default 25.

2550100

Returns

200 A page of websites.

Fields of the 200 answer
can_createobjectRequired

Which products you can create a site on.

Fields
coreclusterbooleanRequired
corestackbooleanRequired
enterprisebooleanRequired
countsobjectRequired

How many websites match the filters, in all and by product.

Fields
allintegerRequired
coreclusterintegerRequired
corestackintegerRequired
enterpriseintegerRequired
mixedintegerRequired
pageintegerRequired
per_pageintegerRequired
rowsarray of objectsRequired
Fields of each item
attentionintegerRequired

How many things on the website need attention.

badgeobjectRequired

The product the website runs on.

Fields
kindstringRequired
enterprisecorestackcoreclustermixed
labelstringRequired
clusterobject or any or nullRequired

The cluster the website is in. Null for a website that is in none.

companyobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
environment_countintegerRequired
environmentsarray of objectsRequired
Fields of each item
groupstringRequired

Where the environment is listed, such as production or staging.

hosting_kindstringRequired

corestack for a row /corestack/sites/{site} takes, enterprise for a CoreStack Enterprise environment.

corestackenterprise
hrefstring or nullRequired

Where the environment opens in the Control Panel.

idintegerRequired

The environment's id. Not a site row id. At least 1.

labelstringRequired
namestringRequired
pending_changesintegerRequired

How many changes wait for the maintenance window.

reseller_site_idinteger or nullRequired

The site row id to use in /corestack/sites/{site}. Null for a CoreStack Enterprise environment. At least 1.

rolestring or nullRequired
statestringRequired

Such as ready, provisioning or unknown.

uat_sizestring or null

The staging size of a CoreStack site's environment. Left out for a production row.

hrefsobjectRequired
Fields
openstring or nullRequired

Where the website opens in the Control Panel.

idintegerRequired

At least 1.

namestringRequired
pending_changesintegerRequired
platformobject or any or nullRequired

The platform of the website's production environment. Null when it has none.

regionobject or any or nullRequired

The region the website is in, when known.

statusobjectRequired
Fields
keyintegerRequired

0 inactive, 1 pending setup, 2 onboarding, 3 active.

0123
labelstringRequired
updated_atstring or nullRequired

Format: date-time.

urlstring or nullRequired
sortobjectRequired
Fields
dirstringRequired
ascdesc
keystringRequired
namecompanystatuskindupdated
totalintegerRequired

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/corestack/websites \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "can_create": {
    "corecluster": true,
    "corestack": true,
    "enterprise": false
  },
  "counts": {
    "all": 2,
    "corecluster": 1,
    "corestack": 0,
    "enterprise": 1,
    "mixed": 0
  },
  "page": 1,
  "per_page": 25,
  "rows": [
    {
      "attention": 2,
      "badge": {
        "kind": "corecluster",
        "label": "CoreCluster"
      },
      "cluster": {
        "href": "https://manage.corefinity.com/managed-clusters/clusters/17",
        "id": 1017,
        "kind": "customer",
        "label": "Northwind UK 1"
      },
      "company": {
        "id": 1204,
        "name": "Harbour & Finch"
      },
      "environment_count": 2,
      "environments": [
        {
          "group": "production",
          "hosting_kind": "corestack",
          "href": "https://manage.corefinity.com/managed-clusters/sites/1042",
          "id": 3110,
          "label": "Production",
          "name": "Production",
          "pending_changes": 0,
          "reseller_site_id": 1042,
          "role": "production",
          "state": "ready"
        },
        {
          "group": "staging",
          "hosting_kind": "corestack",
          "href": "https://manage.corefinity.com/managed-clusters/sites/1043",
          "id": 3111,
          "label": "Staging",
          "name": "Staging",
          "pending_changes": 0,
          "reseller_site_id": 1043,
          "role": "staging",
          "state": "ready",
          "uat_size": null
        }
      ],
      "hrefs": {
        "open": "https://manage.corefinity.com/managed-clusters/sites/1042"
      },
      "id": 1302,
      "name": "harbourandfinch.example.com",
      "pending_changes": 0,
      "platform": {
        "key": "wordpress",
        "label": "WordPress"
      },
      "region": null,
      "status": {
        "key": 3,
        "label": "Active"
      },
      "updated_at": "2026-11-10T00:59:44Z",
      "url": "https://harbourandfinch-example-com.northwind.cfstack.example.net"
    },
    {
      "attention": 0,
      "badge": {
        "kind": "enterprise",
        "label": "CoreStack Enterprise"
      },
      "cluster": null,
      "company": {
        "id": 1204,
        "name": "Harbour & Finch"
      },
      "environment_count": 0,
      "environments": [],
      "hrefs": {
        "open": "https://manage.corefinity.com/resources/websites/951"
      },
      "id": 1310,
      "name": "Harbour & Finch trade",
      "pending_changes": 0,
      "platform": null,
      "region": null,
      "status": {
        "key": 1,
        "label": "Pending setup"
      },
      "updated_at": "2026-11-10T00:51:39Z",
      "url": "https://trade.harbourandfinch.example.com"
    }
  ],
  "sort": {
    "dir": "desc",
    "key": "updated"
  },
  "total": 2
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT