Skip to main content

PaginatedResponse[LeadDocumentRead]

items object[]required
  • Array [
    • idIdrequired

    Unique numeric identifier of the record.

    lead_idLead Idrequired

    ID of the lead this record relates to.

    nameNamerequired

    Human-readable document name.

    typeTyperequired

    Document type label; matched against a document prompt's document_type.

    document objectrequired

    The document content.

    text_dataText Datarequired

    The document's text content.

    document_url object

    Optional URL to the original document.

    anyOf
    string
    created_atdate-timerequired

    Creation time (UTC, ISO 8601).

  • ]
    • pagePagerequired
    limitLimitrequired
    totalTotalrequired
    pagesPagesrequired
    PaginatedResponse[LeadDocumentRead]
    {
      "items": [
        {
          "id": 0,
          "lead_id": 0,
          "name": "string",
          "type": "string",
          "document": {
            "text_data": "string"
          },
          "document_url": "string",
          "created_at": "2024-07-29T15:51:28.071Z"
        }
      ],
      "page": 0,
      "limit": 0,
      "total": 0,
      "pages": 0
    }