--- seo: description: API to create and manage Ordinal workspaces, posts, profiles, and analytics sidebar: label: Overview title: Ordinal API --- API to create and manage Ordinal workspaces, posts, profiles, and analytics Version 1.0.0 Base URL: `https://app.tryordinal.com/api/v1` ## Analytics Social media analytics data - [`GET /analytics/linkedin/{profileId}/followers`](/api/analytics/analytics-linkedin-followers) — LinkedIn follower growth. - [`GET /analytics/linkedin/{profileId}/posts`](/api/analytics/analytics-linkedin-posts) — LinkedIn post analytics. - [`GET /analytics/x/{profileId}/followers`](/api/analytics/analytics-x-followers) — X follower growth. - [`GET /analytics/x/{profileId}/posts`](/api/analytics/analytics-x-posts) — X post analytics. - [`GET /analytics/cpm`](/api/analytics/analytics-cpm-get) — Get CPM Values. - [`PUT /analytics/cpm`](/api/analytics/analytics-cpm-update) — Update CPM Values. ## Approvals Post approval workflows - [`GET /approvals`](/api/approvals/approvals-list-workspace) — List workspace approvals. - [`POST /approvals`](/api/approvals/approvals-create) — Create approval requests. - [`DELETE /approvals/{id}`](/api/approvals/approvals-delete) — Delete approval. - [`GET /posts/{postId}/approvals`](/api/approvals/approvals-list) — List post approvals. ## Comments Post comments for team collaboration. Supports @mentions using the format `@[Display Name](userId)`. - [`GET /posts/{postId}/comments`](/api/comments/comments-list) — List post comments. - [`POST /posts/{postId}/comments`](/api/comments/comments-create) — Create a comment on a post. - [`DELETE /comments/{commentId}`](/api/comments/comments-delete) — Delete a comment. ## Engagements Team engagements for posts (likes, comments, reposts) - [`GET /posts/{postId}/engagements`](/api/engagements/engagements-list) — List for a post. - [`POST /posts/{postId}/engagements`](/api/engagements/engagements-create) — Create for a post. - [`DELETE /engagements/{id}`](/api/engagements/engagements-delete) — Delete an engagement. - [`PATCH /engagements/{id}`](/api/engagements/engagements-update) — Update an engagement. ## Invites Workspace invitations for adding new users - [`GET /invites`](/api/invites/invites-list) — List pending invites. - [`POST /invites`](/api/invites/invites-create) — Create an invite. - [`DELETE /invites/{id}`](/api/invites/invites-delete) — Delete an invite. ## Labels Labels for organizing posts - [`GET /labels`](/api/labels/labels-list) — List all labels. - [`POST /labels`](/api/labels/labels-create) — Create a label. - [`DELETE /labels/{id}`](/api/labels/labels-delete) — Delete a label. ## Instagram Instagram utilities for location search and tagging - [`GET /instagram/locations`](/api/instagram/instagram-search-locations) — Search Instagram locations. ## LinkedIn LinkedIn utilities for profile lookups, tagging, and mentions - [`GET /linkedin/{username}/mentions`](/api/linkedin/linkedin-get-mention) — Mention format by username. - [`GET /linkedin/profile/{urn}`](/api/linkedin/linkedin-get-profile) — Get LinkedIn profile by URN. ## Posts Create and manage posts - [`GET /posts`](/api/posts/posts-list) — List posts. - [`POST /posts`](/api/posts/posts-create) — Create post. - [`GET /posts/{id}`](/api/posts/posts-get) — Get post. - [`PATCH /posts/{id}`](/api/posts/posts-update) — Update post. - [`POST /posts/{id}/archive`](/api/posts/posts-archive) — Archive post. - [`POST /posts/{id}/unarchive`](/api/posts/posts-unarchive) — Unarchive post. - [`POST /posts/{id}/schedule`](/api/posts/posts-schedule) — Schedule or reschedule post. - [`POST /posts/{id}/unschedule`](/api/posts/posts-unschedule) — Unschedule post. - [`GET /posts/{id}/versions`](/api/posts/posts-list-versions) — List post draft versions. - [`GET /posts/{id}/channels/{channel}/versions/{versionId}`](/api/posts/posts-get-version-content) — Get post version content. ## Profiles List connected social profiles - [`GET /profiles/engagement`](/api/profiles/profiles-list-engagement) — List engagement profiles. - [`GET /profiles/scheduling`](/api/profiles/profiles-list-scheduling) — List scheduling profiles. ## Slack Boosts List connected Slack channels (webhooks), then create and manage slack boosts so teams get notified in Slack when posts publish. Requires Slack connected with marketing boost channels. - [`GET /posts/{postId}/slack-boosts`](/api/slack-boosts/slack-boosts-list-by-post) — List post's slack boosts. - [`POST /slack-boosts`](/api/slack-boosts/slack-boosts-create) — Create slack boost. - [`GET /slack-boosts/{id}`](/api/slack-boosts/slack-boosts-get) — Get slack boost. - [`DELETE /slack-boosts/{id}`](/api/slack-boosts/slack-boosts-delete) — Delete slack boost. - [`PATCH /slack-boosts/{id}`](/api/slack-boosts/slack-boosts-update) — Update slack boost. - [`GET /slack-webhooks`](/api/slack-boosts/slack-webhooks-list) — List slack webhooks. ## Subscribers Post subscribers for notifications - [`GET /posts/{postId}/subscribers`](/api/subscribers/subscribers-list) — List post subscribers. - [`POST /subscribers`](/api/subscribers/subscribers-create) — Add subscribers to post. - [`DELETE /subscribers/{id}`](/api/subscribers/subscribers-delete) — Delete subscriber. ## File Uploads Upload files from URLs for use in posts. Supports images (JPEG, PNG, GIF, WebP) up to 10 MB and videos (MP4, MOV) up to 350 MB. - [`POST /uploads`](/api/file-uploads/uploads-create) — Upload a file from a URL. - [`POST /uploads/prepare`](/api/file-uploads/uploads-prepare) — Prepare a local file upload. - [`GET /uploads/{id}`](/api/file-uploads/uploads-get) — Get upload status. ## Ideas Create and manage content ideas. Ideas are draft posts without scheduled dates that can be converted to calendar posts. - [`GET /ideas`](/api/ideas/ideas-list) — List ideas. - [`POST /ideas`](/api/ideas/ideas-create) — Create idea. - [`GET /ideas/{id}`](/api/ideas/ideas-get) — Get idea. - [`PATCH /ideas/{id}`](/api/ideas/ideas-update) — Update idea. - [`POST /ideas/{id}/archive`](/api/ideas/ideas-archive) — Archive idea. - [`POST /ideas/{id}/unarchive`](/api/ideas/ideas-unarchive) — Unarchive idea. - [`POST /ideas/{id}/add-to-calendar`](/api/ideas/ideas-add-to-calendar) — Add idea to calendar. ## Inline Comments Text-anchored comments on specific post content. Read-only API for retrieving inline comments across channels. - [`GET /posts/{postId}/inline-comments`](/api/inline-comments/inline-comments-list) — List inline comments on a post. ## Users Workspace users - [`GET /users`](/api/users/users-list) — List workspace users. ## Webhooks Create, list, get, update, and delete webhooks to receive real-time event notifications - [`GET /webhooks`](/api/webhooks/webhooks-list) — List webhooks. - [`POST /webhooks`](/api/webhooks/webhooks-create) — Create webhook. - [`GET /webhooks/{id}`](/api/webhooks/webhooks-get) — Get webhook. - [`DELETE /webhooks/{id}`](/api/webhooks/webhooks-delete) — Delete webhook. - [`PATCH /webhooks/{id}`](/api/webhooks/webhooks-update) — Update webhook. ## Workspaces Workspace information - [`GET /workspace`](/api/workspaces/workspace-get) — Get workspace. ## LinkedIn Leads - [`GET /linkedin/leads/{profileId}/posts`](/api/linkedin-leads/linkedin-leads-list-posts) — List posts. - [`GET /linkedin/leads/{profileId}/posts/{postId}`](/api/linkedin-leads/linkedin-leads-get-leads-by-post) — Get posts leads.