Skip to main content

Base URL

All API requests should be made over HTTPS. A plain HTTP request is redirected (301) to the HTTPS equivalent rather than rejected outright, but clients that don’t follow redirects should use HTTPS directly.

Endpoint overview

Pages endpoints

There is no DELETE endpoint for Pages via the Write API.

Collections endpoints

Blog Posts endpoints

Blog metadata endpoints

Feeds endpoints

URL structure

Pages URL pattern

Parameters:
  • page_type: The slug of the Page Type (use * for Single Pages)
  • page_slug: The unique slug identifier of the page
Examples:

Collections URL pattern

Parameters:
  • collection_key: The unique identifier/slug of the Collection
  • item_id: The numeric ID of the Collection item
Examples:

Blog Posts URL pattern

Parameters:
  • slug: The unique slug identifier of the blog post
Examples:

Common query parameters

Authentication

Pagination

Content options

Blog-specific

Example API calls

Fetching Pages

Fetching Collections

Fetching Blog Posts

Trailing slashes

Always end API URLs with a trailing slash, for example /v2/posts/. The API accepts both forms, but a GET to a Pages, Posts, or Collections endpoint without the slash gets a 301 redirect to the slashed URL. Most clients follow it automatically, so the call still works, but it makes two requests, both of which count toward your API usage, and adds a round trip.

HTTPS

Use HTTPS for all API requests. A plain HTTP request is redirected (301) to HTTPS rather than rejected, but clients that don’t follow redirects should use HTTPS directly.

Next steps

Request/Response Format

Learn about JSON data structures

HTTP Status Codes

Understand error responses