The hosted platform is coming soon. Join the waitlist to be notified at launch.

API Reference

The Deliverant API is organized around REST. All requests and responses use JSON. Authenticate with a Bearer token and use prefixed IDs for all resources.

Base URL

https://api.deliverant.co/v1

Authentication

All API requests require a Bearer token in the Authorization header.

Request headerShell
Authorization: Bearer dk_live_your_api_key_here

Learn more about authentication →

ID Format

All resource IDs use a prefixed format for easy identification. Pass prefixed IDs in URL paths, query parameters, and request bodies.

ResourcePrefix
Eventevt_
Deliverydel_
Endpointep_
Attemptatt_
Batchbat_

API Sections

Status Codes

200Success
201Created
202Accepted (async processing)
204No Content
400Validation error
401Unauthorized
404Not found
409Conflict (idempotency or state)