aYOUne
← Vertrieb API

Opportunities

Singular: Opportunity — Base-URL: https://sale-api.ayoune.app — Zugriff: CRUD

play_circle 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": "65e0b1f3121b7d48fe15a53e",
    "contacts": [],
    "lost": false,
    "won": false,
    "foreignCountry": false,
    "createdBy": "6045f4d25704710012485569",
    "positions": [],
    "createdAt": "2024-02-29T16:33:55.802Z",
    "updatedAt": "2024-02-29T16:33:55.802Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://sale-api.ayoune.app/opportunities/65e0b1f3121b7d48fe15a53e",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "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"
      },
      {
        "rel": "Projects",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.projects"
      },
      {
        "rel": "Offers",
        "title": "MODEL_OFFER",
        "href": "https://api.ayoune.app/sale/offers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.offers"
      },
      {
        "rel": "Pipelines",
        "title": "MODEL_PIPELINE",
        "href": "https://api.ayoune.app/ai/pipelines",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ai.pipelines"
      },
      {
        "rel": "OpportunitySchemas",
        "title": "MODEL_OPPORTUNITYSCHEMA",
        "href": "https://api.ayoune.app/config/opportunityschemas",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.opportunityschemas"
      }
    ],
    "debugId": "6a61992201c854403a7cd0fc",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_OPPORTUNITY",
        "href": "https://api.ayoune.app/sale/opportunities/65e0b1f3121b7d48fe15a53e/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_OPPORTUNITY",
        "href": "https://api.ayoune.app/sale/opportunities/65e0b1f3121b7d48fe15a53e/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.37.2",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2305",
      "reset": "1784784645",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 92.475527,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend