Zum Inhalt springen
aYOUne
← CRM API

Enrichments

Singular: Enrichment — Base-URL: https://crm-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "_id": "6acef9c6c8c70d7a392b2aef",
    "_consumerID": "6acea573217ce135e8992831",
    "type": "geocoder",
    "merged": false,
    "data": {
      "query": "Almweg, 83700, Oberhof, Deutschland",
      "formatted_address": "Oberhof, 83700 Kreuth, Deutschland",
      "location": {
        "lat": 47.6813999,
        "lng": 11.7619855
      },
      "place_id": "ChIJlQwic9yOnUcRQctC_6QlHSY",
      "location_type": "APPROXIMATE",
      "ok": true,
      "at": "2026-10-14T03:40:54.901Z"
    },
    "isDraft": true,
    "createdAt": "2026-10-14T03:40:54.902Z",
    "updatedAt": "2026-10-14T03:40:54.902Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://crm-api.ayoune.app/enrichments/6acef9c6c8c70d7a392b2aef",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers/6acea573217ce135e8992831",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      }
    ],
    "debugId": "6ad834bfaea9302526b17d3f",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_ENRICHMENT",
        "href": "https://api.ayoune.app/crm/enrichments/6acef9c6c8c70d7a392b2aef/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_ENRICHMENT",
        "href": "https://api.ayoune.app/crm/enrichments/6acef9c6c8c70d7a392b2aef",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.79.1",
      "core": "2026.386.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9840",
      "reset": "1792557684",
      "resetDate": "Wed Oct 21 2026"
    },
    "responseTime": 120.533786,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /enrichments Liste mit Filtern/Paginierung crm.enrichments.view
GET /enrichments/:id Einzelner Datensatz crm.enrichments.view
POST /enrichments Neuen Datensatz erstellen crm.enrichments.new
PUT /enrichments Datensatz aktualisieren crm.enrichments.edit
DELETE /enrichments/:id Datensatz löschen crm.enrichments.delete

SDK

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

// Alle abrufen
const list = await ay.crm.enrichments.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.crm.enrichments.findById('OBJECT_ID').exec();

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

Weiterführend