aYOUne
← CRM API

Consumers

Singular: Consumer — 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": {
    "loc": {
      "type": "Point",
      "coordinates": [
        0,
        0
      ]
    },
    "receiver": {
      "general": {
        "medium": "email",
        "cc": ""
      },
      "offer": {
        "medium": "email",
        "cc": ""
      },
      "order": {
        "medium": "email",
        "cc": ""
      },
      "invoice": {
        "medium": "email",
        "cc": ""
      },
      "delivery": {
        "medium": "email",
        "cc": ""
      },
      "reminder": {
        "medium": "email",
        "cc": ""
      },
      "copies": {
        "medium": "email",
        "cc": ""
      },
      "requests": {
        "medium": "email",
        "cc": ""
      }
    },
    "social": {
      "fb": ""
    },
    "salepsychology": {
      "competing": false,
      "demanding": false,
      "dtrong": false,
      "directly": false,
      "dominant": false,
      "straight": false,
      "authoritarian": false,
      "pressurizes": false,
      "opinionated": false,
      "blackwhite": false,
      "aggressive": false,
      "resultOriented": false,
      "reliable": false,
      "logical": false,
      "analytically": false,
      "Detailed": false,
      "precise": false,
      "cool": false,
      "regulated": false,
      "distant": false,
      "quiet": false,
      "controlled": false,
      "diplomatic": false,
      "factOriented": false,
      "sensitive": false,
      "calm": false,
      "careful": false,
      "modest": false,
      "listensPatiently": false,
      "principle": false,
      "trustworthy": false,
      "supportive": false,
      "irresolute": false,
      "restrained": false,
      "serviceOriented": false,
      "optimistic": false,
      "expressive": false,
      "talkative": false,
      "inspiring": false,
      "impulsive": false,
      "compliant": false,
      "emotionally": false,
      "unorganized": false,
      "open": false,
      "sweeping": false,
      "negligent": false,
      "related": false,
      "red": 0,
      "blue": 0,
      "green": 0,
      "yellow": 0
    },
    "notifications": {
      "email": true,
      "telegram": false,
      "interface": false
    },
    "syncWithOutlook": false,
    "syncWithGoogle": false,
    "name_prefix": "",
    "name_suffix": "",
    "nickname": "",
    "ad_hijacking_stage": "new",
    "htmlNote": "",
    "salesBriefing": "",
    "yearlyRevenue": "",
    "industry": "",
    "specialities": [],
    "facebookChatId": false,
    "portalLocked": false,
    "addressValidated": false,
    "addressValidationError": false,
    "optout_comment": "",
    "_id": "65e0b08f121b7d48fe15839d",
    "maintype": "main",
    "private_business": "business",
    "tags": [],
    "interestchannels": [],
    "brands": [],
    "exchangeId": "",
    "restrict_exchange_sync": false,
    "score": 0,
    "happiness": 0,
    "engagement": 0,
    "ayoune_fp": [],
    "preferredChannel": "email",
    "preferredTimeFrom": 9,
    "preferredTimeTo": 17,
    "editor": "6045f4d25704710012485569",
    "team": [],
    "editors": [],
    "t": "contact",
    "temporary": false,
    "accesscode": "***",
    "company": "",
    "legal_form": "",
    "department": "",
    "title": "",
    "salutation_typ": "formell",
    "salutation": "",
    "emails": "",
    "currency": "EUR",
    "locale": "de_DE",
    "foreignCountry": false,
    "phone": "",
    "phone_valid": false,
    "phone_number": "",
    "phone_local_format": "",
    "phone_international_format": "",
    "phone_country_prefix": "",
    "phone_country_code": "",
    "phone_country_name": "",
    "phone_location": "",
    "phone_carrier": "",
    "phone_line_type": "",
    "phone_business": "",
    "fax": "",
    "fax_business": "",
    "cell": "",
    "cell_valid": false,
    "cell_number": "",
    "cell_local_format": "",
    "cell_international_format": "",
    "cell_country_prefix": "",
    "cell_country_code": "",
    "cell_country_name": "",
    "cell_location": "",
    "cell_carrier": "",
    "cell_line_type": "",
    "cell_business": "",
    "privacy_ip": "",
    "brand_bidding_stage": "new",
    "last_message_type": "email",
    "last_coupon_code": "",
    "last_url": "",
    "last_referrer": "",
    "join_url": "",
    "info": "",
    "website": "",
    "domain": "",
    "doiAsked": false,
    "doi": false,
    "doiSMS": false,
    "doiPhone": false,
    "doiWhatsApp": false,
    "doiFaceBook": false,
    "soi": false,
    "soiSMS": false,
    "soiPhone": false,
    "soiWhatsApp": false,
    "soiFaceBook": false,
    "status": "Neu",
    "sales_stage": "Prospecting",
    "contact_status": "Neu",
    "origin": "main",
    "opos": 0,
    "packstationnumber": "",
    "postbumber": "",
    "note": "",
    "affiliate": false,
    "affiliatedata": false,
    "affiliate_status": "none",
    "type": "none",
    "jahresumsatz": "",
    "sicCode": "",
    "branche": "",
    "bio": "",
    "mitarbeiter": 0,
    "employees": 0,
    "wkn": "",
    "rating": "",
    "owner": "",
    "sourcesite": "none",
    "ayoune_source": "none",
    "ayoune_medium": "none",
    "ayoune_term": "none",
    "ayoune_content": "none",
    "ayoune_topic": "none",
    "ayoune_region": "none",
    "ayoune_cta": "none",
    "ayoune_interestbar": "none",
    "ayoune_popup": "none",
    "ayoune_feedback": "none",
    "ayoune_rating": "none",
    "ayoune_campaignname": "none",
    "ayoune_campaign": "none",
    "ayoune_tag": "none",
    "ayoune_app": "none",
    "ayoune_bcn": "none",
    "ayoune_event": "none",
    "ayoune_mail": "none",
    "ayoune_dashboard": "none",
    "ayoune_landingpage": "none",
    "ayoune_newsletter": "none",
    "ayoune_agency": "none",
    "ayoune_partner": "none",
    "kind_of_payment": "Wiederkehrende Zahlung",
    "ustidValid": false,
    "paymentSetup": false,
    "supportCredit": 0,
    "costs": 0,
    "loginAttempts": 0,
    "externalSource": "none",
    "fbChat": false,
    "image": "none",
    "logo": "none",
    "bcImage": "none",
    "bcImageBackside": "none",
    "deliveryblock": false,
    "insolvent": false,
    "construction_cleaning_service": false,
    "collective_bill": false,
    "partial_deliveries": false,
    "overSupply": false,
    "underSupply": false,
    "partial_bills": false,
    "dunning": false,
    "active": true,
    "approved": true,
    "known": false,
    "ignoreInMerge": false,
    "ignoreInCleaning": false,
    "isContactPerson": false,
    "isMainAP": false,
    "hasAP": true,
    "hasLocation": false,
    "hasCheckLists": false,
    "portallocked": false,
    "adress_validated": false,
    "adress_validation_error": false,
    "newsletter": false,
    "optout_reason": "",
    "phoneoptin": true,
    "postoptin": true,
    "approvedDataMerge": false,
    "privacy": false,
    "mailsCount": 0,
    "bounceCount": 0,
    "openCount": 0,
    "openNewsletterCount": 0,
    "openMailCount": 0,
    "openRevenue": 0,
    "totalRevenue": 0,
    "ecommerceRevenue": 0,
    "assignmentRevenue": 0,
    "invoiceRevenue": 0,
    "averageRevenue": 0,
    "countOrders": 0,
    "clickOuts": 0,
    "clickCount": 0,
    "mailClickCount": 0,
    "newsletterClickCount": 0,
    "webViewCount": 0,
    "verified": false,
    "needsOnboarding": false,
    "onboardingDone": false,
    "createdBy": "6045f4d25704710012485569",
    "preferredBrands": [],
    "preferredManufacturers": [],
    "external_ids": [],
    "resubmissions": [],
    "todos": [],
    "addons": [],
    "connections": [],
    "purchasedProducts": [],
    "attributes": [],
    "createdAt": "2024-02-29T16:27:59.712Z",
    "updatedAt": "2024-02-29T16:27:59.712Z",
    "shortID": "otFscAY",
    "messengerChannels": [],
    "isLocked": false,
    "adressFormated": "undefined undefined<br>undefined-undefined undefined",
    "sr": "  ",
    "name": "  ",
    "latitude": 0,
    "longitude": 0,
    "age": 0,
    "userimage": "https://www.gravatar.com/avatar/000000000000",
    "id": "65e0b08f121b7d48fe15839d"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://crm-api.ayoune.app/consumers/65e0b08f121b7d48fe15839d",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "aYOUneCompanies",
        "title": "MODEL_AYOUNECOMPANY",
        "href": "https://api.ayoune.app/su/ayounecompanies",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "su.companies"
      },
      {
        "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": "Locations",
        "title": "MODEL_LOCATION",
        "href": "https://api.ayoune.app/config/locations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.locations"
      },
      {
        "rel": "PriceGroups",
        "title": "MODEL_PRICEGROUP",
        "href": "https://api.ayoune.app/config/pricegroups",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.pricegroups"
      },
      {
        "rel": "DiscountGroups",
        "title": "MODEL_DISCOUNTGROUP",
        "href": "https://api.ayoune.app/config/discountgroups",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.discountgroups"
      },
      {
        "rel": "PaymentGroups",
        "title": "MODEL_PAYMENTGROUP",
        "href": "https://api.ayoune.app/config/paymentgroups",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.paymentgroups"
      },
      {
        "rel": "LoyaltyPrograms",
        "title": "MODEL_LOYALTYPROGRAM",
        "href": "https://api.ayoune.app/marketing/loyaltyprograms",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "marketing.loyaltyprograms"
      },
      {
        "rel": "SLAs",
        "title": "MODEL_SLA",
        "href": "https://api.ayoune.app/config/slas",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.slas"
      },
      {
        "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": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "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": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "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": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "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": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "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": "CommissionGroups",
        "title": "MODEL_COMMISSIONGROUP",
        "href": "https://api.ayoune.app/config/commissiongroups",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.commissiongroups"
      },
      {
        "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": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "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": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "rel": "ChatWidgets",
        "title": "MODEL_CHATWIDGET",
        "href": "https://api.ayoune.app/marketing/chatwidgets",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "marketing.chatwidgets"
      },
      {
        "rel": "CheckListTemplates",
        "title": "MODEL_CHECKLISTTEMPLATE",
        "href": "https://api.ayoune.app/config/checklisttemplates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.checklisttemplates"
      }
    ],
    "debugId": "6a62df68d98fe96440cc8a6e",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers/65e0b08f121b7d48fe15839d/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers/65e0b08f121b7d48fe15839d/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.46.1",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2410",
      "reset": "1784868196",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 110.831038,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also