← Configuration API
Attributes
Singular: Attribute — Base URL: https://config-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)
Try it now
beta
Response (live)
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": {
"trackingAction": {
"enabled": false,
"name": ""
},
"settings": {
"min": 0,
"max": 10000000,
"step": 0,
"unit": "",
"family": "",
"slider": false,
"charlimit": -1,
"useFileTemplate": false,
"filetemplatekind": "static"
},
"tableSettings": {
"headers": []
},
"listsettings": {
"model": "0",
"conditions": []
},
"requiredCalculationAttributes": [],
"_id": "60264b8ab5ce4800128816ca",
"fancy": false,
"global": false,
"model": "consumers",
"masschange": false,
"attribute": "lageplan",
"INTID": "",
"portalname": "Lageplan",
"portalname_en": "",
"so": 0,
"type": "document-upload",
"editable": true,
"supplier": false,
"readonly": false,
"quick": false,
"showAttributesOnTyp": [],
"help": "",
"calculated": false,
"formula": "",
"placeholder": "",
"databinding": false,
"databindingEntity": "false",
"databindingLimit": 0,
"databindingSelection": "",
"dependence": false,
"dependence_field": "",
"dependence_value": "",
"functionBeforeSave": "none",
"functionBeforeSaveParam": "",
"importable": false,
"created": "2021-02-12T09:34:02.470Z",
"allocations": [],
"values": [],
"createdAt": "2021-02-12T09:34:02.472Z",
"updatedAt": "2021-02-12T09:34:28.010Z",
"description": "Lageplan",
"group": "61c9347f7b2800236e1bd132",
"models": [
"consumers"
],
"shares": []
},
"meta": {
"links": [
{
"rel": "self",
"href": "https://pim-api.ayoune.app/attributes/60264b8ab5ce4800128816ca",
"method": "get",
"title": "GET",
"types": [
"application/json",
"application/yaml",
"text/csv"
]
}
],
"relations": [],
"debugId": "6aa3852d7a67ad56951697f2",
"errors": [],
"actions": [],
"version": {
"host": "2026.33.0",
"core": "2026.335.0"
},
"rateLimit": {
"limit": "2500",
"remaining": "2419",
"reset": "1789104929",
"resetDate": "Fri Sep 11 2026"
},
"responseTime": 122.514814,
"code": 200,
"status": "success",
"error": false
}
}
Endpoints
| Method | Path | Description | Right |
|---|---|---|---|
| GET | /attributes |
List with filters/pagination | config.attributes.view |
| GET | /attributes/:id |
Single record | config.attributes.view |
| POST | /attributes |
Create new record | config.attributes.new |
| PUT | /attributes |
Update record | config.attributes.edit |
| DELETE | /attributes/:id |
Delete record | config.attributes.delete |
SDK
import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');
// List all
const list = await ay.config.attributes.find().limit(10).exec();
// Single record
const one = await ay.config.attributes.findById('OBJECT_ID').exec();
// Create
const created = await ay.config.attributes.create({ name: 'Foo' });