Skip to main content

​
Overview

The Ordinal API allows you to programmatically create and manage posts, profiles, approvals, labels, and analytics data within your workspace. The API follows REST conventions and uses JSON for request and response bodies.

Base URL

https://app.tryordinal.com/api/v1

​
Quick Start

Pro Plan RequiredThe Ordinal API is available on the Pro plan or higher. Upgrade your workspace to access API features.
1

Generate an API Key

Navigate to your workspace settings and create a new API key. See the Authentication guide for details.
2

Make Your First Request

Use the API key as a Bearer token to authenticate your requests:We recommend testing the Get Workspace endpoint to confirm that your API key is working.
curl -X GET "https://app.tryordinal.com/api/v1/workspace" \
  -H "Authorization: Bearer your_api_key"
Confirm that you see your workspace information in the response.
{
  "id": "your-workspace-uuid",
  "name": "Your Workspace",
  "slug": "your-workspace",
  "timezone": "America/New_York",
  "createdAt": "2025-01-01T00:00:00.000Z"
}
3

Explore Endpoints

Browse the endpoint documentation to discover all available operations for posts, profiles, approvals, and more.

​
Available Resources

Posts

Create, list, retrieve, archive, and unarchive posts in your workspace

File Uploads

Upload files from URLs to attach to posts

Profiles

List scheduling and engagement profiles connected to your workspace

Approvals

Manage approval workflows for posts

Labels

Create and manage labels for organizing posts

Subscribers

Manage post subscribers for notifications

Comments

List and create comments on posts with @mention support

Inline Comments

Retrieve text-anchored comments on post content

Invites

Invite users to your workspace via email

Analytics

Retrieve post and follower analytics across platforms

Webhooks

Create, list, get, update, and delete webhooks to receive real-time event notifications

Slack Boosts

List Slack channels, then create, list, get, update, and delete Slack Boosts for posts

​
Rate Limiting

API requests are rate limited to ensure fair usage of 100 requests per minute per API key. When you exceed the rate limit, you’ll receive a 429 Too Many Requests response with information about when your quota resets. 
{
  "code": "TOO_MANY_REQUESTS",
  "message": "Rate limit of 100 requests per 60s exceeded. Quota resets in 45 seconds"
}
If you need a higher rate limit, please reach out to support.

​
Need Help?

Authentication

Learn how to authenticate your API requests

Error Handling

Understand API error responses