Summarise the signatures in a folder

GET/folders/{folder_id}/signatures/summary

signatures:read get_folder_signatures_summaryRead-only

Counts the live signatures on the live signature requests made on a folder, on anything inside it, or on a document in it: in total, per status and per signatory. Only requests whose document the caller can read count, and an investor or advisor counts only their own signatures. This replaces the earlier count of requests per a status that was never recorded. 404 when the folder is unknown or the caller cannot read it. Changes nothing.

Path parameters

folder_idstring (uuid)Required#
The folder's id.

Responses

200

The signature counts.

SignatureSummaryEnvelope

{
  "data": {
    "total": 6,
    "by_status": {
      "not_initialised": 1,
      "pending": 2,
      "signed": 2,
      "verified": 1
    },
    "by_signatory": [
      {
        "signatory": {
          "id": "3f1c9d22-1a2b-4c3d-8e4f-5a6b7c8d9e0f",
          "type": "user"
        },
        "total": 3,
        "by_status": {
          "pending": 1,
          "signed": 1,
          "verified": 1
        }
      },
      {
        "signatory": {
          "id": "7d9f2a10-3b4c-4d5e-9f60-1a2b3c4d5e6f",
          "type": "group"
        },
        "total": 3,
        "by_status": {
          "not_initialised": 1,
          "pending": 1,
          "signed": 1
        }
      }
    ]
  }
}

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error

403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error

404

Resource not found (error.code = not_found).

Error

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/folders/{folder_id}/signatures/summary\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"