Skip to content

Mercury: List all recipient attachments

Mercury recipients.listRecipientsAttachments: arguments, response, policy and SDK examples.

← Recipients operations · Get started

Operation mercury.listrecipientsattachments

Provider route: GET /recipients/attachments. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["recipients"]["listRecipientsAttachments"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.recipients.listRecipientsAttachments(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_mercury import MercuryIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.recipients.list_recipients_attachments(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
query.start_afterstringOptionalThe ID of the recipient attachment to start the page after (exclusive). When provided, results will begin with the recipient attachment immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.
Format: uuid
query.end_beforestringOptionalThe ID of the recipient attachment to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.
Format: uuid
query.orderstringOptionalSort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’
Default: asc
One of: asc, desc

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List all recipient attachments — response body

Referenced models: List all recipient attachments — response body

List all recipient attachments — response body
FieldTypePresenceDescription and constraints
$objectRoot
attachmentsarrayRequired within parentList of attachments with recipient IDs
attachments[]ModelEach itemExpand List all recipient attachments — response body — attachments item
pageobjectRequired within parentPagination information
page.nextPagestringOptionalID for the recipient tax form attachment
Format: uuid
page.previousPagestringOptionalID for the recipient tax form attachment
Format: uuid
totalJSONRequired within parent
total (allOf 1)ModelAll variants applyExpand Get all recipients — response body — total value
total (allOf 2)JSONAll variants applyTotal number of attachments in the current page

Referenced models: Get all recipients — response body — total value, List all recipient attachments — response body — attachments item

Get all recipients — response body — total value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)integerAlternativeFormat: int32
Maximum: 1000
Minimum: 0
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
List all recipient attachments — response body — attachments item
FieldTypePresenceDescription and constraints
$objectRoot
fileNamestringRequired within parentName of the uploaded file
formTypeJSONOptional
formType (anyOf 1)JSONAlternative
formType (anyOf 1) (allOf 1)stringAll variants applyKnown values: w9, w8BEN, w8BENE, unknown
formType (anyOf 1) (allOf 2)JSONAll variants applyThe tax form type (W-9, W-8BEN, W-8BEN-E, or Unknown)
formType (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the recipient tax form attachment
Format: uuid
id (allOf 2)JSONAll variants applyThe unique identifier for this attachment
recipientIdJSONRequired within parent
recipientId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
recipientId (allOf 2)JSONAll variants applyThe external ID of the recipient this attachment belongs to
uploadedAtJSONRequired within parent
uploadedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
uploadedAt (allOf 2)JSONAll variants applyTimestamp when the attachment was uploaded
urlstringRequired within parentPresigned URL to download the attachment (valid for 12 hours)

SDK function policy ID: mercury.listrecipientsattachments. Catalog operation: mercury:listRecipientsAttachments. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.