List documents for a project

GET

/api/v1/projects/{projectId}/documents

const url = 'https://api.yggy.tech/api/v1/projects/example/documents?status=pending&archived=true&limit=20&offset=0&sortBy=title&sortDir=asc&noteKind=capture';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.yggy.tech/api/v1/projects/example/documents?status=pending&archived=true&limit=20&offset=0&sortBy=title&sortDir=asc&noteKind=capture' \
  --header 'Authorization: Bearer <token>'

Retrieve a list of documents scoped to the project, with optional filtering and pagination.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

projectId

required

string

>= 1 characters

Query Parameters

projectId

Filter documents by project ID. When omitted, returns all of the organization’s documents.

string

Filter documents by project ID. When omitted, returns all of the organization’s documents.

status

string

Allowed values: pending processing completed failed stored

archived

Filter by archive state: false (default) excludes archived, true includes all, only shows archived only

string

default: false

Allowed values: true false only

Filter by archive state: false (default) excludes archived, true includes all, only shows archived only

limit

number

default: 20 >= 1 <= 500

offset

number | null

sortBy

string

default: createdAt

Allowed values: title createdAt updatedAt

sortDir

string

default: desc

Allowed values: asc desc

Case-insensitive substring search over title and source filename/path.

string

>= 1 characters <= 200 characters

Case-insensitive substring search over title and source filename/path.

folderId

Browse documents in this folder (externalId). Use the literal value root for unfiled documents only. Omit to list all documents (legacy).

string

>= 1 characters

Browse documents in this folder (externalId). Use the literal value root for unfiled documents only. Omit to list all documents (legacy).

noteKind

When set, only documents of this note kind (capture, daily, or note).

string

Allowed values: capture daily note

When set, only documents of this note kind (capture, daily, or note).

Header Parameters

host

string | null

x-yggy-organization-id

string | null

Responses

200

List of documents

application/json

object

documents

required

Array<object>

object

documentId

required

string

invocationId

string

title

required

string

content

string

source

string

sourceKind

string | null

Allowed values: UPLOAD GOOGLE_DRIVE MICROSOFT_DRIVE GMAIL OUTLOOK SLACK NOTION LINEAR CHAT SEED LINK SHARED FORWARDED

originSystem

string | null

ownerExternalId

string | null

ownerDisplayName

string | null

contentType

required

string

status

required

string

Allowed values: PENDING PROCESSING COMPLETED FAILED STORED

createdAt

required

string

updatedAt

required

string

tripleCount

number

error

string

code

string

failureMessage

string

storageUrl

string

deletedAt

string

noteKind

string | null

extractionMethod

string

Allowed values: UNSTRUCTURED STRUCTURED_SGSE MANUAL HYBRID

structuredRegions

string | null

provenanceChain

string | null

extractionStats

string | null

processingSummary

string | null

modelUsed

string | null

ocrStrategy

string | null

inferenceMode

string | null

extractionGuidanceRevision

integer | null

guidanceRecommendations

string | null

sourceCreatedAt

string | null

sourceModifiedAt

string | null

sourceAuthor

string | null

sourceMetadata

string | null

attachedTo

object

documentId

required

string

title

required

string

mailAttachments

Array<object>

object

documentId

required

string

title

required

string

status

required

string

Allowed values: PENDING PROCESSING COMPLETED FAILED STORED

projectExternalId

string | null

total

required

number

limit

required

number

offset

required

number

Example

{
  "documents": [
    {
      "sourceKind": "UPLOAD",
      "status": "PENDING",
      "extractionMethod": "UNSTRUCTURED",
      "mailAttachments": [
        {
          "status": "PENDING"
        }
      ]
    }
  ]
}