API Reference template

Endpoints, params, responses, examples. Open it in the editor, replace what needs replacing, and export a typeset PDF — free, no signup, nothing uploaded.

Use this template All templates

The Markdown source

---
title: API Reference
toc: true
---

# Authentication
All requests require a bearer token:

```bash
curl -H "Authorization: Bearer <token>" https://api.example.com/v1/users
```

# Endpoints

## `GET /v1/users`
List users.

**Query parameters**

| Name | Type | Description |
| :--- | :--- | :---------- |
| page | int | Page number (default 1) |
| limit | int | Items per page (max 100) |

**Response `200`**

```json
{
  "data": [{ "id": "u_1", "email": "a@b.com" }],
  "meta": { "total": 1, "page": 1 }
}
```

## `POST /v1/users`
Create a user.

| Code | Meaning |
| :--- | :------ |
| 201 | Created |
| 400 | Validation error |
| 401 | Unauthorized |

Copy it anywhere Markdown works — or open it pre-loaded in Scripto with the button above.