aYOUne
← Developer Hub

API Reference

633 entities across 31 modules. Each module has its own REST API at https://{module}-api.ayoune.app.

Standard Endpoint Pattern

Every entity follows the same CRUD pattern:

MethodPathDescription
GET/{entities}List (paginated, filterable)
GET/{entities}/:idSingle document
POST/{entities}Create (body: {entries:[...]})
PUT/{entities}Update
DELETE/{entities}/:idDelete
POST/{entities}/:id/copyDuplicate
POST/{entities}/:id/actions/{name}Custom action

Modules

Accounting

Journals, cost centers, bank accounts, FX rates

ads

Affiliate

Partners, campaigns, commissions, attribution, loyalty

AI

Copilot, agents, RAG, knowledge base, workflows, custom functions

Automation

Workflows, triggers, checks, pipelines

CMS

Pages, content, websites, downloads, streams

coding

communication

Configuration

Users, rights, settings, notifications, i18n, credentials

CRM

Contacts, leads, scoring, forms, tracking

DevOps

Clusters, pipelines, deployments, repositories

E-Commerce

Shopping carts, shops, transactions, recommendations

Export

Data exports, channels, configurations

HR

Shifts, courses, skills, time tracking, job offers

Hub

Apps, events, FAQ, wiki, polls

iot

Marketing

Campaigns, newsletters, coupons, popups, CTAs, tracking

marketplace

Monitoring

Dashboards, KPIs, alerts, metrics, heartbeats

payments

Personal

Journals, calendar, personal workspace

PIM

Product selections, feeds, listings

planning

Project Management

Projects, tasks, kanban, milestones, sprints, epics

Production

Production orders, machines, quality control

Purchase

Suppliers, trade channels, goods receipts, incoming invoices

Reporting

Reports, data collections, analytics, widget stats

Research

SERP crawling, competitive intelligence

Sales

Products, offers, invoices, shipping, pricing, commissions

Service Desk

Tickets, SLAs, announcements

Warehouse

Stock, pick lists, docks, transport, replenishment