Skip to main content
GET
Read a vault's document table

Authorizations

Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Path Parameters

id
string<uuid>
required

The vault ID

Query Parameters

limit
integer
default:100

Max rows to return (default 100, max 200)

Required range: 1 <= x <= 200
offset
integer | null
default:0

Number of items to skip (default 0)

Required range: x >= 0

Case-insensitive substring match on the document name, the upload filename, or the Document Name column.

Maximum string length: 200
filter
string

URL-encoded JSON array of filter rules. See the description for the shape and the operators.

Maximum string length: 8000
Example:

"[{\"field\":\"governingLaw\",\"operator\":\"equals\",\"value\":\"Delaware\"}]"

sort
string

Column field_key to sort by. Also accepts fileName (the upload filename), extractedAt, and sourceName. Defaults to fileName, ascending.

Maximum string length: 200
Example:

"extractedAt"

sort_direction
enum<string>

Sort direction. Defaults to asc.

Available options:
asc,
desc
include_total
enum<string>

When false, skip the whole-vault count and return total: null. Defaults to true.

Available options:
true,
false
Example:

"false"

include_deleted
enum<string>

When true, also return soft-deleted documents and the copies GC AI removed as duplicates. Reading deleted documents needs the same rights as deleting them, so this requires the editor or owner role plus the organization-level permission to manage vaults. Defaults to false.

Available options:
true,
false
Example:

"true"

Response

A page of the document table

documents
object[]
required
total
number | null
required

Rows matching the filters across the whole vault, not just this page. Null when the request passed include_total=false, which skips the count.

pagination
object
required
Last modified on September 25, 2026