API Reference

Programmatic access to the #about platform. Build integrations, automate workflows, and extend your creative operations.

https://api.about.com/v1

The #about API uses standard HTTP methods, JSON request/response bodies, and returns conventional HTTP status codes. All endpoints are secured over HTTPS.

Rate Limiting

Requests are limited to 1,000 requests per hour for standard accounts and 10,000 requests per hour for enterprise tiers. Limits reset hourly. Exceeding limits returns a 429 Too Many Requests response.

Authentication

The API uses Bearer tokens for authentication. Include your API key in the Authorization header for every request.

Header

Authorization: Bearer sk_live_51MqZ7vK8xR2nY9bL3wP

Manage your API keys in the Dashboard Settings. Keys starting with sk_live_ access production data, while sk_test_ keys use sandbox environments.

GET /users

List Users

Returns a paginated list of all users associated with your organization.

Name	Type	Description
`page`	integer	Page number (default: 1)
`limit`	integer	Results per page (max: 100, default: 20)
`role`	string	Filter by role: admin, editor, viewer

cURL

curl -X GET \"https://api.about.com/v1/users?page=1&limit=20\" \\
  -H "Authorization: Bearer YOUR_API_KEY"

JSON (200 OK)

{
  "data": [
    {
      "id": "usr_9f8e7d6c5b4a",
      "name": "Alex Morgan",
      "email": "alex@about.com",
      "role": "admin",
      "created_at": "2024-11-15T08:30:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "total": 42,
    "limit": 20
  }
}

POST /users

Create User

Invite a new user to your organization. An email invitation is sent automatically.

Name	Type	Description
`name` *	string	Full name of the user
`email` *	string	Valid email address
`role`	string	admin, editor, or viewer (default: editor)

JSON (201 Created)
{
  "id": "usr_1a2b3c4d5e6f",
  "name": "Jordan Lee",
  "email": "jordan@client.com",
  "role": "editor",
  "status": "invited",
  "created_at": "2025-01-20T14:22:10Z"
}

GET /projects/{project_id}

Get Project

Retrieves detailed information about a specific project, including assets, timelines, and team assignments.

Response Body
{
  "id": "prj_x7y8z9w0",
  "name": "Q4 Brand Refresh",
  "status": "active",
  "client": "TechVista Inc.",
  "lead": "usr_9f8e7d6c5b4a",
  "budget": 25000,
  "currency": "USD",
  "milestones": [
    { "name": "Discovery", "date": "2024-10-01", "completed": true },
    { "name": "Design", "date": "2024-11-15", "completed": true },
    { "name": "Launch", "date": "2024-12-20", "completed": false }
  ],
  "created_at": "2024-09-15T10:00:00Z"
}

PUT /projects/{project_id}

Update Project

Partially update project metadata. Only fields included in the request body will be modified.

Request Body
{
  "name": "Q4 Brand Refresh - Phase 2",
  "status": "in_review",
  "budget": 28500
}

GET /analytics

Performance Metrics

Fetch aggregated performance data across your workspace. Supports date ranges and metric filtering.

Parameter	Description
`start_date`	ISO 8601 date string (required)
`end_date`	ISO 8601 date string (required)
`metrics`	Comma-separated: conversions, impressions, engagement, revenue

Error Handling

The API uses standard HTTP status codes to indicate success or failure. Errors return structured JSON responses.

200 Success - Request completed successfully

201 Created - Resource successfully created

400 Bad Request - Invalid parameters or malformed JSON

401 Unauthorized - Missing or invalid API key

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

429 Too Many Requests - Rate limit exceeded

500 Server Error - Internal failure (contact support)

Webhooks

Subscribe to real-time events like project.created, user.updated, or payment.received. Configure endpoints in your dashboard. All payloads are signed with HMAC-SHA256 for verification.