aYOUne
← Configuration API

ProcedureSteps

Singular: ProcedureStep — 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": "60264975b5ce480012881616",
    "_consumerID": "60043b387d3c46001481a8e5",
    "_procedure": "6026491bb5ce4800128815e6",
    "_step": "60264932b5ce4800128815f1",
    "createdAt": "2021-02-12T09:25:09.455Z",
    "updatedAt": "2021-02-12T09:25:09.455Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/proceduresteps/60264975b5ce480012881616",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers/60043b387d3c46001481a8e5",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "rel": "Procedures",
        "title": "MODEL_PROCEDURE",
        "href": "https://api.ayoune.app/config/procedures/6026491bb5ce4800128815e6",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.procedures"
      }
    ],
    "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": "Procedures",
        "title": "MODEL_PROCEDURE",
        "href": "https://api.ayoune.app/config/procedures",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.procedures"
      }
    ],
    "debugId": "6aa0d5f6744f0c5dd401b66c",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PROCEDURESTEP",
        "href": "https://api.ayoune.app/config/proceduresteps/60264975b5ce480012881616/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PROCEDURESTEP",
        "href": "https://api.ayoune.app/config/proceduresteps/60264975b5ce480012881616",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.159.0",
      "core": "2026.334.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "578",
      "reset": "1788926544",
      "resetDate": "Wed Sep 09 2026"
    },
    "responseTime": 1890.615758,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also