Get a document's file

GET/v1/operations/documents.file

One Synced document's original file (the PDF or image of the bill or receipt as it arrived), base64, up to 10 MB. Synced's account-transactions view calls this to show the document; to read a document's supplier, totals and lines, use documents.get instead. The id is a document id from ledger.account_transactions or documents.get. An id that is not one of this organisation's documents, or a document with no file, is not found.

Scope: synced.read · reads only
Roles: Super admin, Admin (by default; an admin can change this per operation)
MCP tool: documents_file

Request

Send the token as Authorization: Bearer. A token approved for several organisations also sends Synced-Organisation: {id} (see Organisations).

Query parameters

Name	Type	Description
`id`required	string	Document idOne Synced document id.

Response

200 with a JSON body. 401 without a valid token, 403 when the scope, role or organisation does not allow it, 429 when rate limited (see Errors and limits).

Name	Type	Description
`id`	string
`contentType`	string	one of `application/pdf`, `image/png`, `image/jpeg`, `image/gif`, `image/webp`
`size`	integer	Bytes, before base64.
`data`	string

Example

curl -X GET 'https://api.syncedhq.com/v1/operations/documents.file' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Try it

Sign in to send this request as yourself. You choose the organisations on Synced's consent screen; the token stays in this tab and expires within an hour.

idrequiredstring

One Synced document id.

Required: id

Request

curl -X GET 'https://api.syncedhq.com/v1/operations/documents.file' \
  -H 'Accept: application/json'

Response

Sign in, then send the request.