API Reference

This page provides comprehensive API documentation for integrating with Urwave.

Authentication

All API requests require authentication using an API key.

Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

Retrieve a list of users.

Parameters:

Response:

{
  "users": [
    {
      "id": "123",
      "name": "John Doe",
      "email": "john@example.com"
    }
  ],
  "total": 100
}

Create a new user.

Request Body:

{
  "name": "Jane Doe",
  "email": "jane@example.com",
  "role": "user"
}

Retrieve all projects.

Create a new project.

API requests are limited to:

Configure webhooks to receive real-time notifications:

Common HTTP status codes:

Official SDKs are available for:

Visit our GitHub for SDK documentation and examples.