aYOUne
← CMS API

Snippets

Singular: Snippet — Base URL: https://cms-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": "65e0afce121b7d48fe155804",
    "public": false,
    "protected": true,
    "type": "plain",
    "contentType": "text/plain",
    "snippetType": "general",
    "content": "",
    "tags": [],
    "view": "cms.snippets.edit",
    "viewTitle": "Snippets",
    "createdBy": "6045f4d25704710012485569",
    "revisions": [],
    "createdAt": "2024-02-29T16:24:46.138Z",
    "updatedAt": "2024-02-29T16:24:46.138Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://cms-api.ayoune.app/snippets/65e0afce121b7d48fe155804",
        "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"
      },
      {
        "rel": "Tasks",
        "title": "MODEL_TASK",
        "href": "https://api.ayoune.app/pm/tasks",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.tasks"
      }
    ],
    "debugId": "6a62dc7d01c81db07e1db5d2",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SNIPPET",
        "href": "https://api.ayoune.app/cms/snippets/65e0afce121b7d48fe155804/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SNIPPET",
        "href": "https://api.ayoune.app/cms/snippets/65e0afce121b7d48fe155804/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.25.5",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2349",
      "reset": "1784867449",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 49.238587,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also