aYOUne
← Configuration API

ConsumerAPIs

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

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": "65e0aff5121b7d48fe156462",
    "callbackUrl": "https://www.deineurl.de/",
    "active": true,
    "scopes": [],
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:25:25.366Z",
    "updatedAt": "2024-02-29T16:25:25.366Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/consumerapis/65e0aff5121b7d48fe156462",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "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"
      }
    ],
    "debugId": "6aa3747e0a0df7eaaeb85c83",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CONSUMERAPI",
        "href": "https://api.ayoune.app/config/consumerapis/65e0aff5121b7d48fe156462/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CONSUMERAPI",
        "href": "https://api.ayoune.app/config/consumerapis/65e0aff5121b7d48fe156462",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.161.0",
      "core": "2026.335.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1963",
      "reset": "1789099354",
      "resetDate": "Fri Sep 11 2026"
    },
    "responseTime": 185.556419,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also