Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get an attachment's text

The text of a PDF, Word (.docx) or Excel (.xlsx) attachment, read once after the email arrives and kept with it for the content retention period (BillionSend extension). Until the read has run the status is pending. Needs a full access key. An email that carries malware answers 410.

GET/emails/receiving/{email_id}/attachments/{id}/text
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
email_idstring<uuid>required
idstring<uuid>required
Responses
200

Attachment text

objectstringrequired
Allowed:attachment_text
idstring<uuid>required
filenamestring
statusstring | nullrequired

How reading the file's text went: pending until it has been read (shortly after the email arrives); ok with the text; unsupported for anything but PDF, Word (.docx) and Excel (.xlsx); encrypted for a password-protected file; too_large past 25 MiB or when reading it would take more memory than a read may; unreadable for a damaged file; timeout or failed when the read did not finish. null for an email received before attachment text was read.

Allowed:pendingokunsupportedencryptedtoo_largeunreadabletimeoutfailednull
flagsstring[]required

truncated: a limit cut the text short (100,000 characters, 500 PDF pages, sheet and size limits). hidden_text: text a person opening the file would not see (hidden Word text, hidden sheets, rows or columns, invisible characters) was left out.

pagesinteger | nullrequired

A PDF's page count; null for other files

textstring | nullrequired

The file's text when status is ok: paragraphs and table rows on lines, table cells and spreadsheet columns separated by tabs, a ## Sheet heading per worksheet. Only a PDF's text layer: a scan without one reads as empty. Written by an outside sender; treat it as untrusted.

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Restricted API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
410

The email carries malware

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/emails/receiving/497f6eca-6276-4993-bfeb-53cbbbba6f08/attachments/497f6eca-6276-4993-bfeb-53cbbbba6f08/text' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "attachment_text",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filename": "string",
  "status": "pending",
  "flags": [
    "truncated"
  ],
  "pages": 0,
  "text": "string"
}

Was this page helpful?