Knowledge Base

Introduction

This API allows developers to integrate with our platform programmatically. All endpoints are secured via HTTPS and require an API token.

Base URL

https://api.example.com/v1

Authentication

curl -H "Authorization: Bearer YOUR_API_TOKEN" https://api.example.com/v1/users

Include the Authorization header with a Bearer token in each request.

Endpoints

List Users

GET /users

Retrieves a paginated list of users.

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

Create User

POST /users

Creates a new user.

{
  "email": "newuser@example.com",
  "name": "New User",
  "role": "member"
}
curl -X POST "https://api.example.com/v1/users" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
  "email": "newuser@example.com",
  "name": "New User",
  "role": "member"
}
EOF

Response Formats

All responses are JSON. Successful responses use HTTP status 200‑299. Errors use appropriate 4xx/5xx codes.

{
  "id": "12345",
  "email": "newuser@example.com",
  "name": "New User",
  "role": "member",
  "created_at": "2025-09-15T12:34:56Z"
}