API Reference

Build with Pulse

Integrate our powerful API to schedule posts, fetch analytics, and manage accounts programmatically.

Quick Start

Get up and running with the Pulse API in minutes. Here's everything you need to make your first API call.

Base URL

https://api.pulse.io/v1

Example Request

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

Authentication

All API requests require authentication using a Bearer token. You can generate an API key from your dashboard.

Keep your API key secure

Never expose your API key in client-side code or public repositories.

                                Authorization Header
                            
"Authorization": "Bearer pk_live_xxxxxxxxxxxx"

Rate Limits

API requests are rate limited based on your plan. Here are the limits for each tier:

Starter

100

requests/min

Pro

1,000

requests/min

Enterprise

10,000

requests/min

API Endpoints

Posts

GET /posts

Retrieve all posts for the authenticated user.

{
  "data": [
    {
      "id": "post_123",
      "content": "Hello world!",
      "platform": "twitter",
      "status": "published",
      "created_at": "2024-12-20T10:00:00Z"
    }
  ],
  "meta": { "total": 42 }
}
                                    

POST /posts

Create a new post and optionally schedule it.

// Request body
{
  "content": "Exciting news coming soon!",
  "platforms": ["twitter", "linkedin"],
  "scheduled_at": "2024-12-25T09:00:00Z"
}
                                    

Schedule

GET /schedule

Get all scheduled posts with their publish times.

{
  "data": [
    {
      "id": "sch_456",
      "post_id": "post_123",
      "scheduled_at": "2024-12-25T09:00:00Z",
      "timezone": "America/New_York"
    }
  ]
}
                                    

Analytics

GET /analytics/overview

Get engagement metrics and performance data.

{
  "followers": 12500,
  "engagement_rate": 4.2,
  "impressions": 85000,
  "clicks": 3200,
  "period": "last_30_days"
}
                                    

Accounts

GET /accounts

List all connected social media accounts.

DELETE /accounts/:id

Disconnect a social media account.

SDKs & Libraries

Use our official SDKs to integrate Pulse into your application quickly.

🟨

JavaScript / Node.js

npm install @pulse/sdk

🐍

Python

pip install pulse-sdk

💎

Ruby

gem install pulse-sdk

🐘

PHP

composer require pulse/sdk

Webhooks

Receive real-time notifications when events happen in your Pulse account.

Available Events

post.published — When a post goes live

post.scheduled — When a post is scheduled

analytics.updated — Daily analytics refresh

account.disconnected — When an account is unlinked

Ready to build with Pulse?

Create your free account and get your API key in seconds.

Get your API key