Get Agreements Agreement
Header Parameters
Optional correlation ID.
Query Parameters
Optional. When true, the response includes the owning custodian ID and scoped administrator ID.
Path Parameters
The agreement to retrieve.
Response
Agreement returned successfully.
Response Attributes
Primary key.
Display name.
Document type: 0 = Agreement, 1 = Guide.
true = active; false = retired.
Date from which the agreement is in effect.
Show child attributes
true if at least one active file is associated with this agreement.
Active files attached to this agreement, newest first.
Show child attributes
ID of the owning custodian. null unless include_admin_properties=true.
ID of the scoped administrator. null unless include_admin_properties=true.
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.
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.
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.