Getting Started

Get up and running with the Postally API in just a few minutes. This guide will walk you through authentication, making your first API call, and scheduling your first social media post.

Prerequisites

Step 1: Get Your API Key

First, you'll need to generate an API key from your Postally dashboard.

1. Log in to your Postally dashboard
2. Navigate to Settings → API Keys
3. Click "Generate New API Key"
4. Copy and securely store your API key

Step 2: Authentication

Include your API key in the Authorization header of all requests:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://app.postally.io/api/v1/posts

Step 3: Make Your First API Call

Let's start by fetching your connected social media accounts:

curl -X GET \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://app.postally.io/api/v1/accounts

Response:

{
  "accounts": [
    {
      "id": "acc_123456",
      "platform": "twitter",
      "username": "@yourhandle",
      "status": "connected"
    },
    {
      "id": "acc_789012",
      "platform": "instagram",
      "username": "yourhandle",
      "status": "connected"
    }
  ]
}

Step 4: Schedule Your First Post

Now let's schedule a post to be published:

curl -X POST \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "content": "Hello from Postally API! 🚀",
       "platforms": ["twitter", "instagram"],
       "schedule_time": "2024-01-01T12:00:00Z"
     }' \
     https://app.postally.io/api/v1/posts