v3

latestSwagger 2.02026-08-067506752.0 MB

signature-request

Return signature requests

get/v1/org/{orgId}/signature-request

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

requestUserIdstring

Filter by signature requests requested by an individual

signUserIdstring

Filter by signature requests requested for signature of an individual

fromCreateAtstring

Filter by signature requests requested from a particular timestamp

untilCreateAtstring

Filter by signature requests requested up until a particular timestamp

fromstring

Signature request id to start from, when paginating

limitinteger

Number of results to return

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "fileId": "588f7ee98f138b19220041a7",
      "fileVersionId": "588f7ee98f138b19220041a7",
      "fileTemplateId": "588f7ee98f138b19220041a7",
      "fileEntityId": "588f7ee98f138b19220041a7",
      "signers": [
        {
          "userId": "588f7ee98f138b19220041a7"
        }
      ],
      "requestUserId": "588f7ee98f138b19220041a7",
      "notifyUserIds": [
        "588f7ee98f138b19220041a7"
      ],
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}