Skip to content

List a trip's document folders

View as Markdown Open in Claude

GET/v1/trips/{tripId}/document-folders

Lists a trip's document folders by name, each with how many documents it holds, in one page. Documents name their folder in folderId.

Permissions: documents:read · Kind: read · Cost: 1 unit

Path parameters

Field	Type	Required	Description
`tripId`	uuid	yes

Query parameters

None.

Response `200`

Field	Type	Required	Description
`object`	"list"	yes
`data`	object[]	yes
`data[].object`	"document_folder"	yes
`data[].id`	uuid	yes
`data[].tripId`	uuid	yes
`data[].name`	string	yes
`data[].documentCount`	integer	yes	Ready documents filed in it. ≥ 0
`data[].createdAt`	string	yes
`nextCursor`	string \| null	yes

Errors

Errors are problem details. Besides the refusals described above, any call like this one can return:

invalid_request — Invalid request
unauthorized — Missing or invalid API key
insufficient_scope — Missing permission
rate_limited — Rate limit reached
not_found — Not found

Examples

curl

curl https://api.bymundi.com/v1/trips/$TRIP_ID/document-folders \
  -H "Authorization: Bearer $BYMUNDI_KEY"

JavaScript

const res = await fetch(`https://api.bymundi.com/v1/trips/${tripId}/document-folders`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.BYMUNDI_KEY}`,
  },
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();

Python

import os, uuid, requests

res = requests.get(
    f"https://api.bymundi.com/v1/trips/{tripId}/document-folders",
    headers={"Authorization": f"Bearer {os.environ['BYMUNDI_KEY']}"},
)
res.raise_for_status()
data = res.json()