Receipts

Receipt management endpoints

List receipts

get

https://api.visobird.comhttp://localhost:3000

/api/v1/receipts

Get a paginated list of processed receipts

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header:

Authorization: Bearer vb_your_api_key_here

Query parameters

limitinteger · min: 1 · max: 100Optional

Number of receipts to return (max 100)

Default: 10

offsetintegerOptional

Number of receipts to skip

Default: 0

statusstring · enumOptional

Filter by status

Possible values:

startDatestring · date-timeOptional

Start date filter (ISO 8601 format)

endDatestring · date-timeOptional

End date filter (ISO 8601 format)

Responses

200

List of receipts

application/json

401

Authentication required or invalid API key

application/json

429

Rate limit exceeded

application/json

get

/api/v1/receipts

HTTPcURLJavaScriptPython

GET /api/v1/receipts HTTP/1.1
Host: api.visobird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "receipts": [
    {
      "id": "text",
      "documentId": "text",
      "status": "PROCESSING",
      "type": "receipt",
      "createdAt": "2025-12-15T18:42:45.300Z",
      "processingTime": 1,
      "imageUrl": "https://example.com",
      "extractedData": {
        "merchant": "text",
        "address": "text",
        "date": "2025-12-15",
        "time": "text",
        "total": 1,
        "tax": 1,
        "subtotal": 1,
        "currency": "text",
        "confidence": 1,
        "processingTime": 1,
        "items": [
          {
            "name": "text",
            "quantity": 1,
            "unitPrice": 1,
            "totalPrice": 1,
            "category": "text"
          }
        ],
        "receiptId": "text",
        "paymentMethod": "text",
        "handwritingDetected": true,
        "tampered": true,
        "tamperingConfidence": 1,
        "phoneNumber": "text",
        "rawText": "text"
      }
    }
  ],
  "total": 1,
  "hasMore": true
}

Export receipts

get

https://api.visobird.comhttp://localhost:3000

/api/v1/receipts/export

Export receipts data to CSV or JSON format

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header:

Authorization: Bearer vb_your_api_key_here

Query parameters

formatstring · enumOptional

Export format

Default: csvPossible values:

startDatestring · date-timeOptional

Start date filter (ISO 8601 format)

endDatestring · date-timeOptional

End date filter (ISO 8601 format)

Responses

200

Exported data

text/csvapplication/json

Responsestring

401

Authentication required or invalid API key

application/json

404

No receipts found

application/json

get

/api/v1/receipts/export

HTTPcURLJavaScriptPython

GET /api/v1/receipts/export HTTP/1.1
Host: api.visobird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text