GET/spaces/api/v1/spaces/{spaceID}/pages/{pageID}/shares.json

get sharing information for a page, this will show if the share is

enabled or not and also the list of scopes relevant to the page

Path Params

  • Name
    spaceID
    Type
    integer
    required
    Description
  • Name
    pageID
    Type
    integer
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
  • Code
    404
    Type
    object
    Schema
    Description
    404 Not Found
  • Code
    500
    Type
    object
    Schema
    Description
    500 Internal Server Error

Examples

200 OK

PublicShare
{
  "sharing": {
    "createdAt": "2024-04-18T11:10:28.760Z",
    "createdBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "deletedAt": "2024-04-18T11:10:28.760Z",
    "deletedBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "id": 0,
    "page": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "scopes": [
      {
        "createdAt": "2024-04-18T11:10:28.760Z",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deletedAt": "2024-04-18T11:10:28.760Z",
        "deletedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "id": 0,
        "name": "string",
        "role": "read",
        "scopeType": "anyone",
        "sharingURL": "string",
        "state": "enabled",
        "token": "string",
        "updatedAt": "2024-04-18T11:10:28.760Z",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        }
      }
    ],
    "state": "enabled",
    "updatedAt": "2024-04-18T11:10:28.760Z",
    "updatedBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    }
  }
}