Skip to content
Savorum API

Read pantry presence

GET
/api/v1/pantry
curl --request GET \
  --url http://127.0.0.1:8080/api/v1/pantry \
  --header 'Authorization: Bearer <token>'

Library-shared hints only. Presence and approximate amounts never imply sufficient stock, change shopping selections, or travel in SREF.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
Array<object> | null
object
amount
string
<= 100 characters
id
required
string
location
string
<= 100 characters
name
required
string
>= 1 characters <= 200 characters
note
string
<= 2000 characters
revision
required
integer format: int64
semantic_id
string
<= 200 characters
unit
string
<= 100 characters
updated_at
required
string format: date-time
updated_by
required
string
key
additional properties
any
Examplegenerated
[
  {
    "amount": "example",
    "id": "example",
    "location": "example",
    "name": "example",
    "note": "example",
    "revision": 1,
    "semantic_id": "example",
    "unit": "example",
    "updated_at": "2026-04-15T12:00:00Z",
    "updated_by": "example"
  }
]

401

Section titled “401”

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
code

Stable application error code; clients may also use the problem type suffix.

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

key
additional properties
any
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
params

Structured context for the stable error code.

object
key
additional properties
any
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
violations
Array<object>
object
code
required
string
location
required
string
params
object
key
additional properties
any
key
additional properties
any
Example
{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}