Purchase Scan Emails

List purchase scanner emails

List the emails received in the purchase scanner mailbox with sender, subject, accepted and rejected attachments and ingestion result. Search by sender or subject and filter by ingestion result or date range; cursor-based pagination.

get/companies/{company}/purchase-scan-emails

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/purchase-scan-emails
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

limitinteger

Number of objects to return, between 1 and 100 (default 25).

starting_afterstring uuid nullable

Cursor for forward pagination: pass the id of the last object on the previous page (the next_cursor of the previous response).

searchstring

Free-text search (partial, case-insensitive match).

resultstring

Comma-separated list of email results. Allowed values: pending, processed, partially_processed, no_compatible_attachments, parked, rejected, failed.

Comma-separated list of email results: pending, processed, partially_processed, no_compatible_attachments, parked, rejected or failed.

created[gte]string date

Only emails received on or after this date (YYYY-MM-DD).

created[lte]string date

Only emails received on or before this date (YYYY-MM-DD).

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Successful scanner operation.

has_moreboolean required
next_cursorstring uuid nullable required

Changes

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