Skip to navigation

List all recipient attachments

Retrieve a paginated list of all recipient tax form attachments across all recipients in the organization. Use cursor parameters (start_after, end_before) for pagination.

Authentication

AuthorizationBearer

Bearer token authentication for Mercury API.

Use your API token in the Authorization header: Authorization: Bearer TOKEN

Example: Authorization: Bearer secret-token:mercury_production_wma_24SCp4G81X3yHL4Wq8FgzuaP9ye3VKf2mgTDctXyRg5HY_yrucrem

Your Mercury API token should include the ‘secret-token:’ prefix. Tokens can be generated from your Mercury dashboard settings.

Query parameters

limitlongOptional1-1000Defaults to 1000
start_afterstringOptionalformat: "uuid"
end_beforestringOptionalformat: "uuid"
orderenumOptionalDefaults to asc
Sort order. Can be 'asc' or 'desc'. Defaults to 'asc'
Allowed values:

Response

attachmentslist of objects
List of attachments with recipient IDs
pageobject
Pagination information
totalinteger0-1000

Errors

400
Bad Request Error