API Reference

Complete reference for the DevDocs REST API v3

Authentication

All API requests require a valid API key passed in the Authorization header. You can generate API keys from your dashboard under Settings → API Keys.

Authorization: Bearer sk_live_xxxxxxxxxxxx

Base URL

https://api.devdocs.example.com/v3

Users

GET /users

Returns a paginated list of all users in the organization.

Parameter	Type	Description
`page`	integer	Page number (default: 1)
`per_page`	integer	Results per page, max 100 (default: 20)
`status`	string	Filter by status: `active`, `suspended`

curl https://api.devdocs.example.com/v3/users \
  -H "Authorization: Bearer sk_live_xxxx" \
  -G -d "page=1&per_page=10"

POST /users

Creates a new user in the organization.

curl https://api.devdocs.example.com/v3/users \
  -H "Authorization: Bearer sk_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"email": "dev@example.com", "role": "member"}'

DELETE /users/:id

Permanently deletes a user. This action cannot be undone.

Error Handling

The API uses standard HTTP response codes. Errors return a JSON body with error.type and error.message fields.

Code	Meaning
`200`	Success
`400`	Bad Request — invalid parameters
`401`	Unauthorized — invalid or missing API key
`404`	Not Found
`429`	Rate Limited — slow down
`500`	Internal Server Error

Rate Limits

API requests are limited to 100 requests per minute per API key. Rate limit information is included in response headers: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.