API Reference

Complete reference documentation for all API endpoints. All endpoints use HTTPS and require authentication.

Base URL

https://api.oscarrondon.com/v1

Content Management

Create, read, update, and delete content items

User Management

Manage user accounts and permissions

Search & Filter

Advanced search and filtering capabilities

Content Endpoints

Manage your content including blogs, documentation, user manuals, and white papers.

List Content

GET /v1/content Retrieve a list of content items

Query Parameters

Parameter Type Required Description
type string No Filter by content type: blog, manual, whitepaper, strategy
status string No Filter by status: draft, published, archived
limit integer No Number of items to return (default: 10, max: 100)
offset integer No Number of items to skip for pagination

Example Request

curl -H "Authorization: Bearer YOUR_API_KEY" \
     "https://api.oscarrondon.com/v1/content?type=blog&status=published&limit=5"

Response

{
  "data": [
    {
      "id": "content_abc123",
      "title": "API Documentation Best Practices",
      "type": "blog",
      "status": "published",
      "author": "Oscar Rondon",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 5,
    "offset": 0,
    "has_more": true
  }
}

Create Content

POST /v1/content Create a new content item

Request Body

Field Type Required Description
title string Yes Content title (max 200 characters)
type string Yes Content type: blog, manual, whitepaper, strategy
content string Yes Content body (supports Markdown)
status string No Publication status: draft (default), published

Example Request

curl -X POST "https://api.oscarrondon.com/v1/content" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "title": "New Technical Guide",
       "type": "manual",
       "content": "# Technical Guide\n\nThis guide covers...",
       "status": "draft"
     }'

Update Content

PUT /v1/content/{id} Update an existing content item

Use the same request body format as the POST endpoint. All fields are optional for partial updates.

User Management

Manage user accounts, profiles, and permissions within your organization.

List Users

GET /v1/users Retrieve a list of users

Query Parameters

Parameter Type Description
role string Filter by user role: admin, editor, viewer
active boolean Filter by account status

Create User

POST /v1/users Create a new user account

Required Fields

  • email - User's email address
  • name - Full name
  • role - User role (admin, editor, viewer)

Update User

PUT /v1/users/{id} Update user information and permissions