Skip to content
aYOUne
← Configuration API

SubClients

Singular: SubClient — Base URL: https://config-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

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": "65e0b075121b7d48fe15807e",
    "company": "",
    "street": "",
    "zip": "",
    "city": "",
    "country": "Deutschland",
    "state": "",
    "phone": "",
    "fax": "",
    "cell": "",
    "website": "",
    "note": "",
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:27:33.447Z",
    "updatedAt": "2024-02-29T16:27:33.447Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/subclients/65e0b075121b7d48fe15807e",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6acb0446639a90c4792706e4",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SUBCLIENT",
        "href": "https://api.ayoune.app/config/subclients/65e0b075121b7d48fe15807e/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SUBCLIENT",
        "href": "https://api.ayoune.app/config/subclients/65e0b075121b7d48fe15807e",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.368.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "8786",
      "reset": "1791691321",
      "resetDate": "Sun Oct 11 2026"
    },
    "responseTime": 182.108354,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also