Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
file

Returns metadata about a file

get/v1/org/{orgId}/file/{fileId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

fileIdstring required

File id

Response

successful operation

idstring required

globally unique id of file

orgIdstring required

parent org id

entityIdstring required

entity id that the file is attached to

entityType'ACTION' | 'AGREEMENT' | 'AI_AGENT' | 'AI_AGENT_MEMORY' | 'AI_CHAT' | 'AI_CONFIG' | 'AI_CREDIT_LIMIT' | 'AI_CREDIT_USAGE' | 'AI_HINT' | 'AI_PROMPT' | 'APP' | 'APP_CONFIG' | 'APPROVAL_CHAIN' | 'APPROVAL_CHAIN_STAGE' | 'APPROVAL_DELEGATE' | 'APPROVAL_REQUEST' | 'ASSESSMENT' | 'BUDGET' | 'BUDGET_POOL' | 'BUNDLE' | 'CALENDAR' | 'CALENDAR_ENTRY' | 'CATEGORY' | 'CATEGORY_SORT' | 'CHANGE' | 'COMMENT' | 'COMP_BAND' | 'COMP_REVIEW' | 'CONTENT' | 'CUSTOMER' | 'DATA_VIEW' | 'EXCHANGE_RATE' | 'EMAIL_TEMPLATE' | 'EVENT' | 'FIELD' | 'FILE' | 'FORM' | 'FORM_DRAFT' | 'FORM_RESPONSE' | 'GEOCODE' | 'GROUP' | 'GROUP_ALLOCATION' | 'GROUP_TYPE' | 'GOAL' | 'GOAL_PROGRESS' | 'GOAL_TARGET' | 'GOAL_TYPE' | 'GUIDELINE' | 'JOB' | 'JOB_CODE' | 'JOB_LEVEL' | 'MEDIA' | 'MESSAGE' | 'MULTIPLIER' | 'ORG' | 'ORG_CONFIG' | 'PERSON' | 'PROFILE_TAB' | 'POLICY' | 'PROCESS' | 'PRODUCT' | 'QUERY_TOKEN' | 'QUESTION' | 'REPORT' | 'REPORT_CHART' | 'ROLE' | 'SCENARIO' | 'SIGNATURE' | 'SIGNATURE_REQUEST' | 'STOCK_GRANT' | 'STOCK_PRICE' | 'TABLE' | 'TABLE_ROW' | 'TASK_CONFIG' | 'TEMPLATE' | 'TASK' | 'TOKEN' | 'TIMEOFF' | 'TIMEOFF_BALANCE_ADJUSTMENT' | 'TIMEOFF_LEDGER_ENTRY' | 'TIMEOFF_POLICY' | 'TRANSCRIPT' | 'USER' required

entity type (should only be PERSON, USER, CONTENT, or ORG)

fieldIdstring

field that the file uses, if the file is tied to a field

hashstring

SHA-256 hash of the contents of the file

templateIdstring

for files that were generated from a template, the template that was used

formResponseIdstring

for files that were generated from a form response, the form response that was used

signatureStatus'PENDING' | 'SIGNED'

for files that contain a signature or signature request, information about the status of that signature. The presence of this does not automatically imply a SignatureRequest exists, because the file can be imported from another system

signerUserIdsstring[]

for files that were signed or attempted to sign in ChartHop, the list of users who signed or were requested to sign

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE'

level of sensitivity of the file, if the file is not tied to a field

filenamestring required

customer facing filename of file

originalFilenamestring required

original filename of file

typestring required

mime type of file

extstring required

extension of file

bytesinteger required

size of file in bytes

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

uploadPersonIdstring

uploaded by person id

uploadAtstring

timestamp that the file was uploaded

pageCountinteger

number of pages (PDF), slides (PPTX), or sheets (XLSX/XLS) in the file. Null for formats without a page concept or when not yet computed.

lineCountinteger

number of lines in the file, for line-oriented text formats (CSV, TXT, JSON, MD, HTML). Null for formats without a line concept or when not yet computed.

metadataobject

Optional metadata about the file

Example response

{
  "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"
}