API Overview

Introduction to the Ayorax REST API — authentication, base URL, and response format.

4 min readAPI & Webhooks

The Ayorax REST API lets you read and write data programmatically — create leads, trigger workflows, fetch analytics, and integrate Ayorax into your own systems.

Base URL

code

Authentication

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

code

Response format

code

HTTP status codes

CodeMeaning
200Success
201Created
400Bad request — validation error
401Unauthorized — invalid or missing API key
403Forbidden — insufficient permissions
404Not found
429Rate limit exceeded
500Internal server error

Key endpoints

  • GET /v1/leads — list and filter leads
  • POST /v1/leads — create a lead
  • POST /v1/leads/:id/score — trigger AI scoring
  • GET /v1/workflows — list workflows
  • POST /v1/workflows/:id/run — trigger a workflow
  • POST /v1/webhooks — register a webhook
Was this article helpful?