Skip to main content
GET
List Blob Objects in a Folder
Lists the blob objects of the account in path order. Use prefix to list one folder and delimiter=/ to get its sub-folders as folders. Pass the returned cursor back to get the next page; cursor is null on the last page. Scope: blob:read.
string
Only objects whose path starts with this text, for example images/.
string
Group paths into folders at this character, usually /. Folders come back in folders and not as objects.
string
Only public or only private objects.
string
The cursor from the previous page. Omit it for the first page.
number
Objects per page, 1–1000. Default 100.
string
The workspace ID, when the blob belongs to a workspace. The call acts on the blob of the workspace owner and needs the blob:read workspace permission (blob:manage on routes that change data). Leave it out to act on your own blob.

Example request

Response

object
The page of objects, its sub-folders and the cursor for the next page.

Error Responses

string
The error code indicating the reason for failure. Possible values:
  • AUTH_TOKEN_MISSING (401): No Authorization header was sent.
  • API_KEY_INVALID (401): The API key doesn’t exist, was revoked, or its secret doesn’t match.
  • API_KEY_SCOPE_DENIED (403): The key lacks the scope this route needs (blob:read or blob:write); details.required names it.
  • WORKSPACE_PERMISSION_DENIED (403): Only with workspace_id: you’re not a member, or your role lacks the blob permission.
  • WORKSPACE_NOT_FOUND (404): Only with workspace_id: no workspace with that ID, or you’re not a member.
  • VALIDATION_ERROR (400): A parameter failed validation, with details.path naming it. A malformed cursor, or one from another query, returns it with details.path set to cursor.