#about API Reference

Overview

Welcome to the #about API. Our RESTful API allows you to programmatically manage projects, upload assets, track analytics, and integrate our creative platform directly into your workflow. All requests are made over HTTPS and return JSON responses.

💡 Quick Start

Sign up at dashboard.about.com to generate your API key. Every request requires authentication via the Authorization header.

Authentication

The #about API uses Bearer tokens for authentication. You can generate API keys from your dashboard under Settings → API Keys.

Authorization: Bearer sk_live_51J3k9mL8vX2nQ4pR7tY9wZ0

Keep your secret keys secure. Never expose them in client-side code or public repositories. For frontend applications, use our published pk_test_ keys.

Rate Limits

API requests are rate-limited to ensure fair usage. Current limits:

Plan	Requests / Minute	Requests / Day
Starter	60	10,000
Professional	300	100,000
Enterprise	Custom	Unlimited

When you exceed limits, the API returns 429 with a Retry-After header.

GET /v1/projects

List all projects

Returns a paginated list of projects associated with your account. Results are sorted by creation date in descending order.

Query Parameters

Parameter	Type	Description
limitoptional	integer	Number of items per page (1-100). Default: 20
offsetoptional	integer	Number of items to skip for pagination
statusoptional	string	Filter by status: `draft`, `active`, `archived`

curl https://api.about.com/v1/projects?limit=10\&status=active \\
  -H "Authorization: Bearer sk_live_51J3k9mL8vX2nQ4pR7tY9wZ0"

// No request body required for GET
// Parameters passed via query string

{
  "data: [
    {
      "id: "prj_9x8c7v6b5n4m3",
      "name: "Summer Campaign 2025",
      "status: "active",
      "created_at: "2025-08-15T14:30:00Z",
      "asset_count: 24
    }
  ],
  "pagination: {
    "total: 142,
    "limit: 10,
    "offset: 0,
    "has_more: true
  }
}

Response Codes

200 Successful retrieval
401 Invalid or missing API key
429 Rate limit exceeded

POST /v1/projects

Create a new project

Creates a new project workspace. Returns the project object with a unique identifier.

Request Body

Field	Type	Description
namerequired	string	Project display name (3-50 chars)
descriptionoptional	string	Short project description
team_idsoptional	array[uuid]	Array of team member IDs to invite

curl -X POST https://api.about.com/v1/projects \\
  -H "Authorization: Bearer sk_live_..." \\
  -H "Content-Type: application/json" \\
  -d '{"name":"Brand Refresh","description":"Q4 visual overhaul"}'

{
  "name: "Brand Refresh",
  "description: "Q4 visual overhaul",
  "team_ids: ["usr_a1b2c3", "usr_d4e5f6"]
}

{
  "id: "prj_2k9m4n7p1q",
  "name: "Brand Refresh",
  "description: "Q4 visual overhaul",
  "status: "draft",
  "created_at: "2025-09-20T09:12:00Z",
  "updated_at: "2025-09-20T09:12:00Z"
}

GET /v1/analytics

Retrieve performance metrics

Returns aggregated engagement data, conversion rates, and asset performance for a specified date range.

curl "https://api.about.com/v1/analytics?start=2025-08-01\&end=2025-08-31" \\
  -H "Authorization: Bearer sk_live_..."

{
  "period: "2025-08",
  "metrics: {
    "impressions: 1245800,
    "engagement_rate: 4.2,
    "click_through: 2.8,
    "conversions: 847
  },
  "top_assets: [
    {
      "id: "ast_x9y8z7",
      "name: "hero_banner_v2.png",
      "views: 342100
    }
  ]
}