aYOUne
← CRM API

Activities

Singular: Activity — Base URL: https://crm-api.ayoune.app — Access: CRUD

play_circle 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": "6026497fb5ce480012881617",
    "ap": "",
    "priority": "Normal",
    "type": "Anruf",
    "in_out": "Ausgehend",
    "documentref": "",
    "status": "Durchgeführt",
    "outcome": "neutral",
    "subject": "",
    "_consumerID": "60043b387d3c46001481a8e5",
    "note": "<p><a href=\"https://app.bappsy.com/#/config/procedure/edit/60264975b5ce480012881616\">Ablauf gestartet</a></p>",
    "user": "5ee06fc3860473001cfb290e",
    "start": "2021-02-12T09:24:46.825Z",
    "end": "2021-02-12T09:25:12.806Z",
    "created": "2021-02-12T09:25:19.973Z",
    "createdAt": "2021-02-12T09:25:19.974Z",
    "updatedAt": "2021-02-12T09:25:19.974Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://crm-api.ayoune.app/activities/6026497fb5ce480012881617",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers/60043b387d3c46001481a8e5",
        "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"
      },
      {
        "rel": "Documents",
        "title": "MODEL_DOCUMENT",
        "href": "https://api.ayoune.app/crm/documents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.documents"
      }
    ],
    "debugId": "6a62df55d98fe96440cc84ac",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_ACTIVITY",
        "href": "https://api.ayoune.app/crm/activities/6026497fb5ce480012881617/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_ACTIVITY",
        "href": "https://api.ayoune.app/crm/activities/6026497fb5ce480012881617/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.46.1",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2491",
      "reset": "1784868196",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 83.570267,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also