Collections

List collection documents

get/api/v1/collections/{id}/documents

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/collections/{id}/documents
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Path parameters

idstring required

Query parameters

sandboxboolean

Dashboard mode. API keys always use their authenticated mode.

includeCollectionsboolean

Include collectionIds for the returned page.

searchstring

Matches the document's name, or the name or email of anyone signing it.

templateIdstring uuid

Only documents created from this template.

status'draft' | 'pending' | 'completing' | 'completed' | 'failed' | 'voided' | 'expired'
sortBy'createdAt' | 'name' | 'status'
sortOrder'asc' | 'desc'
pagenumber

Page number (1-based)

limitnumber

Number of items per page

Response

totalnumber required

Total number of documents

pagenumber required

Current page number

limitnumber required

Number of items per page

totalPagesnumber required

Total number of pages

Example response

{
  "data": [
    {
      "formFieldsDetected": 23
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.