Public API
Public API documentation for domain backorder workflows
Connect your domain workflow to Catches.io. Validate requests before queueing them, use approved scopes, and handle asynchronous results without treating a queued backorder as a successful acquisition.
Use the API to connect your internal workflow to Catches.io while keeping domain validation, queueing, cancellation, and acceptable-use requirements explicit.
Authentication and scopes
Create an API key from the authenticated API Access page, then send it with protected requests in the Authorization header as a Bearer token. Keep keys private and rotate any key that may have been exposed.
- backorders:read for listing authenticated backorder records.
- backorders:validate for validating single or bulk backorder requests before queueing.
- backorders:create for queueing one backorder.
- backorders:bulk:create for approved bulk queueing workflows.
- backorders:cancel for cancelling eligible API-created backorders.
Endpoints and examples
Validate, then queue
GET /v1/health
Check public API availability before sending authenticated traffic.
GET /v1/backorders
List authenticated account backorders with status filters, limits, and cursor pagination.
POST /v1/backorders/validate
Validate one backorder request before queueing it.
POST /v1/backorders/bulk/validate
Validate a batch with all-or-nothing semantics before queueing any domains.
POST /v1/backorders
Queue one backorder with an idempotency key for safe retries.
POST /v1/backorders/bulk
Queue a batch of backorders after validation with one idempotent request.
POST /v1/backorders/:id/cancel
Cancel an eligible API-created backorder while it is still cancellable.
Implementation checklist
Start with validation, queue single or bulk backorders with idempotency keys, store Catches.io request IDs, handle asynchronous queue responses, and cancel only records that remain in a cancellable state.
Replace sample domains, ids, API keys, and idempotency keys before use. API responses include request identifiers and predictable JSON envelopes for integration logging.