Skip to main content
GET
/
snapshots
List snapshots
curl --request GET \
  --url https://ascii.dev/api/box/v1/snapshots \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "type": "snapshot.list",
  "snapshots": [
    {
      "id": "7417be09-d419-4ae0-b3fc-7f04a5a71ef1",
      "boxId": "bx_23456789",
      "status": "completed",
      "kind": "incremental",
      "generation": 3,
      "chainId": "4ced5b04-d2cb-4ec3-b127-3b3ed836cab5",
      "createdAt": "2026-06-24T06:24:00Z",
      "completedAt": "2026-06-24T06:24:50Z",
      "sizeBytes": 18874368,
      "fileCount": 6781
    }
  ],
  "pageInfo": {
    "nextCursor": null,
    "hasMore": false,
    "limit": 50
  }
}

Authorizations

​
Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Query Parameters

​
limit
integer
default:100

Maximum items to return.

Required range: 1 <= x <= 200
​
cursor
string | null

Opaque pagination cursor returned as pageInfo.nextCursor.

​
sort
enum<string>
default:desc

Sort direction for cursor pagination.

Available options:
asc,
desc

Response

Completed snapshots owned by the authenticated Box user.

​
ok
boolean
required
Example:

true

​
type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "snapshot.list"
​
snapshots
object[]
required
​
pageInfo
object