WIwistia
Folder Sharings

Show Folder Sharing

Changed on

Retrieves the details of a specific sharing object for a given folder.

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 naming this folder (any permission) can also be used.

get/folders/{folderId}/sharings/{sharingId}

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/folders/{folderId}/sharings/{sharingId}
  • Auth
    HTTP bearer

Path parameters

folderIdstring required

Hashed ID of the folder (e.g., "4d23503f70")

Hashed ID for the folder for which you'd like to see sharings.

sharingIdinteger required

The ID of the specific sharing object that you want to see.

Headers

X-Wistia-API-Versionstring required

Response

Successfully retrieved sharing details

idinteger required
is_adminboolean required
can_shareboolean required
can_downloadboolean required
can_uploadboolean required
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,
  "is_admin": true,
  "can_share": true,
  "can_download": true,
  "can_upload": true,
  "share": {
    "id": 3,
    "name": "Jim",
    "type": "Contact",
    "email": "jim@wistia.com"
  },
  "folder": {
    "id": 13,
    "name": "My Folder"
  }
}

Changes