Get Site | Webflow Developer Documentation

import { WebflowClient } from "webflow-api";
async function main() {
    const client = new WebflowClient({
        accessToken: "YOUR_TOKEN_HERE",
    });
    await client.sites.get("580e63e98c9a982ac9b8b741");
}
main();

{
  "id": "42e98c9a982ac9b8b742",
  "workspaceId": "42e63e98c9a982ac9b8b742",
  "createdOn": "1979-10-12T12:00:00.000Z",
  "displayName": "The Hitchhiker's Guide to the Galaxy",
  "shortName": "hitchhikers-guide",
  "lastPublished": "2023-04-02T12:42:00.000Z",
  "lastUpdated": "2023-04-02T12:42:00.000Z",
  "previewUrl": "https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png",
  "timeZone": "America/Los_Angeles",
  "parentFolderId": "1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6",
  "customDomains": [
    {
      "id": "589a331aa51e760df7ccb89d",
      "url": "hitchhikersguide.galaxy"
    },
    {
      "id": "589a331aa51e760df7ccb89e",
      "url": "heartofgold.spaceship"
    }
  ],
  "locales": {
    "primary": {
      "id": "653fd9af6a07fc9cfd7a5e57",
      "cmsLocaleId": "653ad57de882f528b32e810e",
      "enabled": false,
      "displayName": "English (United States)",
      "redirect": true,
      "subdirectory": "",
      "tag": "en-US"
    },
    "secondary": [
      {
        "id": "653fd9af6a07fc9cfd7a5e56",
        "cmsLocaleId": "653fd9af6a07fc9cfd7a5e5d",
        "enabled": true,
        "displayName": "French (France)",
        "subdirectory": "fr-fr",
        "tag": "fr-FR"
      },
      {
        "id": "654112a3a525b2739d97664c",
        "cmsLocaleId": "654112a3a525b2739d97664f",
        "enabled": true,
        "displayName": "Spanish (Mexico)",
        "subdirectory": "es-mx",
        "tag": "es-MX"
      }
    ]
  },
  "dataCollectionEnabled": true,
  "dataCollectionType": "always"
}

Get details of a site.

Required scope | sites:read

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"

Unique identifier for a Site

Response

Request was successful

idstringformat: "objectid"

Unique identifier for the Site

workspaceIdstringformat: "objectid"

Unique identifier for the Workspace

createdOnstringformat: "date-time"

Date the Site was created

displayNamestring

Name given to Site

shortNamestring

Slugified version of name

lastPublishedstringformat: "date-time"

Date the Site was last published

lastUpdatedstringformat: "date-time"

Date the Site was last updated

previewUrlstringformat: "uri"

URL of a generated image for the given Site

timeZonestring

Site timezone set under Site Settings

parentFolderIdstring or nullformat: "objectid"

The ID of the parent folder the Site exists in

customDomainslist of objects

localesobject

dataCollectionEnabledboolean

Indicates if data collection is enabled for the site.

dataCollectionTypeenum

The type of data collection enabled for the site.

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error