Skip to main content

GET /api/tally/envelopes/{zid}/folders

Powers the folder chips in the Envelopes manager.

Local coins only (the folder is the owner's private organisation, not a mesh concept). "unfiled" (NULL/''/'unfiled') is rolled into one bucket the UI shows as Unfiled.

MethodGET
Path/api/tally/envelopes/{zid}/folders
Feature areaTally
TagOther
Authmachine key — Authorization: Bearer $ZEQ_KEY
Tierauthenticated (machine-control)

Parameters

Path parameters

NameTypeRequiredDescription
zidstringyes

No query or header parameters are published for this operation.

Request body

This operation takes no request body.

Responses

StatusMeaning
200OK
401Missing or invalid credentials
500Server error

401 body

FieldTypeRequiredDescription
okboolean — one of falseyes
errorstringnoHuman-readable message.
codestringnoStable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED.

500 body

FieldTypeRequiredDescription
okboolean — one of falseyes
errorstringnoHuman-readable message.
codestringnoStable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED.

Call it

curl -sS -X GET https://zeq.me/api/tally/envelopes/ZEQ7B3K9QX2M7T4V8N1C6H0DZ/folders \
-H "Authorization: Bearer $ZEQ_KEY"

Needs a machine key. Mint one: curl -sS -X POST https://zeq.me/api/demo-key/mint, then spin up your machine.


Generated from the live OpenAPI description (https://zeq.me/openapi.json, spec version 1.287.0) by scripts/generate-reference.mjs. Do not edit — this file is rewritten on every run.