API ReferenceView as MarkdownOpenAPI

Price

View as Markdown

Endpoints that need a token: the site owner creates it in their admin (Developers > API reference). AI assistants: how to ask the user for one.

5 endpoints.

Retrieve the price

Returns the price.

Public

Public - no token needed.

Query parameters
dependability_filterstring

Only prices with this dependability filter.

no_populatestring

Only prices with this no populate.

Status codes

200 500

GET/price
curl -X GET 'http://cloudoffice.max-media.io/price?ionic=true&dependability_filter=...&no_populate=...'
Response
{
  "name": "Example",
  "make": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Create a price

Creates a price from the fields sent.

User token

Needs the token of a signed-in user.

Status codes

201 400 401 500

POST/price
curl -X POST 'http://cloudoffice.max-media.io/price?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "name": "Example",
  "make": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Retrieve a price

Returns one price, found by its ID.

Public

Public - no token needed.

Path parameters
idstringRequired

The ID of the price.

Query parameters
no_populatestring

Only prices with this no populate.

Status codes

200 404 500

GET/price/:id
curl -X GET 'http://cloudoffice.max-media.io/price/{id}?ionic=true&no_populate=...'
Response
{
  "name": "Example",
  "make": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Update a price

Changes the fields sent; the others stay as they are.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the price.

Status codes

200 400 401 404 500

PATCH/price/:id
curl -X PATCH 'http://cloudoffice.max-media.io/price/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "name": "Example",
  "make": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Delete a price

Deletes the price. This cannot be undone.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the price.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/price/:id
curl -X DELETE 'http://cloudoffice.max-media.io/price/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
↑↓ Navigate↵ GoEsc Close