List contracts for current user

GET /api/v1/documents/contracts

List contracts for current user

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/documents/contracts \
  --header 'Authorization: Bearer <token>'

200

{
  "contracts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contractorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "client": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>",
        "displayName": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "entityName": "<string>",
        "avatarUrl": "<string>",
        "isBusiness": false,
        "address": {}
      },
      "contractor": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>",
        "displayName": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "entityName": "<string>",
        "avatarUrl": "<string>",
        "isBusiness": false,
        "address": {}
      },
      "label": "<string>",
      "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "documentName": "<string>",
      "documentFileName": "<string>",
      "documentDownloadLink": "<string>",
      "amount": "<string>",
      "period": "<string>",
      "activationAt": "2023-11-07T05:31:56Z",
      "expirationAt": "2023-11-07T05:31:56Z",
      "signatureRequestId": "<string>",
      "signed": {},
      "clientAcceptance": {},
      "contractorAcceptance": {},
      "creatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fields": {},
      "priorityMethods": [],
      "paymentMethods": [
        {}
      ],
      "lastInvoice": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": "<string>",
        "status": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "contractorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contractorEmail": "<string>",
        "clientEmail": "<string>",
        "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "onchainTransactionId": "<string>",
        "invoiceDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "discount": "<string>",
        "comment": "<string>",
        "emailMessage": "<string>",
        "invoiceNumber": "<string>",
        "issuedDate": "2023-12-25",
        "dueDate": "2023-12-25",
        "paidAt": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Response

200

application/json

Successful Response

List of contracts.

contracts · ContractResponse · object[] · required

Show child attributes