List posts
Returns a page of posts for the bound workspace. Requires posts:read. Soft-deleted posts are never returned.
Authorization
ApiKeyAuth X-API-Key<token>
Workspace-scoped API key, e.g. clog_live_AbCdEfGh.... Passed in the X-API-Key header on every request.
In: header
Query Parameters
page?integer
1-based page number. Defaults to 1.
Default
1Range
1 <= valuepageSize?integer
Items per page. Defaults to 10.
Default
10Range
1 <= valueorder?string
Sort direction. Defaults to desc. Requires orderBy.
Default
"desc"Value in
"asc" | "desc"orderBy?string
Field to sort by.
Value in
"createdAt" | "updatedAt" | "publishedAt" | "title" | "status" | "seoScore" | "readabilityScore"q?string
Case-insensitive search across title, excerpt, and bodyText.
status?string
Lifecycle status. scheduled is never written in v1 (rejected on writes). Pages only ever use draft or published.
Value in
"draft" | "scheduled" | "published" | "archived"authorId?string
Format
uuidcategoryId?string
Filter by category. Pass an empty string to filter to uncategorised posts.
tagId?string
Format
uuiddateFrom?string
ISO datetime — lower bound applied to createdAt.
Format
date-timedateTo?string
ISO datetime — upper bound applied to createdAt.
Format
date-timeResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/external/posts"{
"page": 0,
"pageSize": 0,
"order": "asc",
"orderBy": "string",
"total": 0,
"totalPages": 0,
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
"slug": "string",
"title": "string",
"excerpt": "string",
"bodyJson": [
{
"type": "key_takeaways",
"items": [
"string"
]
}
],
"bodyText": "string",
"tocItems": [
{
"level": 2,
"text": "string",
"id": "string"
}
],
"readingTimeMin": 0,
"featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b",
"featuredMedia": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
"url": "string",
"storagePath": "string",
"mimeType": "string",
"sizeBytes": 0,
"width": 0,
"height": 0,
"alt": "string",
"caption": "string",
"uploadedByUserId": "ff762bdd-4d44-4e20-aa37-a40adf9d1fba",
"uploadedByApiKeyId": "257878ec-f2ca-4417-bbd5-6ec6cdaf172c",
"createdAt": "2019-08-24T14:15:22Z"
},
"authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
"author": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
"slug": "string",
"displayName": "string",
"bio": "string",
"avatarMediaId": "baab65f7-7971-4dbb-b3cd-124fc0b57236",
"avatarMedia": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
"url": "string",
"storagePath": "string",
"mimeType": "string",
"sizeBytes": 0,
"width": 0,
"height": 0,
"alt": "string",
"caption": "string",
"uploadedByUserId": "ff762bdd-4d44-4e20-aa37-a40adf9d1fba",
"uploadedByApiKeyId": "257878ec-f2ca-4417-bbd5-6ec6cdaf172c",
"createdAt": "2019-08-24T14:15:22Z"
},
"credentials": "string",
"sameAs": [
"string"
],
"isActive": true,
"seo": {
"title": "string",
"description": "string",
"canonicalUrl": "http://example.com",
"focusKeyword": "string",
"secondaryKeywords": [
"string"
],
"robots": {
"index": true,
"follow": true,
"archive": true,
"imageIndex": true,
"snippet": true,
"maxSnippet": 0,
"maxImagePreview": "none",
"maxVideoPreview": 0
},
"og": {
"title": "string",
"description": "string",
"imageMediaId": "3f20166c-49be-4ccb-ba75-df70e6c4a22f",
"type": "string"
},
"twitter": {
"card": "summary",
"title": "string",
"description": "string",
"imageMediaId": "3f20166c-49be-4ccb-ba75-df70e6c4a22f",
"creator": "string"
},
"breadcrumbsTitle": "string",
"noindexReason": "string",
"redirectTo": "string"
},
"person": {
"jobTitle": "string",
"worksFor": "string",
"knowsAbout": [
"string"
],
"alumniOf": "string",
"award": "string",
"honorificPrefix": "string",
"honorificSuffix": "string"
},
"jsonLd": {},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
"category": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
"slug": "string",
"name": "string",
"description": "string",
"parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
"path": "string",
"sortOrder": 0,
"isActive": true,
"seo": {
"title": "string",
"description": "string",
"canonicalUrl": "http://example.com",
"focusKeyword": "string",
"secondaryKeywords": [
"string"
],
"robots": {
"index": true,
"follow": true,
"archive": true,
"imageIndex": true,
"snippet": true,
"maxSnippet": 0,
"maxImagePreview": "none",
"maxVideoPreview": 0
},
"og": {
"title": "string",
"description": "string",
"imageMediaId": "3f20166c-49be-4ccb-ba75-df70e6c4a22f",
"type": "string"
},
"twitter": {
"card": "summary",
"title": "string",
"description": "string",
"imageMediaId": "3f20166c-49be-4ccb-ba75-df70e6c4a22f",
"creator": "string"
},
"breadcrumbsTitle": "string",
"noindexReason": "string",
"redirectTo": "string"
},
"collectionMetadata": {
"includeChildCategories": true,
"sortPostsBy": "publishedAt"
},
"jsonLd": {},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"status": "draft",
"publishedAt": "2019-08-24T14:15:22Z",
"scheduledAt": "2019-08-24T14:15:22Z",
"isHowTo": true,
"summaryForAi": "string",
"canonicalUrl": "string",
"viewCount": 0,
"seo": {
"title": "string",
"description": "string",
"canonicalUrl": "http://example.com",
"focusKeyword": "string",
"secondaryKeywords": [
"string"
],
"robots": {
"index": true,
"follow": true,
"archive": true,
"imageIndex": true,
"snippet": true,
"maxSnippet": 0,
"maxImagePreview": "none",
"maxVideoPreview": 0
},
"og": {
"title": "string",
"description": "string",
"imageMediaId": "3f20166c-49be-4ccb-ba75-df70e6c4a22f",
"type": "string"
},
"twitter": {
"card": "summary",
"title": "string",
"description": "string",
"imageMediaId": "3f20166c-49be-4ccb-ba75-df70e6c4a22f",
"creator": "string"
},
"breadcrumbsTitle": "string",
"noindexReason": "string",
"redirectTo": "string"
},
"schemaType": "BlogPosting",
"structuredData": {},
"structuredBlocks": [
{
"type": "key_takeaways",
"items": [
"string"
]
}
],
"seoScore": 0,
"readabilityScore": 0,
"jsonLd": {},
"deletedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"tags": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
"slug": "string",
"name": "string",
"seo": {
"title": "string",
"description": "string",
"canonicalUrl": "http://example.com",
"focusKeyword": "string",
"secondaryKeywords": [
"string"
],
"robots": {
"index": true,
"follow": true,
"archive": true,
"imageIndex": true,
"snippet": true,
"maxSnippet": 0,
"maxImagePreview": "none",
"maxVideoPreview": 0
},
"og": {
"title": "string",
"description": "string",
"imageMediaId": "3f20166c-49be-4ccb-ba75-df70e6c4a22f",
"type": "string"
},
"twitter": {
"card": "summary",
"title": "string",
"description": "string",
"imageMediaId": "3f20166c-49be-4ccb-ba75-df70e6c4a22f",
"creator": "string"
},
"breadcrumbsTitle": "string",
"noindexReason": "string",
"redirectTo": "string"
},
"createdAt": "2019-08-24T14:15:22Z"
}
],
"relatedPosts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"title": "string",
"excerpt": "string",
"status": "draft",
"featuredMediaId": "ae12f69f-58ad-4875-a887-b7bcc16d920b"
}
]
}
]
}{
"code": "BAD_REQUEST",
"message": "string",
"details": null
}{
"code": "BAD_REQUEST",
"message": "string",
"details": null
}