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

# \<groupfolder\>

## Summary

This element represents a group folder in PageSeeder.

## Usage context

| Permitted content | `<sharing>` |
| --- | --- |
| Permitted parent | `<groupfolder-creation>`, `<groupfolder-modification>`, `<groupfolders>` |

## Attributes

This element includes the following attributes:

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| id | `xs:long` | yes | Unique ID in PageSeeder |
| scheme | `xs:string` | yes | Group folder scheme |
| host | `xs:string` | yes | Group folder host |
| port | `xs:positiveInteger` | yes | Group folder port |
| path | `xs:string` | yes | Group folder path |
| external | `xs:boolean` | yes | If `true`, this is an external group folder |
| public | `xs:boolean` | no | If this group folder is public |
| sharing | `xs:string` | no | If this group folder is shared (not for external group folders, possible values are `shared` and `private`) |

## Examples

```lang-xml

<groupfolder id="123"
             scheme="http"
             host="ps.example.org"
             port="8080"
             path="/ps/project/group/*"
             external="false" public="false"
             sharing="shared">
  <sharing>
    <share editable="false"
           addcomments="true"
           shareedits="false"
           sharexrefs="true">
      <group id="322"
             name="project-group"
             description="First group"
             owner="project"
             access="member"
             common="false"/>
    </share>
    <share editable="false"
           addcomments="true"
           shareedits="false"
           sharexrefs="true">
      <group id="452"
             name="dev-group"
             description="Dev group"
             owner="dev"
             access="member"
             common="false"
             relatedurl="http://dev.example.org"/>
    </share>
  </sharing>
</groupfolder>
<groupfolder id="855"
             scheme="https"
             host="ps.example.org"
             port="443" path="/ps/project/group2/*"
             external="false"
             public="false"
             sharing="private" />
```

## Schema

```lang-xml

<xs:element name="groupfolder" type="groupfolder"/>

<xs:complexType name="groupfolder">
  <xs:attribute name="id"       type="id"        use="required"/>
  <xs:attribute name="scheme"   type="xs:string" use="required"/>
  <xs:attribute name="host"     type="hostname"  use="required"/>
  <xs:attribute name="port"     type="port"      use="required"/>
  <xs:attribute name="path"     type="xs:string" use="required"/>
  <xs:attribute name="external" type="boolean"   use="required"/>
  <xs:attribute name="public"   type="boolean"/>
  <xs:attribute name="sharing"  type="sharing"/>
</xs:complexType>

<xs:simpleType name="hostname">
  <xs:restriction base="xs:string">
    <xs:maxLength value="100"/>
    <xs:pattern
value="([a-z0-9]([a-z0-9-]*[a-z0-9])?\.?)+[a-z0-9]([a-z0-9-]*[a-z0-9])?"/>
  </xs:restriction>
</xs:simpleType>

<xs:simpleType name="port">
  <xs:restriction base="xs:int">
    <xs:minInclusive value="0"/>
    <xs:maxInclusive value="65536"/>
  </xs:restriction>
</xs:simpleType>

<xs:simpleType name="sharing">
  <xs:restriction base="xs:string"> 
    <xs:enumeration value="shared" />
    <xs:enumeration value="private" />
  </xs:restriction>
</xs:simpleType>
```

## Compatibility

No change since initial API release.