v3

latestSwagger 2.02026-08-067506752.0 MB

file

Returns a list of files

get/v1/org/{orgId}/file

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

entityIdstring

Entity id

entityTypestring

Entity type

fieldsstring

Field name(s) to filter by, comma-separated

filterstring

Target entity filter

limitinteger

Number of results to return

fromstring

From result id

returnAccessstring

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

personFieldsstring

Person field name(s) to include in response, comma-separated

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "entityId": "588f7ee98f138b19220041a7",
      "fieldId": "offerLetter",
      "templateId": "588f7ee98f138b19220041a7",
      "formResponseId": "588f7ee98f138b19220041a7",
      "signerUserIds": [
        "588f7ee98f138b19220041a7"
      ],
      "sensitive": "PERSONAL",
      "filename": "Offer Letter - Bob Smith.pdf",
      "originalFilename": "BOB-SMITH.pdf",
      "type": "application/pdf",
      "ext": "pdf",
      "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",
      "deleteId": "588f7ee98f138b19220041a7",
      "deleteBehalfId": "588f7ee98f138b19220041a7",
      "deleteAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "deleteAt": "2017-01-24T13:57:52Z",
      "uploadPersonId": "588f7ee98f138b19220041a7"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}