aYOUne
← Configuration API

AttributeGroups

Singular: AttributeGroup — Base URL: https://config-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": "65ce1585d9c99cea25734806",
    "name": "",
    "name_en": "",
    "description": "",
    "description_en": "",
    "note": "",
    "showInCustomerPortal": false,
    "editable": false,
    "readonly": false,
    "so": 0,
    "dependence": false,
    "dependence_field": "",
    "dependence_value": "",
    "types": [
      "lead",
      "customer",
      "partner",
      "supplier",
      "contact",
      "archive",
      "affiliate",
      "multiplier"
    ],
    "kinds": [
      "main",
      "cp"
    ],
    "models": [
      "consumers"
    ],
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-15T13:45:41.872Z",
    "updatedAt": "2024-02-15T13:45:41.872Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/attributegroups/65ce1585d9c99cea25734806",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a62dcd630b7d778029e5992",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_ATTRIBUTEGROUP",
        "href": "https://api.ayoune.app/config/attributegroups/65ce1585d9c99cea25734806/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_ATTRIBUTEGROUP",
        "href": "https://api.ayoune.app/config/attributegroups/65ce1585d9c99cea25734806/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.94.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2364",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 95.379595,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also