Endpoints

Welcome to the Oho API Endpoints documentation. This section provides detailed documentation for all available API endpoints.

Interactive API Reference

For the complete, interactive API reference with all ~151 endpoints, visit our Interactive Swagger Documentation.

The Swagger UI allows you to:

• Explore all endpoints - Browse the complete API with request/response schemas
• Test API calls - Try endpoints directly in your browser with the "Try it out" feature
• View live specifications - See the most up-to-date API documentation
• Download OpenAPI spec - Get the machine-readable API specification

The pages below provide curated documentation for the most commonly used endpoints with tutorials and best practices.

API Documentation

All API endpoints are documented in the complete API reference, organized by resource type:

• Authentication - User authentication and authorization
• Organizations - Manage organizational profiles and settings
• Constituents - Manage individuals and their information
• Accreditations - Background checks and compliance verifications
• Webhooks - Real-time event notifications
• Tags - Organize and categorize resources
• Attachments - File management
• And many more...

Common Patterns

Request Format

All requests should include:

Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

Response Format

All responses are returned in JSON format:

{
  "data": {
    // Response data
  },
  "meta": {
    "timestamp": "2024-11-01T12:00:00Z",
    "request_id": "req_123abc"
  }
}

Error Responses

Errors follow a consistent format:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": {}
  }
}

HTTP Status Codes

Code	Description
200	OK - Request succeeded
201	Created - Resource created successfully
204	No Content - Request succeeded with no response body
400	Bad Request - Invalid request parameters
401	Unauthorized - Authentication required
403	Forbidden - Insufficient permissions
404	Not Found - Resource not found
422	Unprocessable Entity - Validation error
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error - Server error
503	Service Unavailable - Service temporarily unavailable