Skip to content

Get agreement settings

Request

Returns the envelope agreement configuration for the specified organization.

Security
Bearer or PersonalAccessToken
Path
organizationIdstring, (uuid)required

Unique identifier of the organization

GET
/api/v1/organizations/{organizationId}/settings/envelope/agreement
curl -i -X GET \
  '/api/v1/organizations/{organizationId}/settings/envelope/agreement' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
enabledbooleanrequired

Whether the standard agreement text applies to all envelopes sent by the organization.

overridablebooleanrequired

Whether senders are allowed to override the standard agreement text at envelope or template level.

agreementsArray of objects(Agreement)required

The configured agreement texts, one per organization-enabled language.

Response
{ "enabled": true, "overridable": false, "agreements": [ { … }, { … } ] }