Skip to content
aYOUne
← CRM API

Leads

Singular: Lead — Base URL: https://crm-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "6ab226ff497e7e1a340567c0",
    "createdAt": "2026-09-22T06:58:05.891Z",
    "updatedAt": "2026-09-22T06:58:05.891Z",
    "title": "",
    "salutation": "Herr",
    "first_name": "Laura",
    "last_name": "Lindner",
    "email": "laura.lindner@tolinaxdemo.example",
    "street": "Schulstrasse 105",
    "zip": "01067",
    "city": "Dresden",
    "phone": "+49 30 23125 58",
    "cell": "",
    "newsletter": false,
    "privacy": true,
    "last_active": "2026-09-02T09:00:00.000Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://crm-api.ayoune.app/leads/6ab226ff497e7e1a340567c0",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6adec89b22f3608d07632b1c",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_LEAD",
        "href": "https://api.ayoune.app/crm/leads/6ab226ff497e7e1a340567c0/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_LEAD",
        "href": "https://api.ayoune.app/crm/leads/6ab226ff497e7e1a340567c0",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.79.1",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9818",
      "reset": "1792988732",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 1003.235798,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /leads List with filters/pagination crm.leads.view
GET /leads/:id Single record crm.leads.view
POST /leads Create new record crm.leads.new
PUT /leads Update record crm.leads.edit
DELETE /leads/:id Delete record crm.leads.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.crm.leads.find().limit(10).exec();

// Single record
const one = await ay.crm.leads.findById('OBJECT_ID').exec();

// Create
const created = await ay.crm.leads.create({ name: 'Foo' });

See also