Skip to main content
GET
Get File Text Content
Streams a text-like file’s decoded content through the API as a preview, without requiring a separate fetch of the presigned S3 URL. Only text-ish content types are accepted: text/*, application/json, application/xml, or anything ending in +json/+xml. The read is ranged and capped — it never pulls more than 2 MB out of S3, and the returned text is truncated to 200,000 characters — so this is a preview, not a way to fetch the full file for binary or very large formats. There’s no stored “extracted text” field — this endpoint reads the object out of S3 live on every call. Nothing is cached back to the files row.

Auth

Requires a CRM read scope and an active organization on the token. Any of contacts:read, deals:read, companies:read, or activities:read qualifies, as does any *:manage scope — manage implies read.

Response

Errors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

file_id
string
required

UUID of the file whose text content to preview.

Response

Successful Response

The response is of type Response Get File Text Content Files File Id Text Content Get · object.