Get Sharing Settings

GET

/shares/entity/{entityType}/{entityId}

const url = 'https://app.metakip.com/api/v1/shares/entity/page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.metakip.com/api/v1/shares/entity/page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Returns sharing settings for an accessible page or folder. Only owners and administrators receive management details; other viewers receive a privacy-limited summary.

Authorizations

bearerToken
browserSession

Parameters

Path Parameters

entityType

required

string

Allowed values: page folder

The kind of Metakip entity to share.

entityId

required

string format: uuid

The UUID of the entity.

Responses

200

Sharing settings and effective access for the entity.

application/json

One of:

object
object

object

collaborators

required

Array<object>

object

userId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

Any of:

string
null

string

avatarUrl

required

Any of:

string
null

string

permission

required

string

Allowed values: view commenter edit admin

isOwner

required

boolean

entity

required

object

type

required

string

Allowed values: page folder

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

title

required

string

ownerId

required

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

publicAccess

required

object

permission

required

string

Allowed values: private view edit

url

required

string format: uri

grants

required

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

entityType

required

string

Allowed values: page folder

entityId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

permission

required

string

Allowed values: view commenter edit admin

recipientUserId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

recipientEmail

required

Any of:

string
null

string

recipientName

required

Any of:

string
null

string

recipientAvatarUrl

required

Any of:

string
null

string

sharedByName

required

Any of:

string
null

string

sharedByEmail

required

Any of:

string
null

string

createdAt

required

Any of:

string
null

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

updatedAt

required

Any of:

string
null

string format: date-time

pendingInvitations

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

targetType

required

string

Allowed values: page folder

targetId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

email

required

string format: email

/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

permission

required

string

Allowed values: view commenter edit admin

canManage

required

boolean

deliveryStatus

required

string

Allowed values: pending sent failed

expiresAt

required

string format: date-time

createdAt

required

string format: date-time

accessors

required

Array<object>

object

grantId

required

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

userId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

Any of:

string
null

string

email

required

Any of:

string
null

string

avatarUrl

required

Any of:

string
null

string

permission

required

string

Allowed values: view commenter edit admin

source

required

string

isOwner

required

boolean

accessSources

required

Array<object>

object

kind

required

string

Allowed values: owner direct folder workspace

grantId

required

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

userId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

Any of:

string
null

string

email

required

Any of:

string
null

string

avatarUrl

required

Any of:

string
null

string

permission

required

string

Allowed values: view commenter edit admin

effectivePermission

required

string

Allowed values: view commenter edit admin

isWinning

required

boolean

isOwner

required

boolean

isManageable

required

boolean

folderId

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

folderName

Any of:

string
null

string

inheritedPublicAccess

required

Array<object>

object

entityId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

entityTitle

required

string

permission

required

string

Allowed values: view edit

url

required

string format: uri

userPermission

required

Any of:

string
null

string

Allowed values: view commenter edit admin

capabilities

required

object

canEdit

required

boolean

canDelete

required

boolean

canCopy

required

boolean

canComment

required

boolean

permissionDetails

required

Array<object>

object

source

required

string

Allowed values: owner grant folder workspace public

permission

required

string

Allowed values: view commenter edit admin

folderId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

folderName

string

inheritedAccessors

required

Array<object>

object

userId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

Any of:

string
null

string

email

required

Any of:

string
null

string

permission

required

string

Allowed values: view commenter edit admin

source

required

string

Allowed values: folder workspace

folderId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

folderName

string

visibility

required

string

Allowed value: full

inheritance

required

object

policy

required

string

Allowed values: inherit restricted

Example

{
  "collaborators": [
    {
      "permission": "view"
    }
  ],
  "entity": {
    "type": "page"
  },
  "publicAccess": {
    "permission": "private"
  },
  "grants": [
    {
      "entityType": "page",
      "permission": "view"
    }
  ],
  "pendingInvitations": [
    {
      "targetType": "page",
      "permission": "view",
      "deliveryStatus": "pending"
    }
  ],
  "accessors": [
    {
      "permission": "view"
    }
  ],
  "accessSources": [
    {
      "kind": "owner",
      "permission": "view",
      "effectivePermission": "view"
    }
  ],
  "inheritedPublicAccess": [
    {
      "permission": "view"
    }
  ],
  "userPermission": "view",
  "permissionDetails": [
    {
      "source": "owner",
      "permission": "view"
    }
  ],
  "inheritedAccessors": [
    {
      "permission": "view",
      "source": "folder"
    }
  ],
  "visibility": "full",
  "inheritance": {
    "policy": "inherit"
  }
}

403

The API token is missing a required scope: pages:read.

application/json

Structured error returned when the request cannot be completed.

object

error

required

Error details for programmatic handling.

object

code

required

Stable error code.

string

message

required

Human-readable explanation.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

Get Sharing Settings

Authorizations

Parameters

Path Parameters

Responses

200

Example

403

Examplegenerated

Example^generated