Social
Which social accounts are connected, and posting to them immediately or on a schedule.
List social accounts
Which platforms this workspace is connected to and whether each connection is still usable — the thing to check first when a post fails.
Requires the module-social-post license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List social accounts › Responses
Success
List posts
Returns posts sent or scheduled to a social platform, newest first, with the source file's name and type alongside each.
Requires the module-social-post license feature. Without it the request is refused with 403 license_required — see plans and modules.
query Parameters
cursor^[A-Za-z0-9_-]+$file_idlimitoffsetplatformsort^-?[a-z0-9_]+$sp_createdsp_scheduled_atstatusHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List posts › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Send a post
Sends a file the workspace already holds to a connected account. Give scheduled_at to queue it for later instead of posting immediately — a scheduled post can still be cancelled, a sent one cannot.
Requires social:publish, media:download, document:download, knowledge-base:view, thread:view, design:view, prompt:view and presentation:view together.
Requires the module-social-post license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Send a post › Request Body
file_idplatformcaptionmedia_typescheduled_atSend a post › Responses
Success
Get a post
The record with the file it sent, including the outcome reported by the platform.
Requires the module-social-post license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a post › Responses
Success
sp_idsp_filesp_usersp_platformsp_statussp_captionsp_media_typesp_platform_datasp_metadatasp_errorsp_scheduled_atsp_published_atsp_createdsp_updatedfile_namefile_typefile_replicasCancel a post
Only while it is still scheduled. Once it has gone out, it has to be removed on the platform itself.
Requires the module-social-post license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Cancel a post › Responses
Success