Zum Hauptinhalt springen
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
}
Gibt Pharen Docs Dokumente zuruck, die die erstellende Person des Keys sehen darf.
Erforderlicher API-Key-Scope: docs:read.

​
Query-Parameter

​
team_id
string
Team-UUID fur teambegrenzte Keys.
​
collection_id
string
Optionale Collection-UUID, um Ergebnisse auf eine Collection zu begrenzen.
​
search
string
Suchbegriff fur Dokumentnamen und sichtbare Metadaten.
​
page
integer
Seitennummer.

​
Antwort

​
count
integer
Gesamtzahl der passenden Dokumente.
​
results
array
Dokumente, die fur den Key sichtbar sind.

Autorisierungen

​
Authorization
string
header
Standard:phk_your_api_key
erforderlich

Paste your Pharen API key without the Bearer prefix.

Abfrageparameter

​
collection_id
string<uuid>

Optional collection UUID to filter documents.

​
team_id
string<uuid>

Team UUID for team-scoped keys.

​
page
integer
Standard:1

Page number for paginated results.

Erforderlicher Bereich: x >= 1
​
per_page
integer
Standard:20

Number of results per page.

Erforderlicher Bereich: 1 <= x <= 100

Antwort

Documents returned.

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