MyQ REST API documentation
English French German Italian Portuguese Spanish
MyQ REST API documentation
English French German Italian Portuguese Spanish
Breadcrumbs

API Endpoints

Complete REST API Documentation

YAML files containing the full list of available endpoints can be copied directly from the installation folder:

C:\Program Files\MyQ\PhpApps\PrintServer\src\Api

Or downloaded from these addresses:

Open these URLs in the browser locally on the MyQ X server or replace localhost and port with your values to download them from a remote server.

For better clarity, YAML can be interpreted with e.g. https://editor.swagger.io/.

How to Read YAML



image-20250310-203232.png

  • tags = required scope

  • security = token type required to use this endpoint

  • responses = success response, potential error responses, and their description

  • $ref = reference to a schema for more details; schemas are at the end of the YAML file
image-20250310-203456.png

  • refers to the additional schemas
image-20250310-203615.png

  • description of the schema, its objects, etc.