Skip to main content
The Yertle API is a REST API that follows standard conventions:
  • Base URL (production): https://api.yertle.com
  • Authentication: Personal Access Tokens (see Authentication).
  • Content type: application/json

​
How to read this reference

The reference pages in this section are auto-generated from the OpenAPI spec at openapi.json. For each endpoint you’ll see:
  • HTTP method and path
  • Path and query parameters
  • Request body schema with examples
  • Response schemas for each status code
  • An interactive playground (if you provide a token)

​
Endpoint groups

Endpoints are organized by resource:

​
Conventions

  • All IDs are UUIDs
  • All timestamps are ISO 8601 in UTC
  • Pagination uses limit and offset query parameters
  • Errors follow RFC 7807 Problem Details format

​
Reference implementations

The Yertle CLI is open source and demonstrates real-world usage of every major endpoint group. Read its source code as a living example.