v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Files

This API endpoint retrieves the list of files in a file channel.

get/v1/files

Query parameters

channelIdstring required

Only return files within the file channel that matches this ID. You can retrieve a file channel ID by calling the List File Channels endpoint.

pathstring

Filters the results based on a folder path prefix. This is a recursive search, files location in subfolders will be returned if they match the path prefix.

nextTokenstring

limitinteger

Response

200

nextTokenstring

Example response

{
  "data": [
    {
      "channelId": "us-east-1_Gz7TRlAaM/7787061b-21d6-4742-b38d-319f3d18831b/none",
      "createdAt": "2024-02-29T22:34:39.549178548Z",
      "creatorId": "dc0f1749-7d01-48b7-bd80-fcbfce835642",
      "id": "9fb39008-6f3b-4f2e-9c8e-f4d5daf4c49a",
      "linkUrl": "https://www.google.com",
      "lastModifiedBy": {
        "id": "9640718b-e291-4c93-8366-989ae26f58c9",
        "object": "internalUser"
      },
      "name": "Example Link",
      "object": "link",
      "path": "Example Link"
    }
  ],
  "nextToken": "eyJwa2V5IjoiODc2NjdkY2ItNjcxNC00ZmNkLWJjNGUtNDI0ZGUxMzNiZjYyIiwic2tleSI6IkNMSUVOVF9DT01QQU5ZIiwiZGF0YSI6InVzLWVhc3QtMV9xbEFSQlE5bUYvZGVmYXVsdC9iMTRlZmJlOC03Y2U3LTRjNDEtYTdhNC0yMzczMTNmYzgxZDMifQ=="
}