file

Query files with additional person field data

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

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/file/data
  • Auth: none declared

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

Changes

No recorded changes to this operation across all 20 revisions of this API.