Skip to main content

​
API Reference

The Covered API is organized around REST principles. It uses standard HTTP methods, returns JSON responses, and uses standard HTTP status codes.

​
Base URL

https://api.allcovered.xyz/v1

​
Authentication

All API requests require a valid API key passed in the Authorization header: 
Authorization: Bearer cov_xxxxxxxxxxxxx
See Authentication for details on obtaining and using API keys.

​
Request format

For POST and PATCH requests, send a JSON body with the Content-Type: application/json header: 
curl -X POST https://api.allcovered.xyz/v1/payables \
  -H "Authorization: Bearer cov_xxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"invoice_number": "INV-001", "amount": 5000}'

​
Response format

​
Success responses

Successful responses return a JSON object with a data field: 
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example"
  }
}
For list endpoints, responses include a meta field with pagination info: 
{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 123,
    "has_more": true
  }
}

​
Error responses

Error responses return a JSON object with an error field: 
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

​
Pagination

List endpoints support pagination via query parameters:
ParameterDefaultMaxDescription
page1-Page number
limit50100Items per page

​
Filtering

Many list endpoints support filtering via query parameters. See individual endpoint documentation for available filters.

​
Resources

Payables

Manage vendor bills and payments

Receivables

Manage customer invoices

Vendors

Manage vendor directory

Customers

Manage customer directory

Treasury

View balance and transactions

Webhooks

Manage webhook endpoints

​
OpenAPI Specification

The complete OpenAPI 3.1 specification is available at: 
https://api.allcovered.xyz/v1/openapi.yaml
You can use this to generate client libraries or import into tools like Postman.