Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion mcp/tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ If validation fails, returns `{ errors: string }` with details about what went w

## postsListTool

List the organization's posts scheduled between two dates. It returns the same posts as the [List Posts](/public-api/posts/list) API endpoint, but with the channel details flattened into `integrationId`, `platform`, and `integrationName` fields instead of the API's nested `integration` object. Each item includes the post's current provider settings.
List the organization's posts scheduled between two dates. It returns the same posts as the [List Posts](/public-api/posts/list) API endpoint, but with the channel details flattened into `integrationId`, `platform`, and `integrationName` fields instead of the API's nested `integration` object. Each item includes the post's current provider settings. Pass `includeAttachments: true` to also get each post's attachments, whose `path` values can be passed straight to `schedulePostTool` to reuse the same media on another channel without re-uploading it.

**Parameters:**

Expand All @@ -186,6 +186,7 @@ List the organization's posts scheduled between two dates. It returns the same p
| `startDate` | string | Yes | UTC ISO datetime for the start of the range (e.g. `2026-07-20T00:00:00Z`) |
| `endDate` | string | Yes | UTC ISO datetime for the end of the range (e.g. `2026-07-27T00:00:00Z`) |
| `customer` | string | No | Group (customer) ID from `groupList` to filter channels down to a single group |
| `includeAttachments` | boolean | No | Set to `true` to include each post's `attachments` (default `false`) |

**Returns:**

Expand All @@ -202,6 +203,7 @@ An object with a `posts` array. Each item has:
| `integrationId` | string | ID of the channel the post is scheduled to |
| `platform` | string | Platform identifier (e.g., `x`, `linkedin`, `facebook`) |
| `integrationName` | string | Display name of the channel |
| `attachments` | array | Only when `includeAttachments` is `true`. Each entry has `id`, `path` (URL of the uploaded file) and `thumbnail` (URL or `null`) |

---

Expand Down
31 changes: 31 additions & 0 deletions public-api/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,16 @@
"schema": {
"type": "string"
}
},
{
"name": "includeAttachments",
"in": "query",
"required": false,
"description": "Set to true to include each post's attachments (the media already uploaded to Postiz). Default false.",
"schema": {
"type": "boolean"
},
"example": true
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}
],
"responses": {
Expand Down Expand Up @@ -2363,6 +2373,27 @@
"DRAFT"
]
},
"attachments": {
"type": "array",
"description": "Only present when includeAttachments=true. The media attached to the post; pass the path values as attachments when creating a post to reuse the same media on another channel without re-uploading.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string",
"description": "URL of the uploaded file"
},
"thumbnail": {
"type": "string",
"nullable": true,
"description": "URL of the thumbnail / cover image, if one was set"
}
}
}
},
"integration": {
"type": "object",
"properties": {
Expand Down
Loading