Skip to main content
This resource represents a channel where Files can be shared across Clients and Companies. Items associated with a channel are only accessible to the members of that channel. The members of the channel are users in a workspace including both clients and internal users. Based on the membershipType of a file channel, the client members are either pre-determined or fluid. An individual file channel has a single client; a company file channel has all clients associated with the corresponding company. On the other hand, a group file channel has a fluid list of clients within a company (it could potentially have one, several, or even all clients within the company). The members of a group file channel can be added or removed via the UI. The clientId and companyId properties allow you to easily identify the source entity for that file channel (without having to e.g. search through the memberIds). Only individual channels will have a clientId. The companyId for individual channels indicates which company of the client this channel belongs to.

​
Properties

id string The unique identifier for this item. Note: Not all id properties will be in UUID format. createdAt string The date this item was created in RFC3339 format. updatedAt string The date this item was updated in RFC3339 format. object string The object type of this resource. clientId string The client this file channel belongs to. This is only set for channels when membershipType is individual. companyId string Which company this file channel belongs to. membershipType string The type of membership that this channel is associated with. Can be one of individual, group or company. membershipEntityId string Deprecated. Use clientId and companyId instead. memberIds array of strings The user IDs associated with this particular channel. These will always be UUIDs of the members of the channel, including clients and internal users.
Example File Channel Object