Documents

List documents

Lists the documents of the team. Give target_type and target_id to get the documents of one purchase order or one supplier.

get/api/v1/documents

Request

  • Base URL: https://app.sellerassistant.app (the document declares no server; this is the origin it was published from)
  • URL: https://app.sellerassistant.app/api/v1/documents
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-Api-Key

Query parameters

target_type'purchase_order' | 'supplier'

Keeps the documents of one kind of owner. Send target_id with it to keep the documents of one owner.

target_idinteger
Example:42

The id of the purchase order or of the supplier. It needs target_type.

filter[type][eq]'invoice' | 'confirmation' | 'credit_memo' | 'packing_slip' | 'contract' | 'authorization_letter' | 'credit_agreement' | 'other'

Keeps the documents of one type.

filter[status][eq]'uploaded' | 'classifying' | 'processing' | 'parsed' | 'empty' | 'failed'

Keeps the documents of one parser status.

searchstring

A term the list looks for. Each list names the columns it reads.

sortstring
Example:-created_at

The column to order by: created_at, updated_at, original_name, file_size, type, status. A minus sign in front of the name orders from the highest down. Without a sort the order is -created_at. Another name answers 400.

pageinteger
Example:1

The page to read. It starts at 1.

per_pageinteger
Example:25

The rows a page carries. The maximum is 200.

Response

One page of the documents

Example response

{
  "data": [
    {
      "id": 5,
      "type": "invoice",
      "status": "parsed",
      "original_name": "invoice-2026-09.pdf",
      "mime_type": "application/pdf",
      "file_size": 240128,
      "reference_number": "INV-4471",
      "targets": [
        {
          "id": 42
        }
      ],
      "ai_confidence": 0.94,
      "has_parsed_data": true
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total": 137,
      "last_page": 6
    },
    "trial_limit": {
      "max_rows": 25,
      "total": 137,
      "code": "trial_list_limited",
      "message": "The trial shows only the first rows of a list. Subscribe to see all rows.",
      "subscribe_url": "https://app.sellerassistant.app/subscription"
    }
  }
}

Changes

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