File

Get list of files.

get/api/v1/file/list

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Query parameters

offsetinteger

Requested page offset.

sizeinteger

Requested page size.

sortOrder'Descending' | 'Ascending'

Order of comments by modified date time (default is descending).

offsetDatestring date-time

Include cards from/since (as per requested sort order) its offset date type.

offsetDateEndstring date-time

Include cards to/until (as per requested sort order) its offset date type.

offsetDateType'CreatedDate' | 'ModifiedDate' | 'SystemModifiedDate'

Offset date type.

offsetModifiedstring date-time

Include files from/sice (as per requested sort order) its modified date.

offsetIdstring

Id of last recieved file in the previous batch when using offsetModified

offsetHistoryIdstring

Next page of resources when offsetModified set

searchQuerystring

Plaintext search query to filter file list by. Please use prefix 'To:' or 'From:' in order to filter by recipient oy by sender.

groupFileboolean

file is in group

recipientIdsstring[]

List of recipient ids (either a user or a group) to filter file list by.

senderIdsstring[]

List of user ids as senders (From) to filter comment list by.

contactFilterRelation'Or' | 'And' | 'OrNot' | 'AndNot'

Query relation for contact filters (userIds, groupIds and senderIds). Default is 'or'.

exactShareContactIdsstring[]

List of contact ids (user or group) to filter result list by exact matching of comments's share list.

cardTypesCardType[]

List of card types to filter file list by.

includeSignedLinksboolean

Includes signed links for file/thumbnail

companyIdstring

Company id to filter file list by. Users of the company profiles are added as recipients.

Headers

Authorizationstring

Authorization header.

X-Impersonate-Userstring

Impersonation header.

Response

List of files.

sizeinteger required

Page size

offsetinteger required

Page offset

offsetHistoryIdstring

Offset history id

totalSizeinteger required

Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size

Changes

No recorded changes to this operation across all 1 revision of this API.