Get Agreements Agreements
Header Parameters
Optional correlation ID.
Query Parameters
Optional. Filter to agreements owned by this custodian.
Optional. Filter to agreements scoped to this administrator.
Optional. Filter by document type (0 = Agreement, 1 = Guide).
Optional. When true, return only active agreements; false returns retired ones.
Optional. When true, return only agreements that have at least one active file.
Optional. When true, each result includes the owning custodian ID and scoped administrator ID.
Response
Agreements returned successfully.
Response Attributes
Show child attributes
Show child attributes
One or more query parameters are 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.
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.
No agreements found for the supplied filter combination within the caller scope.
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.