WIwistia
Channel Collaborators

List Channel Collaborators

Changed on

Lists the collaborators (contacts and contact groups) that have been granted access to a channel.

Results are scoped to what the authenticated user is allowed to see: account owners and managers see all collaborators, channel admins see all collaborators on their channels, and everyone else sees only the roles that grant them access.

Requires api token with one of the following permissions

Read all data

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization granting the update permission on this channel can also be used; a token granted only show on the channel lists no collaborators.

get/channels/{channelHashedId}/collaborators

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/channels/{channelHashedId}/collaborators
  • Auth
    HTTP bearer

Path parameters

channelHashedIdstring required

Hashed ID of the channel (e.g., "abc123")

Channel Hashed ID

Query parameters

pageinteger

The page number to retrieve. This cannot be combined with cursor, pagination.

per_pageinteger

The number of medias per page. Use this for both offset pagination and cursor pagination.

enabled0 | 1

If cursor[enabled] is set to 1, the first result set will be fetched with cursor pagination enabled. This values is ignored if cursor[before] or cursor[after] are set.

beforestring

If cursor[before] is set then cursor pagination is enabled and all records before the cursor up to the per_page are returned. This feature is useful for fetching "new records", for example, in a "pull to refersh" feature when showing records in a descending order.

afterstring

If cursor[after] is set then cursor pagination is enabled and all records after the cursor up to the per_page are returned.

If cursor[enabled] is set to 1 then cursor pagination is enabled and the first set of records are fetched up to the per_page. Cursor pagination will also be turned on if cursor[before] or cursor[after] are set. Records returned will have a cursor property set which can be used to fetch more records in the same sort_by ordering. The cursor value of the last record can be used to fetch records after the current result set and the cursor of the first record can be used to fetch records before the result set.

NOTE: a cursor value is only valid if the sort_by value hasn't changed from the last fetch. For example, you cannot fetch using sort_by id and then pass that cursor value to a sort_by name.

sort_by'created' | 'updated' | 'id'

Ordering. When using cursor pagination (see cursor param), only id is supported.

sort_direction0 | 1

Ordering Sort Direction (0 = desc, 1 = asc; default is 1)

Headers

X-Wistia-API-Versionstring required

Response

Successfully retrieved list of channel collaborators

idinteger required

The unique identifier of the channel role.

role'admin' | 'viewer' required

The role of the collaborator on the channel.

created_atstring date-time required

The timestamp when this collaborator was added.

cursorstring nullable

A cursor for stable pagination based on current sort_by order. You can pass this to cursor[before] or cursor[after] as a parameter to fetch the records before or after this record in the same sort order. This is only populated if records were fetched with cursor[enabled], or cursor[before] or cursor[after].

Example response

[
  {
    "id": 14,
    "role": "admin",
    "created_at": "2024-01-15T10:30:00Z",
    "share": {
      "id": 3,
      "name": "Jim",
      "type": "Contact",
      "email": "jim@wistia.com"
    }
  }
]

Changes