> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Ordinal

> Ordinal is a collaborative social media planning platform for creating, reviewing, scheduling, and analyzing content across connected channels.

![Ordinal logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/ordinal.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=6447c3efb740aa8654dd15dacc77df9c)

* **Category:** social media marketing
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 13
* **Triggers:** 0
* **Slug:** `ORDINAL`
* **Version:** 20261030\_00

## Tools

> [accordion] Add Idea To Calendar
>
> **Slug:** `ORDINAL_ADD_IDEA_TO_CALENDAR`
>
> Convert an existing Ordinal idea into a regular calendar post on a chosen date. This does not schedule or externally publish the returned post.
>
> #### Input Parameters
>
> **idea\_id** `string` *required*
>
> Idea UUID to convert into a calendar post.
>
> **publish\_date** `string` *required*
>
> Calendar date in the workspace timezone (YYYY-MM-DD).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Idea
>
> **Slug:** `ORDINAL_CREATE_IDEA`
>
> Create reusable Ordinal content for one or more supported social channels without adding it to the publishing calendar or publishing it externally.
>
> #### Input Parameters
>
> **x** `object`
>
> X content configuration for the idea.
>
> **notes** `string`
>
> Internal notes that are not published.
>
> **title** `string` *required*
>
> Idea title.
>
> **tik\_tok** `object`
>
> TikTok content configuration for the idea.
>
> **label\_ids** `array`
>
> Label IDs returned by LIST\_LABELS to attach.
>
> **linked\_in** `object`
>
> LinkedIn content configuration for the idea.
>
> **campaign\_id** `string`
>
> Optional Ordinal campaign ID.
>
> **you\_tube\_shorts** `object`
>
> YouTube Shorts content configuration for the idea.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Post
>
> **Slug:** `ORDINAL_CREATE_POST`
>
> Create an Ordinal calendar post with content for one or more social channels. This only creates the post: it does not schedule or publish anything; call SCHEDULE\_POST separately to schedule external publication.
>
> #### Input Parameters
>
> **x** `object`
>
> X content and scheduling profile configuration.
>
> **notes** `string`
>
> Internal notes that are not published.
>
> **title** `string` *required*
>
> Internal title for the calendar post.
>
> **status** `string ("Tentative" | "ToDo" | "InProgress" | "ForReview" | "Blocked" | "Finalized" | "Scheduled" | "Posted")` *required*
>
> Initial Ordinal workflow status; it does not publish the post.
>
> **tik\_tok** `object`
>
> TikTok content and scheduling profile configuration.
>
> **instagram** `string`
>
> Instagram Feed, Reel, or Story configuration.
>
> **label\_ids** `array`
>
> Label IDs returned by LIST\_LABELS to attach to the post.
>
> **linked\_in** `object`
>
> LinkedIn content and scheduling profile configuration.
>
> **publish\_at** `string` *required*
>
> Intended publish time as an ISO 8601 datetime. This does not schedule publication.
>
> **campaign\_id** `string`
>
> Optional Ordinal campaign ID.
>
> **you\_tube\_shorts** `object`
>
> YouTube Shorts content and scheduling profile configuration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Post
>
> **Slug:** `ORDINAL_GET_POST`
>
> Return one Ordinal post by ID with its full channel content, attached assets, labels, profiles, status, and publish timing.
>
> #### Input Parameters
>
> **post\_id** `string` *required*
>
> Ordinal post UUID, usually from LIST\_POSTS or CREATE\_POST.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Profile Analytics
>
> **Slug:** `ORDINAL_GET_PROFILE_ANALYTICS`
>
> Return follower history or post performance for one connected LinkedIn or X scheduling profile over a date range. Requires a matching profile ID from LIST\_PROFILES with profile\_type='scheduling'; analytics are unavailable until that social profile is connected.
>
> #### Input Parameters
>
> **metric** `string ("followers" | "posts")` *required*
>
> Analytics dataset: follower-count history or per-post performance.
>
> **end\_date** `string`
>
> Last analytics date (YYYY-MM-DD); defaults upstream to today.
>
> **platform** `string ("linkedin" | "x")` *required*
>
> Social platform of the connected scheduling profile.
>
> **profile\_id** `string` *required*
>
> Connected scheduling profile UUID from LIST\_PROFILES for the selected platform. Analytics are unavailable until that profile is connected.
>
> **start\_date** `string`
>
> First analytics date (YYYY-MM-DD); defaults upstream to 30 days ago.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workspace
>
> **Slug:** `ORDINAL_GET_WORKSPACE`
>
> Return the workspace bound to the connected Ordinal API key, including its ID, name, slug, timezone, and creation time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Ideas
>
> **Slug:** `ORDINAL_LIST_IDEAS`
>
> List non-archived content ideas with filters and one cursor-controlled page of results.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum ideas to return in this page (1-100).
>
> **channel** `string ("LinkedIn" | "Twitter" | "TikTok" | "YouTubeShorts")`
>
> Return only ideas containing this social channel.
>
> **idea\_ids** `array`
>
> Return only ideas with these Ordinal idea UUIDs.
>
> **label\_ids** `array`
>
> Return ideas having any of these label UUIDs.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Order ideas by creation time ascending or descending.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call.
>
> **x\_profile\_id** `string`
>
> Filter by an X scheduling profile UUID.
>
> **created\_at\_max** `string`
>
> Include ideas created at or before this ISO 8601 time.
>
> **created\_at\_min** `string`
>
> Include ideas created at or after this ISO 8601 time.
>
> **tik\_tok\_profile\_id** `string`
>
> Filter by a TikTok scheduling profile UUID.
>
> **you\_tube\_profile\_id** `string`
>
> Filter by a YouTube Shorts scheduling profile UUID.
>
> **linked\_in\_profile\_id** `string`
>
> Filter by a LinkedIn scheduling profile UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Labels
>
> **Slug:** `ORDINAL_LIST_LABELS`
>
> Return workspace labels and their IDs for filtering or labeling posts and ideas.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Posts
>
> **Slug:** `ORDINAL_LIST_POSTS`
>
> List non-archived workspace posts with filters and one cursor-controlled page of results.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum posts to return in this page (1-100).
>
> **status** `string ("Tentative" | "ToDo" | "InProgress" | "ForReview" | "Blocked" | "Finalized" | "Scheduled" | "Posted")`
>
> Return only posts in this workflow status.
>
> **channel** `string ("LinkedIn" | "Twitter" | "Instagram" | "TikTok" | "YouTubeShorts")`
>
> Return only posts targeting this social channel.
>
> **sort\_by** `string ("createdAt" | "publishAt")`
>
> Field used to order results.
>
> **post\_ids** `array`
>
> Return only posts with these UUIDs.
>
> **label\_ids** `array`
>
> Return posts having any of these label UUIDs.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Ascending or descending result order.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call.
>
> **x\_profile\_id** `string`
>
> Filter by an X scheduling profile ID from LIST\_PROFILES.
>
> **created\_at\_max** `string`
>
> Include posts created at or before this ISO 8601 time.
>
> **created\_at\_min** `string`
>
> Include posts created at or after this ISO 8601 time.
>
> **publish\_date\_max** `string`
>
> Latest scheduled publish date to include (YYYY-MM-DD).
>
> **publish\_date\_min** `string`
>
> Earliest scheduled publish date to include (YYYY-MM-DD).
>
> **tik\_tok\_profile\_id** `string`
>
> Filter by a TikTok scheduling profile ID from LIST\_PROFILES.
>
> **you\_tube\_profile\_id** `string`
>
> Filter by a YouTube Shorts scheduling profile ID from LIST\_PROFILES.
>
> **instagram\_profile\_id** `string`
>
> Filter by an Instagram scheduling profile ID from LIST\_PROFILES.
>
> **linked\_in\_profile\_id** `string`
>
> Filter by a LinkedIn scheduling profile ID from LIST\_PROFILES.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Profiles
>
> **Slug:** `ORDINAL_LIST_PROFILES`
>
> List connected social profiles by capability so their IDs can be used for scheduling, analytics, or auto-engagement workflows.
>
> #### Input Parameters
>
> **profile\_type** `string ("scheduling" | "engagement")`
>
> Capability to list. Scheduling profiles support publishing and analytics; engagement profiles are only for auto-engagements.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Schedule Post
>
> **Slug:** `ORDINAL_SCHEDULE_POST`
>
> Schedule or reschedule an Ordinal post for external publication to its configured social channels. WARNING: this creates or changes a future external social publication. It can be cancelled with UNSCHEDULE\_POST before it fires, but publication is irreversible once sent. The post must contain at least one channel with a connected scheduling profile.
>
> #### Input Parameters
>
> **post\_id** `string` *required*
>
> UUID of the post to schedule or reschedule.
>
> **publish\_at** `string`
>
> UTC publication time as an ISO 8601 datetime. This schedules external publication to every configured social channel. It is required for a new schedule; omit it only when rescheduling to retain the existing time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unschedule Post
>
> **Slug:** `ORDINAL_UNSCHEDULE_POST`
>
> Cancel a pending scheduled publication and change the Ordinal post status to Finalized. This only cancels publication that has not occurred and cannot retract content that has already been published.
>
> #### Input Parameters
>
> **post\_id** `string` *required*
>
> UUID of the scheduled post whose pending publication should be cancelled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Post
>
> **Slug:** `ORDINAL_UPDATE_POST`
>
> Update selected fields or channel content on a non-archived Ordinal post. This does not schedule or publish the post.
>
> #### Input Parameters
>
> **x** `object`
>
> Replacement X channel configuration.
>
> **notes** `string`
>
> Replacement internal notes; explicitly pass null to clear them.
>
> **title** `string`
>
> Replacement internal title.
>
> **status** `string ("Tentative" | "ToDo" | "InProgress" | "ForReview" | "Blocked" | "Finalized" | "Scheduled" | "Posted")`
>
> Replacement workflow status; use SCHEDULE\_POST or UNSCHEDULE\_POST to change publication scheduling.
>
> **post\_id** `string` *required*
>
> UUID of the non-archived post to update.
>
> **tik\_tok** `object`
>
> Replacement TikTok channel configuration.
>
> **instagram** `string`
>
> Replacement Instagram Feed, Reel, or Story configuration.
>
> **label\_ids** `array`
>
> Complete replacement list of label UUIDs from LIST\_LABELS.
>
> **linked\_in** `object`
>
> Replacement LinkedIn channel configuration.
>
> **publish\_at** `string`
>
> Replacement intended publish time as an ISO 8601 datetime.
>
> **campaign\_id** `string`
>
> Replacement campaign UUID; explicitly pass null to unlink the campaign.
>
> **you\_tube\_shorts** `object`
>
> Replacement YouTube Shorts channel configuration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
