Error
List documents
Fetch document and collection metadata available to the API key. Requires the docs:read scope.
GET
Error
Returns Pharen Docs documents visible to the key creator. Use this endpoint for document inventories, search indexing jobs, and export tools.
Required API key scope:
docs:read.Query parameters
string
Team UUID for team-scoped keys.
string
Optional collection UUID to limit results to one collection.
string
Search term for document names and visible metadata.
integer
Page number for paginated responses.
Response
integer
Total number of matching documents.
array
Document records visible to the key.
Authorizations
Paste your Pharen API key without the Bearer prefix.
Query Parameters
Optional collection UUID to filter documents.
Team UUID for team-scoped keys.
Page number for paginated results.
Required range:
x >= 1Number of results per page.
Required range:
1 <= x <= 100