Skip to main content
GET
{baseUrl}
/
api
/
kb
/
documents
/
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123
}
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

​
team_id
string
Team UUID for team-scoped keys.
​
collection_id
string
Optional collection UUID to limit results to one collection.
​
search
string
Search term for document names and visible metadata.
​
page
integer
Page number for paginated responses.

​
Response

​
count
integer
Total number of matching documents.
​
results
array
Document records visible to the key.

Authorizations

​
Authorization
string
header
default:phk_your_api_key
required

Paste your Pharen API key without the Bearer prefix.

Query Parameters

​
collection_id
string<uuid>

Optional collection UUID to filter documents.

​
team_id
string<uuid>

Team UUID for team-scoped keys.

​
page
integer
default:1

Page number for paginated results.

Required range: x >= 1
​
per_page
integer
default:20

Number of results per page.

Required range: 1 <= x <= 100

Response

Documents returned.

​
data
object[]
​
total
integer
​
page
integer
​
per_page
integer