List Vault documents

Files, folders, documents and spreadsheets. What comes back is filtered per item on top of the scope: a folder mirroring a Threads channel or DM is visible only to that conversation’s members, and anything you cannot reach is absent rather than returned as a stub. File contents are not included — ask for a download URL on the item itself.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

vault:admin

Query Parameters

Name	Type	Required	Description
`limit`	number	Optional	Maximum number of items to return (1-100).Default: `20`
`offset`	number	Optional	Number of items to skip before starting to collect the result set.Default: `0`
`sortBy`	string	Optional	Field to sort by. Allowed values vary by endpoint.Default: `createdAt`
`sortOrder`	string asc desc	Optional	Sort direction.Default: `desc`
`search`	string	Optional	Free-text search across the resource’s primary fields.
`createdAfter`	string	Optional	ISO 8601 timestamp — only return items created after this time.
`createdBefore`	string	Optional	ISO 8601 timestamp — only return items created before this time.
`updatedAfter`	string	Optional	ISO 8601 timestamp — only return items updated after this time.
`parentId`	string	Optional	One folder’s contents. Pass the literal `root` for the top level.
`type`	string FOLDER DOCUMENT SPREADSHEET FILE	Optional	Narrow to one kind of item.
`includeArchived`	boolean	Optional	Set `true` to include archived items.

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/vault-documents" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Vault documents retrieved successfully!",
  "content": {
    "documents": [
      {
        "id": "vdoc_4410",
        "referenceId": 318,
        "name": "Q3 board pack.pdf",
        "type": "FILE",
        "parentId": "vdoc_0001",
        "description": null,
        "fileSize": 2418123,
        "mimeType": "application/pdf",
        "tags": [
          "board"
        ],
        "isSystem": false,
        "systemType": null,
        "createdById": "emp_12ab",
        "updatedById": null,
        "createdAt": "2026-08-12T11:00:00.000Z",
        "updatedAt": "2026-08-12T11:00:00.000Z",
        "archivedAt": null
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Vault

/vault