Get Agreements Agreement File
Header Parameters
Optional correlation ID.
Query Parameters
Optional. The specific agreement_file_id to download. When omitted, the most recently uploaded active file is returned.
Path Parameters
The agreement whose file content should be retrieved.
Response
File content returned as base64-encoded JSON.
Response Attributes
Base64-encoded file contents.
MIME type of the file (e.g. application/pdf).
File size in bytes.
Bearer token is missing or invalid.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Caller token does not resolve to a known customer shard.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Agreement not found, or the specified file does not exist or is not active.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Upstream document service returned an error or unexpected response.
Unexpected error
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.