API Reference

Complete API documentation with code examples in multiple languages

9
Endpoints
3
Categories
v1
Version
99.9%
Uptime

Authentication

All API requests require authentication using Bearer tokens. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY
Get your API key from your account settings

Categories

Endpoints

GET
/api/v1/users

List Users

Retrieve a paginated list of all users in your organization.

Auth required
100 requests/minute
Users

Parameters

page
integer

Page number for pagination

Example: 1
limit
integer

Number of results per page (max 100)

Example: 20
sort
string

Sort field and direction

Example: created_at:desc
filter
string

Filter by user status

Example: active

Responses

Code Examples

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

Error Codes

400

Bad Request

The request was invalid or cannot be served.

401

Unauthorized

Authentication failed or user doesn't have permissions.

403

Forbidden

The request is understood, but it has been refused.

404

Not Found

The requested resource could not be found.

429

Too Many Requests

Rate limit exceeded. Please slow down your requests.

500

Internal Server Error

An error occurred on our servers.

503

Service Unavailable

The service is temporarily unavailable.

Rate Limiting

API requests are rate-limited to ensure fair usage. Rate limits vary by endpoint and plan tier. Check response headers for current limit status:

  • X-RateLimit-Limit: Maximum requests per window
  • X-RateLimit-Remaining: Requests remaining
  • X-RateLimit-Reset: Time when limit resets (Unix timestamp)