Skip to content
Vendrix
Sign in

API reference

A small REST API over JSON. Seven endpoints cover your connections, your templates, sending and reading messages, and sandbox events.

Base URL#

All paths below are relative to your API base URL. The console shows the exact address for your workspace.

Conventions#

  • JSON in and out, UTF-8, snake_case field names.
  • Timestamps are ISO 8601 in UTC, such as 2026-10-14T09:30:00Z. Ids are UUID strings.
  • A field marked nullable can be null. Every other field is always present.
  • Authenticate with an API key. Errors follow one format.
  • Every response has an X-Request-Id header.

Resources#