Skip to main content
Ordinal logo
  • Category: social media marketing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: ORDINAL
  • Version: 20261030_00

Tools

Slug: ORDINAL_ADD_IDEA_TO_CALENDARConvert 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

string
required
Idea UUID to convert into a calendar post.
string
required
Calendar date in the workspace timezone (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_CREATE_IDEACreate reusable Ordinal content for one or more supported social channels without adding it to the publishing calendar or publishing it externally.

Input Parameters

object
X content configuration for the idea.
string
Internal notes that are not published.
string
required
Idea title.
object
TikTok content configuration for the idea.
array
Label IDs returned by LIST_LABELS to attach.
object
LinkedIn content configuration for the idea.
string
Optional Ordinal campaign ID.
object
YouTube Shorts content configuration for the idea.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_CREATE_POSTCreate 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

object
X content and scheduling profile configuration.
string
Internal notes that are not published.
string
required
Internal title for the calendar post.
string ("Tentative" | "ToDo" | "InProgress" | "ForReview" | "Blocked" | "Finalized" | "Scheduled" | "Posted")
required
Initial Ordinal workflow status; it does not publish the post.
object
TikTok content and scheduling profile configuration.
string
Instagram Feed, Reel, or Story configuration.
array
Label IDs returned by LIST_LABELS to attach to the post.
object
LinkedIn content and scheduling profile configuration.
string
required
Intended publish time as an ISO 8601 datetime. This does not schedule publication.
string
Optional Ordinal campaign ID.
object
YouTube Shorts content and scheduling profile configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_GET_POSTReturn one Ordinal post by ID with its full channel content, attached assets, labels, profiles, status, and publish timing.

Input Parameters

string
required
Ordinal post UUID, usually from LIST_POSTS or CREATE_POST.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_GET_PROFILE_ANALYTICSReturn 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

string ("followers" | "posts")
required
Analytics dataset: follower-count history or per-post performance.
string
Last analytics date (YYYY-MM-DD); defaults upstream to today.
string ("linkedin" | "x")
required
Social platform of the connected scheduling profile.
string
required
Connected scheduling profile UUID from LIST_PROFILES for the selected platform. Analytics are unavailable until that profile is connected.
string
First analytics date (YYYY-MM-DD); defaults upstream to 30 days ago.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_GET_WORKSPACEReturn the workspace bound to the connected Ordinal API key, including its ID, name, slug, timezone, and creation time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_LIST_IDEASList non-archived content ideas with filters and one cursor-controlled page of results.

Input Parameters

integer
Maximum ideas to return in this page (1-100).
string ("LinkedIn" | "Twitter" | "TikTok" | "YouTubeShorts")
Return only ideas containing this social channel.
array
Return only ideas with these Ordinal idea UUIDs.
array
Return ideas having any of these label UUIDs.
string ("asc" | "desc")
Order ideas by creation time ascending or descending.
string
Opaque continuation cursor returned by a previous call.
string
Filter by an X scheduling profile UUID.
string
Include ideas created at or before this ISO 8601 time.
string
Include ideas created at or after this ISO 8601 time.
string
Filter by a TikTok scheduling profile UUID.
string
Filter by a YouTube Shorts scheduling profile UUID.
string
Filter by a LinkedIn scheduling profile UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_LIST_LABELSReturn workspace labels and their IDs for filtering or labeling posts and ideas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_LIST_POSTSList non-archived workspace posts with filters and one cursor-controlled page of results.

Input Parameters

integer
Maximum posts to return in this page (1-100).
string ("Tentative" | "ToDo" | "InProgress" | "ForReview" | "Blocked" | "Finalized" | "Scheduled" | "Posted")
Return only posts in this workflow status.
string ("LinkedIn" | "Twitter" | "Instagram" | "TikTok" | "YouTubeShorts")
Return only posts targeting this social channel.
string ("createdAt" | "publishAt")
Field used to order results.
array
Return only posts with these UUIDs.
array
Return posts having any of these label UUIDs.
string ("asc" | "desc")
Ascending or descending result order.
string
Opaque continuation cursor returned by a previous call.
string
Filter by an X scheduling profile ID from LIST_PROFILES.
string
Include posts created at or before this ISO 8601 time.
string
Include posts created at or after this ISO 8601 time.
string
Latest scheduled publish date to include (YYYY-MM-DD).
string
Earliest scheduled publish date to include (YYYY-MM-DD).
string
Filter by a TikTok scheduling profile ID from LIST_PROFILES.
string
Filter by a YouTube Shorts scheduling profile ID from LIST_PROFILES.
string
Filter by an Instagram scheduling profile ID from LIST_PROFILES.
string
Filter by a LinkedIn scheduling profile ID from LIST_PROFILES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_LIST_PROFILESList connected social profiles by capability so their IDs can be used for scheduling, analytics, or auto-engagement workflows.

Input Parameters

string ("scheduling" | "engagement")
Capability to list. Scheduling profiles support publishing and analytics; engagement profiles are only for auto-engagements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_SCHEDULE_POSTSchedule 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

string
required
UUID of the post to schedule or reschedule.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_UNSCHEDULE_POSTCancel 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

string
required
UUID of the scheduled post whose pending publication should be cancelled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDINAL_UPDATE_POSTUpdate selected fields or channel content on a non-archived Ordinal post. This does not schedule or publish the post.

Input Parameters

object
Replacement X channel configuration.
string
Replacement internal notes; explicitly pass null to clear them.
string
Replacement internal title.
string ("Tentative" | "ToDo" | "InProgress" | "ForReview" | "Blocked" | "Finalized" | "Scheduled" | "Posted")
Replacement workflow status; use SCHEDULE_POST or UNSCHEDULE_POST to change publication scheduling.
string
required
UUID of the non-archived post to update.
object
Replacement TikTok channel configuration.
string
Replacement Instagram Feed, Reel, or Story configuration.
array
Complete replacement list of label UUIDs from LIST_LABELS.
object
Replacement LinkedIn channel configuration.
string
Replacement intended publish time as an ISO 8601 datetime.
string
Replacement campaign UUID; explicitly pass null to unlink the campaign.
object
Replacement YouTube Shorts channel configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not