Get documents

GET

https://api.cloudraker.com/v1/signing/documents

GET

/v1/signing/documents

curl https://api.cloudraker.com/v1/signing/documents \
     -H "Authorization: Bearer <token>"

{
  "items": [
    {
      "id": "string",
      "title": "string",
      "teamId": "string",
      "ownerId": "string",
      "privacy": "team",
      "status": "draft",
      "message": "string",
      "placement": "page",
      "stages": [
        {
          "id": "string",
          "mode": "all",
          "recipients": [
            {
              "id": "string",
              "name": "string",
              "email": "string",
              "status": "pending",
              "delegationId": "string",
              "signedAt": "string",
              "typedName": "string",
              "viewedAt": "string",
              "approvedAt": "string",
              "declinedAt": "string",
              "declineReason": "string",
              "nextReminderAt": "string",
              "lastInvitedAt": "string",
              "deliveryError": "string",
              "version": 1
            }
          ],
          "role": "signer",
          "delayHours": 1.1,
          "condition": {},
          "skipped": true
        }
      ],
      "fields": [
        {
          "id": "string",
          "kind": "signature",
          "slot": 1,
          "page": 1,
          "x": 0.5,
          "y": 0.5,
          "width": 0.5,
          "height": 0.5,
          "label": "string",
          "required": true,
          "options": [
            "string"
          ],
          "maxLength": 1,
          "defaultValue": "string",
          "attachmentId": "string",
          "localPage": 1
        }
      ],
      "createdAt": "string",
      "updatedAt": "string",
      "version": 1,
      "activity": [
        {
          "id": "string",
          "at": "string",
          "text": "string"
        }
      ],
      "source": "app",
      "integrationId": "string",
      "integrationName": "string",
      "signingMode": "manual",
      "delegation": {
        "templateId": "string",
        "templateVersion": 1
      },
      "templateOrigin": {
        "templateId": "string",
        "templateVersion": 1,
        "templateName": "string"
      },
      "attachments": [
        {
          "id": "string",
          "fileId": "string",
          "name": "string",
          "mimeType": "string",
          "pageCount": 1,
          "startPage": 1,
          "sha256": "string",
          "renditionSha256": "string"
        }
      ],
      "pageCount": 1,
      "pages": [
        {
          "width": 1.1,
          "height": 1.1
        }
      ],
      "preparationReviewed": true,
      "contentNeedsRender": true,
      "cc": [
        {
          "name": "string",
          "email": "string"
        }
      ],
      "language": "en",
      "expiresInDays": 1.1,
      "expiresAt": "string",
      "reminders": {
        "enabled": true,
        "firstAfterDays": 1.1,
        "repeatEveryDays": 1.1,
        "expiresBeforeDays": 1
      },
      "allowReassignment": true,
      "branding": {
        "name": "string",
        "accentColor": "string",
        "logoDataUrl": "string"
      },
      "variables": {},
      "brandingId": "string",
      "purpose": "string",
      "generation": {},
      "extraction": {},
      "postSign": {},
      "fileName": "string",
      "fileId": "string",
      "generatedText": "string",
      "runId": "string",
      "error": "string",
      "sending": true,
      "errorCode": "concurrent_envelope_limit",
      "limit": 1,
      "sentAt": "string",
      "completedAt": "string"
    }
  ],
  "nextCursor": "string"
}

Uses the same resource permissions and lifecycle as the RakeSign application. Integration access is limited to its shared team. Required scopes: documents:read.

Authentication

AuthorizationBearer

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

Query parameters

pageSizeintegerOptional1-50Defaults to 50

Documents per page.

cursorstringOptional

Cursor from the previous page.

statusstringOptional

Filter documents.

teamIdstringOptional

Filter documents.

searchstringOptional

Filter documents.

Response

Authorized signing resource.

itemslist of objects

nextCursorstring or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

503

Service Unavailable Error