GET
/
materials
List materials
curl --request GET \
  --url https://api.truecold.io/v1/materials \
  --header 'x-api-key: <api-key>'
{
  "error": false,
  "data": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "account_id": "<string>",
      "material_code": "<string>",
      "material_name": "<string>",
      "allowance": 123,
      "temperature_range_id": "<string>",
      "soft_deleted": "<string>",
      "soft_deleted_by": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
id
string

UUID of the material

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

​
material_code
string

String that represents the internal material code

Example:

"25-BCN-XA43N"

​
material_name
string

String that represents the material name

Example:

"TC YEASTOLATE 10KG"

​
allowance
string

String that represents the material allowance, the allowance is the amount of time that the material can be outside the temperature range

Example:

"10"

​
sort
enum<string>

Sort the materials by created_at date

Available options:
asc,
desc
Example:

"asc"

Response

200
application/json

The response is of type object.