API reference

Vinix's API is organized by product surface. All five surfaces share one account, one X-Auth-Token header, and one webhook signing secret — pick the surfaces you need, ignore the rest.

Surfaces

Conventions

• Base URL: https://api.vinixglobal.com/v2 (production) or https://api-sandbox.vinixglobal.com/v2 (sandbox).
• Auth: X-Auth-Token: $VINIX_AUTH_TOKEN on every request. Obtain the token via PUT /v2/user_auth (interactive) or PUT /v2/api_auth (server-to-server). See Authentication.
• Scoping: Resources live under /accounts/{account_id}/.... The account_id is on your dashboard home.
• Pagination: List endpoints accept page_size (1–100, default 25) and cursor. The response contains next_cursor: null when you've reached the end.
• Timestamps: All times are ISO-8601 UTC.
• IDs: All resource IDs are UUIDs unless documented otherwise (phone numbers are E.164; extensions are strings).
• Errors: Non-2xx responses return { code, message, request_id }. Include request_id when filing a support ticket.
• Idempotency: Pass an Idempotency-Key header (UUIDv4) on every write so retries are safe.

Webhooks

API changes are paired with webhook events. See Webhooks for the event catalog and signature verification.

Try it

Every endpoint page has a "Send" button that fires against the sandbox through our CORS-bypass proxy. Drop in your sandbox key, tweak the parameters, see the response. No need to leave the docs.