v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List File Channels

This API endpoint retrieves a list of file channels.<br><br>You can use the query params to filter a subset of the file channels that match the specified field values.

get/v1/channels/files

Query parameters

membershipTypestring

Only return channels that have a membership type matching this value. Can be individual, group or company

membershipEntityIdstring

Deprecated: filter using clientId or companyId

memberIdstring

Only return channels that contain the member (client or internal user) matching this ID.

nextTokenstring

limitinteger

clientIdstring

Only return individual channels for this client.

companyIdstring

Only return channels that are part of this company

Response

200

nextTokenstring

Example response

{
  "data": [
    {
      "id": "us-east-1_C9xIMWJtp/210ad1fb-837a-4b5a-9d15-58dc9cc07073",
      "object": "fileChannel",
      "createdAt": "2023-06-02T16:32:38Z",
      "updatedAt": "2023-06-02T16:32:38Z",
      "membershipType": "company",
      "clientId": "210ad1fb-837a-4b5a-9d15-58dc9cc07073",
      "companyId": "210ad1fb-837a-4b5a-9d15-58dc9cc07073",
      "membershipEntityId": "210ad1fb-837a-4b5a-9d15-58dc9cc07073",
      "memberIds": [
        "09d3f64b-512c-48d1-9f48-6ca8b7627925"
      ]
    }
  ],
  "nextToken": "eyJwa2V5IjoiMmUxOTBhYmUtZDZhZC00ZTcwLWE5ZDUtNzYwZTNlZDQ5OTg1Iiwic2tleSI6IkNMSUVOVF9VU0VSIiwiZGF0YSI6InVzLWVhc3QtMV9xbEFSQlE5bUYvMjViMmE2ZTctNzExYy00ZWE3LTgxYmEtNjViYzlkZGYxNWVjLzJlMTkwYWJlLWQ2YWQtNGU3MC1hOWQ1LTc2MGUzZWQ0OTk4NSJ9"
}