Api
API Overview
Overview of the Parallèle public API endpoints.
API Overview
The Parallèle API provides RESTful endpoints for fetching content from your workspace.
Base URL
All API requests should be made to:
Authentication
All endpoints require the x-api-key header with your workspace API key:
Available Endpoints
| Endpoint | Description |
|---|---|
GET /content | Fetch content strings |
GET /content/preview | Preview content strings (with drafts) |
GET /pages | List published pages |
GET /pages/:slug | Get a single page |
GET /collections | List all collections |
GET /collections/:slug | List items in a collection |
GET /collections/:slug/:itemSlug | Get a single collection item |
GET /blog | List published blog posts |
GET /blog/:slug | Get a single blog post |
GET /menus/:slug | Get a navigation menu |
Common Parameters
Locale Filtering
Most endpoints accept a locale parameter:
If not specified, the workspace's default locale is used.
All Locales
Some endpoints support fetching content in all locales:
Pagination
Collection and blog endpoints support pagination:
Response Format
All responses are JSON objects. Successful responses include the requested data:
Error responses include an error field:
HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad request (invalid parameters) |
| 401 | Unauthorized (invalid or missing API key) |
| 404 | Not found |
| 429 | Rate limit exceeded |
| 500 | Server error |
Site Metadata
Many endpoints include site metadata in the response:
This is useful for building locale switchers and navigation.