Skip to main content
GET
Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.
Returns a page of the documents in a repository, sorted by name. Each document wraps one file and carries its indexing status. Documents synced from a connected source, such as a SharePoint folder, are listed too. Pass folder_id to list only the documents directly in one folder. Find folder ids with List Folders. A page of a folder can hold fewer than limit documents, even none, while cursor is not null: its subfolders take up room in the page. Keep going until cursor is null. To find documents that failed to index, walk the pages and check indexing_status.

Authentication

Requires an API key, or an OAuth token with repositories:read.

Path parameters

string
required
The repository id.

Query parameters

string
Only documents directly in this folder. Documents in its subfolders are not included.
string
The cursor from the previous page. Leave it out for the first page.
integer
default:"50"
Documents per page, from 1 to 100.

Response

Returns 200 with a page of documents. cursor is null on the last page.
object[]
string | null

Errors