v3

latestSwagger 2.02026-08-067506752.0 MB
file

Query files with additional person field data

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

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

personFieldsstring

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

formatstring

Data format to use; default is json, can also use json-extended or json-readable

splitColumnsboolean

Whether to split complex columns, used for tabular data formats

limitinteger

Number of results to return

fromstring

From result id

Response

files found

dataobject[] required
nextstring
totalRowobject

Example response

{
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}