API Reference

Complete reference for the BizKitHub API. All endpoints use REST conventions and return JSON responses.

Base URL

https://api.bizkithub.com

Authentication

All API requests require authentication using an API key in the Authorization header:

Authorization: Bearer YOUR_API_KEYGet API Key →

📋 OpenAPI Documentation

Complete API schema available in OpenAPI format for integration with your tools.

GET/api/v1/users

Get all users

Parameters

NameTypeDescription
pageintegerPage number (default: 1)
limitintegerItems per page (default: 20)
searchstringSearch users by name or email

Example Request

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

Example Response

{
  "data": [
    {
      "id": "user_123",
      "email": "john@example.com",
      "name": "John Doe",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "pages": 5
  }
}
POST/api/v1/users

Create a new user

Parameters

NameTypeDescription
emailstringUser email address (required)
namestringUser full name (required)
passwordstringUser password (required)

Example Request

curl -X POST "https://api.bizkithub.com/v1/users" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "name": "Jane Smith",
    "password": "securepassword123"
  }'

Example Response

{
  "data": {
    "id": "user_124",
    "email": "jane@example.com",
    "name": "Jane Smith",
    "created_at": "2025-01-01T00:00:00Z",
    "updated_at": "2025-01-01T00:00:00Z"
  }
}

Common Error Codes

400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limited
500Internal Server Error