API Reference

Overview

The Installer.com API is a RESTful API with OpenAPI 3.1 specification. All endpoints use JSON for request and response bodies.

V1 Endpoints

Browse the public API endpoints for creating orders, managing tags, and listing installers.

Authentication

Learn how to authenticate your API requests.

Base URL

http://localhost:8000/api/v1/...

Authentication

Include your API token in the Authorization header:

Authorization: Bearer YOUR_TOKEN

See Authentication for details on obtaining tokens.

Response Format

All responses return JSON. Successful responses use standard HTTP status codes:

Code	Description
`200`	Success
`201`	Created
`204`	No Content
`400`	Bad Request — invalid input
`401`	Unauthorized — missing or invalid token
`403`	Forbidden — insufficient permissions
`404`	Not Found — resource doesn't exist
`422`	Validation Error — request body failed validation
`429`	Too Many Requests — rate limited
`500`	Internal Server Error

Error Response Shape

{
  "error": "Validation Error",
  "message": "Human-readable description",
  "statusCode": 422,
  "issues": [
    {
      "path": ["customerName"],
      "message": "Required"
    }
  ]
}

Pagination

List endpoints use offset-based pagination:

Parameter	Type	Default	Description
`page`	number	`0`	Page number (0-indexed)
`pageSize`	number	`25`	Results per page (max `500`)

Rate Limiting

API requests are rate limited per API token. If you exceed the limit, you'll receive a 429 response with a Retry-After header. Implement exponential backoff in your integration.

OpenAPI Specification

The full OpenAPI 3.1 specification is available at:

http://localhost:8000/docs

You can use this spec to generate API clients in any language using tools like openapi-generator or openapi-typescript.

Each endpoint in the API reference includes a Send button that lets you try out requests directly in your browser.

V1 Endpoints

Authentication

On this page