aYOUne
← Configuration API

Calendars

Singular: Calendar — 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": {
    "syncSettings": {
      "google": {
        "watch": false
      },
      "outlook": {
        "watch": false
      }
    },
    "workTimes": {
      "mo": [],
      "di": [],
      "mi": [],
      "do": [],
      "fr": [],
      "sa": [],
      "so": []
    },
    "type": "aYOUne",
    "onlineBooking": false,
    "externalBooking": false,
    "depositRequired": false,
    "_id": "65e0afe6121b7d48fe155f8e",
    "color": "#38a5f8",
    "secondaryColor": "#1e557f",
    "resource": false,
    "theme": "blue",
    "shared": false,
    "onlinebooking": false,
    "externalbooking": false,
    "autoApprove": false,
    "sync": true,
    "slot": 60,
    "worktimes": {
      "mo": [],
      "di": [],
      "mi": [],
      "do": [],
      "fr": [],
      "sa": [],
      "so": []
    },
    "createdBy": "6045f4d25704710012485569",
    "services": [],
    "createdAt": "2024-02-29T16:25:10.256Z",
    "updatedAt": "2024-02-29T16:25:10.256Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/calendars/65e0afe6121b7d48fe155f8e",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Teams",
        "title": "MODEL_TEAM",
        "href": "https://api.ayoune.app/config/teams",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.teams"
      },
      {
        "rel": "Credentials",
        "title": "MODEL_CREDENTIAL",
        "href": "https://api.ayoune.app/config/credentials",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.credentials"
      },
      {
        "rel": "WebReceivers",
        "title": "MODEL_WEBRECEIVER",
        "href": "https://api.ayoune.app/config/webreceivers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.webreceivers"
      },
      {
        "rel": "WebReceivers",
        "title": "MODEL_WEBRECEIVER",
        "href": "https://api.ayoune.app/config/webreceivers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.webreceivers"
      }
    ],
    "debugId": "6a62dcee30b7d778029e60e8",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CALENDAR",
        "href": "https://api.ayoune.app/config/calendars/65e0afe6121b7d48fe155f8e/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CALENDAR",
        "href": "https://api.ayoune.app/config/calendars/65e0afe6121b7d48fe155f8e/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.94.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2278",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 195.672989,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also