Contracts
List of valid attributes:
Attribute | Description | Specifics |
---|---|---|
discarded_at | Null or timestamp of removal | Cannot be set |
name | Name of the contract | Can only be updated |
status | Status of the contract | Cannot be set, is always one of: creating reviewing signing completed |
wording | Content of the contract | Can only be updated |
Meta data: Permissions
Group | Description |
---|---|
actions | Contains permissions to edit or delete a contract |
signing_process | Returns 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
Parameter | Description |
---|---|
contract_id | ID of the contract to return |