Skip to content

Contracts

List of valid attributes:

AttributeDescriptionSpecifics
discarded_atNull or timestamp of removalCannot be set
nameName of the contractCan only be updated
statusStatus of the contractCannot be set, is always one of: creating reviewing signing completed
wordingContent of the contractCan only be updated

Meta data: Permissions

GroupDescription
actionsContains permissions to edit or delete a contract
signing_processReturns permissions if current user can create or delete a signing process

Show

Example response:

{
"data": {
"id": "11ed62a0-d0fb-4603-a1aa-60a8e2a4a12a",
"type": "contract",
"attributes": {
...
}
}
}

This endpoint returns a single contract.

HTTP Request

GET /api/v1/contracts/:contract_id

URL Parameters

ParameterDescription
contract_idID of the contract to return