API Documentation

Build powerful integrations with the Ommersa API. Access all platform features through our RESTful API.

Why Choose Our API?

RESTful API

Clean, intuitive REST API design with consistent patterns

Comprehensive Docs

Detailed documentation with examples and best practices

SDK Support

Official SDKs for Python, JavaScript, and more

Authentication

API Key Authentication

All API requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

You can generate API keys from your dashboard under Settings → API Keys.

API Endpoints

GET/api/v1/users

Retrieve a list of all users

curl -X GET "https://api.businessos.com/api/v1/users" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

POST/api/v1/users

Create a new user

curl -X POST "https://api.businessos.com/api/v1/users" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "role": "user"
  }'

PUT/api/v1/users/{id}

Update an existing user

curl -X PUT "https://api.businessos.com/api/v1/users/123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Doe",
    "email": "jane@example.com"
  }'

Rate Limits

Standard Plan

• 1,000 requests per hour
• 10,000 requests per day
• Burst limit: 100 requests/minute

Enterprise Plan

• 10,000 requests per hour
• 100,000 requests per day
• Custom rate limits available

Official SDKs

Get started quickly with our official SDKs for popular programming languages.