Bulk get page schema markup | Webflow Developer Documentation

curl -X POST https://api.webflow.com/beta/sites/580e63e98c9a982ac9b8b741/pages/schema-markup/query \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "pages": [
    {
      "id": "6596da6045e56dee495bcbba"
    },
    {
      "id": "6596da6045e56dee495bcbba",
      "localeId": "653fd9af6a07fc9cfd7a5e57"
    },
    {
      "id": "6596da6045e56dee495bcbad"
    }
  ]
}'

{
  "pages": [
    {
      "id": "6596da6045e56dee495bcbba",
      "siteId": "6258612d1ee792848f805dcf",
      "localeId": null,
      "effectiveLocaleId": "6258612d1ee792848f805dd0",
      "publishedPath": "/guide-to-the-galaxy",
      "lastUpdated": "2024-03-11T10:42:42.000Z",
      "jsonLdSchema": {
        "@context": "https://schema.org",
        "@type": "FAQPage",
        "mainEntity": [
          {
            "@type": "Question",
            "name": "What is the answer to life, the universe, and everything?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "42"
            }
          }
        ]
      },
      "rawJsonLdSchema": null,
      "isInherited": false
    },
    {
      "id": "6596da6045e56dee495bcbba",
      "siteId": "6258612d1ee792848f805dcf",
      "localeId": "653fd9af6a07fc9cfd7a5e57",
      "effectiveLocaleId": "653fd9af6a07fc9cfd7a5e57",
      "publishedPath": "/fr/guide-de-la-galaxie",
      "lastUpdated": "2024-03-11T10:55:00.000Z",
      "jsonLdSchema": {
        "@context": "https://schema.org",
        "@type": "FAQPage",
        "mainEntity": [
          {
            "@type": "Question",
            "name": "Quelle est la reponse a la vie, l'univers et tout le reste?",
            "acceptedAnswer": {
              "@type": "Answer",
              "text": "42"
            }
          }
        ]
      },
      "rawJsonLdSchema": null,
      "isInherited": false
    },
    {
      "id": "6596da6045e56dee495bcbad",
      "siteId": "6258612d1ee792848f805dcf",
      "localeId": null,
      "effectiveLocaleId": null,
      "publishedPath": "/towel-day",
      "lastUpdated": "2024-05-25T09:30:00.000Z",
      "jsonLdSchema": null,
      "rawJsonLdSchema": null,
      "isInherited": false
    }
  ]
}

Read JSON-LD schema markup for up to 100 pages in a single request.

All pages must belong to the site identified by site_id. Each entry can target a different secondary locale via localeId. When a requested localeId has no schema markup of its own, the primary locale’s schema markup is returned and isInherited is set to true. Duplicate (id, localeId) tuples return 400.

Required scope | pages:read

Read JSON-LD schema markup for up to 100 pages in a single request. All pages must belong to the site identified by `site_id`. Each entry can target a different secondary locale via `localeId`. When a requested `localeId` has no schema markup of its own, the primary locale's schema markup is returned and `isInherited` is set to `true`. Duplicate `(id, localeId)` tuples return 400. Required scope | `pages: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

Request

The pages to read schema markup for.

pageslist of objectsRequired

List of pages to read schema markup for. Include between 1 and 100 entries per request. The same id may appear multiple times when each entry uses a different localeId.

Response

Request was successful

pageslist of objects

Schema markup results in the same order as the input pages array.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error