---
title: "Element <sharing>"
source: https://dev.pageseeder.com/api/elements/element_sharing.html
description: "API Element reference for <sharing>"
last_updated: 2026-08-07T17:09:54+10:00
tokens: ~771
---

# \<sharing\>

## Summary

This element is a container for the sharing information about a URI (document or URL). It contains one or more `<share>` elements, one for each group the URI is shared with.

For a more detailed discussion on share documents, *see* [document sharing](../../guide/documents/shared_documents.md).

> **Note:** URI sharing information is usually available when there is a context member: the groups listed are the ones the member has access to and the hidden attribute specifies the number of groups the URI is shared with that the user cannot see.

## Usage context

| Permitted content | `<share>` |
| --- | --- |
| Permitted parent | `<uri>`, `<groupfolder>` |

## Attributes

This element includes the following attributes:

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| status | `enum` | yes | Whether the URI is `shared` or `private` |
| hidden | `xs:positiveInteger` | no | The number of groups the URI is shared with but that are not visible to the current member |
| public | `xs:boolean` | no | Whether the URI is visible to public |

### `@status`

This attribute’s value shows whether the URI is “shared” to other groups or “private” to a single group. The value is one of the following:

- `shared`
- `private`

### `@hidden`

This attribute’s value is the number of groups that the URI is shared with but that the member cannot see.

### `@public`

Flag whether public has permission to view the URI, this optional attribute’s default value is `false`.

## Examples

```lang-xml

<sharing status="private">
  <share default="true"
         editable="true"
         addcomments="true">
    <group id="56"
           name="app-testing"
           description="App testing group"
           owner="app"
           access="member"
           common="false"/>
  </share>
</sharing>
<sharing status="shared"
         hidden="1"
         public="true">
  <share default="true"
         editable="true"
         addcomments="true">
    <group id="12"
           name="dev-group1"
           description="Dev group 1"
           owner="dev"
           access="member"
           common="false"/>
  </share>
  <share editable="false"
         addcomments="true">
    <group id="82"
           name="dev-group2"
           description="Dev group 2"
           owner="dev"
           access="member"
           common="false"
           relatedurl="http://dev.example.org/home.html"/>
  </share>
</sharing>
```

## Schema

### XML Schema

```lang-xml

<xs:element name="sharing">
  <xs:sequence>
    <xs:element name="share" type="share" maxOccurs="unbounded"/>
  </xs:sequence>
  <xs:attribute name="status" use="required">
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="private" />
        <xs:enumeration value="shared" />
      </xs:restriction>
    </xs:simpleType>
  </xs:attribute>
  <xs:attribute name="hidden"  type="xs:positiveInteger" />
  <xs:attribute name="public"  type="boolean"       fixed="true"/>
</xs:element>
```

## Compatibility

No change since initial API release.