v1

latestOpenAPI 3.1.02026-07-22304756.7 KB
Box

List boxes

get/boxes

Query parameters

limitinteger

Maximum items to return.

cursorstring nullable

Opaque pagination cursor returned as pageInfo.nextCursor.

sort'asc' | 'desc'

Sort direction for cursor pagination.

statestring

Comma-separated Box state filter, for example ready,idle,running.

Response

Boxes owned by the authenticated Box user.

okboolean required
type'box.list' required

Stable success envelope discriminator added by v1.

Example response

{
  "ok": true,
  "boxes": [
    {
      "id": "bx_23456789",
      "name": "Box 2026-05-31 12:00"
    }
  ]
}