API ReferenceView as MarkdownOpenAPI

Material

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 material

Returns the material.

User token

Needs the token of a signed-in user.

Query parameters
dependability_filterstring

Only materials with this dependability filter.

no_populatestring

Only materials with this no populate.

Status codes

200 401 500

GET/material
curl -X GET 'http://fiorelina.com/material?ionic=true&dependability_filter=...&no_populate=...' \
  -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"
}

Create a material

Creates a material from the fields sent.

User token

Needs the token of a signed-in user.

Status codes

201 400 401 500

POST/material
curl -X POST 'http://fiorelina.com/material?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 material

Returns one material, found by its ID.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the material.

Query parameters
no_populatestring

Only materials with this no populate.

Status codes

200 401 404 500

GET/material/:id
curl -X GET 'http://fiorelina.com/material/{id}?ionic=true&no_populate=...' \
  -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"
}

Update a material

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 material.

Status codes

200 400 401 404 500

PATCH/material/:id
curl -X PATCH 'http://fiorelina.com/material/{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 material

Deletes the material. This cannot be undone.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the material.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/material/:id
curl -X DELETE 'http://fiorelina.com/material/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
↑↓ Navigate↵ GoEsc Close