List Analytics Page Shares

See who can open a page and who can edit it. A share with viaFolderId comes from a folder the page is in; change it on the folder.

GET

Path

Path parameters

stringrequired

The page id, from List Analytics Pages.

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Query

FiltersNarrow list results with a provider-supported where expression. Learn more

string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Response fields

idstring

The share's id.

targetTypestring

Who it is for.

userOne member of the organization.
organizationEveryone in the organization.
roleEvery member whose role is this one, now and later.
teamEvery member of this team, now and later.
guestA person outside the organization, by email. View only, pages only. They get an email with a link that works for 30 days and asks for a code sent to that address.

permissionstring

What they can do.

viewCan open it.
editCan open and edit it, as their role allows.

userIdstring

For user: the member, from List Members. Null otherwise.

namestring

For user: the member's name. Null otherwise.

emailstring

For user: the member's email. For guest: the guest's address. Null otherwise.

roleIdstring

For role: the role, from List Roles. Null otherwise.

roleNamestring

For role: the role's name. Null otherwise.

teamIdstring

For team: the team, from List Teams. Null otherwise.

teamNamestring

For team: the team's name. Null otherwise.

viaFolderIdstring

On a page: the folder this share comes from (from List Analytics Folders), when the page inherits it. Change it on that folder. Null for a share on the page itself.

viaFolderNamestring

The name of the folder it comes from. Null when it is the page's own.

createdOndate

When it was shared.

updatedOndate

When it last changed.