---
metadata:
  - name: generator
    content: Diplodoc Platform v5.70.0
alternate:
  - https://yandex.ru/support/wiki/en/api-ref/pages/pages__append_content.md
  - https://yandex.ru/support/wiki/ru/api-ref/pages/pages__append_content.md
  - href: https://yandex.ru/support/wiki/en/api-ref/pages/pages__append_content.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/support/wiki/en/llms.txt?revision=r22094953
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/wiki/en/llms.txt?revision=r22094953

<div class="openapi">

# Append Content

<!-- markdownlint-disable-file -->

Adds text at the specified location on a page. Specify exactly one field: `body`, `section`,
or `anchor`.

If you provide `revision`, the service checks the page version. A mismatch causes an update
conflict.

If the anchor is not found and `anchor.fallback=true`, the text is added to the end of the page. Otherwise,
an error is returned because the anchor was not found.

For common headers and authentication methods, see [Access to the API](https://yandex.ru/support/wiki/en/api-ref/access.md#headers). For sample scenarios, see [API usage examples](https://yandex.ru/support/wiki/en/api-ref/examples.md).

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-post);margin-bottom: 12px">

<div class="openapi__request">

POST {.openapi__method}
```text translate=no
https://api.wiki.yandex.net/v1/pages/{idx}/append-content
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_idx_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Page ID. The value of `idx` is the same as the `id` field value in the response to `GET /v1/pages?slug=…` or `POST /v1/pages`.
{.table-cell}
||
|#{.json-schema-properties}

### Query parameters

#|
|| **Name** | **Description** ||
||

_fields_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Additional response fields, separated by commas, such as `content,attributes,last_revision_id`. If omitted, only the basic page fields are returned. The response format describes the available additional fields.

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
||

_is_silent_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Do not notify subscribers about the page update

_Default:_{.json-schema-reset .json-schema-value} `false`
{.table-cell}
||
|#{.json-schema-properties}

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "revision": "example",
  "content": "example",
  "body": {
    "location": "top"
  },
  "section": {
    "id": 0,
    "location": null
  },
  "anchor": {
    "name": "example",
    "fallback": false,
    "regex": false
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_content_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Text to add to the page

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_anchor_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageAppendContentAnchorSchema**

  **Type**: [PageAppendContentAnchorSchema](#entity-PageAppendContentAnchorSchema)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "name": "example",
    "fallback": false,
    "regex": false
  }
  ```

  {% endcut %}

{% endcut %}

Insert after an anchor. Specify exactly one field: `body`, `section`, or `anchor`.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "name": "example",
  "fallback": false,
  "regex": false
}
```

{% endcut %}
{.table-cell}
||
||

_body_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageAppendContentBodySchema**

  **Type**: [PageAppendContentBodySchema](#entity-PageAppendContentBodySchema)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "location": "top"
  }
  ```

  {% endcut %}

{% endcut %}

Insert at the beginning or end of the page. Specify exactly one of these fields: `body`, `section`, or `anchor`.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "location": "top"
}
```

{% endcut %}
{.table-cell}
||
||

_revision_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

The page version on which the change is based.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_section_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageAppendContentSectionSchema**

  **Type**: [PageAppendContentSectionSchema](#entity-PageAppendContentSectionSchema)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": 0,
    "location": "top"
  }
  ```

  {% endcut %}

{% endcut %}

Insert into a page section. Specify exactly one of these fields: `body`, `section`, or `anchor`.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "location": "top"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### Location {#entity-Location}

An enumeration.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `top`, `bottom`

</div>

<div class="openapi-entity">

### PageAppendContentBodySchema {#entity-PageAppendContentBodySchema}

#|
|| **Name** | **Description** ||
||

_location_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Location**

  **Type**: [Location](#entity-Location)

  An enumeration.

  _Enum:_{.json-schema-reset .json-schema-value} `top`, `bottom`

{% endcut %}

Insertion location: `top` for the beginning of the page, or `bottom` for the end

_Example:_{.json-schema-reset .json-schema-example} `top`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "location": "top"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PageAppendContentSectionSchema {#entity-PageAppendContentSectionSchema}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Page section ID
{.table-cell}
||
||

_location_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Location**

  **Type**: [Location](#entity-Location)

  An enumeration.

  _Enum:_{.json-schema-reset .json-schema-value} `top`, `bottom`

{% endcut %}

Insertion location: `top` is after the section heading, and `bottom` is at the end of the section

_Example:_{.json-schema-reset .json-schema-example} `top`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "location": "top"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PageAppendContentAnchorSchema {#entity-PageAppendContentAnchorSchema}

#|
|| **Name** | **Description** ||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

The name of the anchor after which to insert the text

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_fallback_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

If the anchor is not found, append the text to the end of the page instead of returning an error

_Default:_{.json-schema-reset .json-schema-value} `false`
{.table-cell}
||
||

_regex_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Find the anchor in the source text using a regular expression instead of parsing the markup

_Default:_{.json-schema-reset .json-schema-value} `false`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "name": "example",
  "fallback": false,
  "regex": false
}
```

{% endcut %}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page",
  "redirect": {
    "page_id": 0,
    "redirect_target": {
      "id": 0,
      "slug": "example",
      "title": "example",
      "page_type": null
    }
  },
  "breadcrumbs": [
    {
      "id": 0,
      "title": "example",
      "slug": "example",
      "page_exists": true
    }
  ],
  "attributes": {
    "created_at": "2025-01-01T00:00:00Z",
    "modified_at": "2025-01-01T00:00:00Z",
    "lang": "example",
    "is_readonly": true,
    "comments_count": 0,
    "entity_links_count": 0,
    "comments_enabled": true,
    "is_collaborative": true,
    "is_draft": true
  },
  "content": "example",
  "access_policy": {
    "access_type": "inherited",
    "inherited_access_type": "all_staff",
    "all_staff_role": "reader",
    "has_external": true,
    "invite": {
      "status": null
    }
  },
  "access_lists": {
    "direct": [
      {
        "id": "example",
        "created_at": "2025-01-01T00:00:00Z",
        "user": null,
        "group": null,
        "role": null,
        "inheritance": null
      }
    ],
    "by_link": [
      null
    ],
    "inherited": [
      null
    ]
  },
  "owner": {
    "user": {
      "id": 0,
      "identity": null,
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "group": {
      "id": "example",
      "identity": null,
      "name": "example",
      "type": null,
      "metadata": null,
      "members_count": 0
    }
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Page ID. In `/v1/pages/{idx}` methods, the value of `idx` is the value of this field.
{.table-cell}
||
||

_page_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Page type

_Enum:_{.json-schema-reset .json-schema-value} `page`, `grid`, `wysiwyg`, `template`
{.table-cell}
||
||

_slug_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Page address relative to the Wiki root, such as `team/project`. Use this value as the `slug` parameter when retrieving a page by address.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_title_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Page title

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_access_lists_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageAccessListsSchema**

  **Type**: [PageAccessListsSchema](#entity-PageAccessListsSchema)

  Page access lists

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "direct": [
      {
        "id": "example",
        "created_at": "2025-01-01T00:00:00Z",
        "user": {
          "id": 0,
          "identity": null,
          "username": "example",
          "display_name": "example",
          "is_dismissed": true,
          "affiliation": "example"
        },
        "group": {
          "id": "example",
          "identity": null,
          "name": "example",
          "type": null,
          "metadata": null,
          "members_count": 0
        },
        "role": "reader",
        "inheritance": "inherited"
      }
    ],
    "by_link": [
      null
    ],
    "inherited": [
      null
    ]
  }
  ```

  {% endcut %}

{% endcut %}

**This field is not returned by default**

Include `access_lists` in the `?fields=access_lists, ...` list to get it in the response.

Page access lists

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "direct": [
    {
      "id": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "user": null,
      "group": null,
      "role": "reader",
      "inheritance": "inherited"
    }
  ],
  "by_link": [
    null
  ],
  "inherited": [
    null
  ]
}
```

{% endcut %}
{.table-cell}
||
||

_access_policy_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageAccessPolicySchema**

  **Type**: [PageAccessPolicySchema](#entity-PageAccessPolicySchema)

  Page access policy

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "access_type": "inherited",
    "inherited_access_type": "all_staff",
    "all_staff_role": "reader",
    "has_external": true,
    "invite": {
      "status": 0
    }
  }
  ```

  {% endcut %}

{% endcut %}

**This field is not returned by default**

Include `access_policy` in the `?fields=access_policy, ...` list to get it in the response.

Page access settings

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "access_type": "inherited",
  "inherited_access_type": "all_staff",
  "all_staff_role": "reader",
  "has_external": true,
  "invite": {
    "status": 0
  }
}
```

{% endcut %}
{.table-cell}
||
||

_attributes_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageAttributesSchema**

  **Type**: [PageAttributesSchema](#entity-PageAttributesSchema)

  Additional page attributes

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "created_at": "2025-01-01T00:00:00Z",
    "modified_at": "2025-01-01T00:00:00Z",
    "lang": "example",
    "is_readonly": true,
    "comments_count": 0,
    "entity_links_count": 0,
    "comments_enabled": true,
    "is_collaborative": true,
    "is_draft": true
  }
  ```

  {% endcut %}

{% endcut %}

**This field is not returned by default**

Include `attributes` in `?fields=attributes, ...` to return it in the response.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "created_at": "2025-01-01T00:00:00Z",
  "modified_at": "2025-01-01T00:00:00Z",
  "lang": "example",
  "is_readonly": true,
  "comments_count": 0,
  "entity_links_count": 0,
  "comments_enabled": true,
  "is_collaborative": true,
  "is_draft": true
}
```

{% endcut %}
{.table-cell}
||
||

_breadcrumbs_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [BreadcrumbSchema](#entity-BreadcrumbSchema)[]

**This field is not returned by default**

To include it in the response, add `breadcrumbs` to the `?fields=breadcrumbs, ...` list.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": 0,
    "title": "example",
    "slug": "example",
    "page_exists": true
  }
]
```

{% endcut %}
{.table-cell}
||
||

_content_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

**This field is not returned by default**

Include `content` in the `?fields=content, ...` list to return it in the response.

Page content as a string.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_owner_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageOwnerSchema**

  **Type**: [PageOwnerSchema](#entity-PageOwnerSchema)

  Page owner

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "user": {
      "id": 0,
      "identity": {
        "uid": "example",
        "cloud_uid": "example"
      },
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "group": {
      "id": "example",
      "identity": {
        "src": null,
        "id": "example"
      },
      "name": "example",
      "type": "wiki",
      "metadata": {
        "url": "example",
        "externals_count": 0
      },
      "members_count": 0
    }
  }
  ```

  {% endcut %}

{% endcut %}

**This field is not returned by default**

Include `owner` in the `?fields=owner, ...` list to get it in the response.

Page owner

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "user": {
    "id": 0,
    "identity": null,
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "group": {
    "id": "example",
    "identity": null,
    "name": "example",
    "type": "wiki",
    "metadata": {},
    "members_count": 0
  }
}
```

{% endcut %}
{.table-cell}
||
||

_redirect_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **RedirectSchema**

  **Type**: [RedirectSchema](#entity-RedirectSchema)

  Page redirect information

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "page_id": 0,
    "redirect_target": {
      "id": 0,
      "slug": "example",
      "title": "example",
      "page_type": "page"
    }
  }
  ```

  {% endcut %}

{% endcut %}

**This field is not returned by default**

To include it in the response, add `redirect` to the `?fields=redirect, ...` list.

Returns `null` if there is no redirect.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "page_id": 0,
  "redirect_target": {
    "id": 0,
    "slug": "example",
    "title": "example",
    "page_type": "page"
  }
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### PageType {#entity-PageType}

Page type:
- `page` — regular page
- `grid` — page with a table
- `wysiwyg` — page with a visual editor
- `template` — page template


**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `page`, `grid`, `wysiwyg`, `template`

</div>

<div class="openapi-entity">

### PageDetailsSchema {#entity-PageDetailsSchema}

Brief page information

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Page ID. In `/v1/pages/{idx}` methods, the value of `idx` is the value of this field.
{.table-cell}
||
||

_page_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageType**

  **Type**: [PageType](#entity-PageType)

  Page type:
  - `page` — regular page
  - `grid` — page with a table
  - `wysiwyg` — page with a visual editor
  - `template` — page template


  _Enum:_{.json-schema-reset .json-schema-value} `page`, `grid`, `wysiwyg`, `template`

{% endcut %}

Page type

_Example:_{.json-schema-reset .json-schema-example} `page`
{.table-cell}
||
||

_slug_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Page address relative to the Wiki root, such as `team/project`. Use this value as the `slug` parameter when retrieving a page by address.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_title_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Page title

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### RedirectSchema {#entity-RedirectSchema}

Page redirect information

#|
|| **Name** | **Description** ||
||

_page_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

ID of the page that the current page redirects to.
{.table-cell}
||
||

_redirect_target_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageDetailsSchema**

  **Type**: [PageDetailsSchema](#entity-PageDetailsSchema)

  Brief page information

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": 0,
    "slug": "example",
    "title": "example",
    "page_type": "page"
  }
  ```

  {% endcut %}

{% endcut %}

The final page in the redirect chain. For example, in the chain A → B → C → D, this is page D for pages A, B, and C.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "page_id": 0,
  "redirect_target": {
    "id": 0,
    "slug": "example",
    "title": "example",
    "page_type": "page"
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### BreadcrumbSchema {#entity-BreadcrumbSchema}

Breadcrumb item (navigation chain)

#|
|| **Name** | **Description** ||
||

_page_exists_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

The page exists
{.table-cell}
||
||

_slug_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Page address (slug)

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_title_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Page title

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Page ID (if the page exists)
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "title": "example",
  "slug": "example",
  "page_exists": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PageAttributesSchema {#entity-PageAttributesSchema}

Additional page attributes

#|
|| **Name** | **Description** ||
||

_comments_count_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Number of comments on the page
{.table-cell}
||
||

_comments_enabled_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Comments are enabled
{.table-cell}
||
||

_created_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Date and time the page was created

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_entity_links_count_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Number of links on the page
{.table-cell}
||
||

_is_readonly_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

The page is read-only
{.table-cell}
||
||

_lang_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Page language (for example, `ru`, `en`)

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_modified_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Date and time the page was last modified

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_is_collaborative_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Collaborative editing is enabled
{.table-cell}
||
||

_is_draft_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

The page is a draft
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "created_at": "2025-01-01T00:00:00Z",
  "modified_at": "2025-01-01T00:00:00Z",
  "lang": "example",
  "is_readonly": true,
  "comments_count": 0,
  "entity_links_count": 0,
  "comments_enabled": true,
  "is_collaborative": true,
  "is_draft": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PageAccessTypeAPI {#entity-PageAccessTypeAPI}

Page access type:
- `inherited`: Access is inherited from the parent page.
- `all_staff`: Access for all employees.
- `custom`: Personal access permissions.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `inherited`, `all_staff`, `custom`

</div>

<div class="openapi-entity">

### AccessTypeInheritedAPI {#entity-AccessTypeInheritedAPI}

Inherited access type:
- `all_staff`: Access for all employees.
- `custom`: Personal access permissions.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `all_staff`, `custom`

</div>

<div class="openapi-entity">

### RoleAllStaffAPI {#entity-RoleAllStaffAPI}

- `reader`: Read.
- `editor`: Edit.
- `extra_editor`: Extended editing.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `reader`, `editor`, `extra_editor`

</div>

<div class="openapi-entity">

### PageInviteStatus {#entity-PageInviteStatus}

Invite link status:
- `0`: Deleted.
- `1`: Enabled.
- `2`: Disabled.

**Type**: integer

_Enum:_{.json-schema-reset .json-schema-value} `0`, `1`, `2`

</div>

<div class="openapi-entity">

### AclPreviewInviteSchema {#entity-AclPreviewInviteSchema}

Information about the invite link for page access

#|
|| **Name** | **Description** ||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageInviteStatus**

  **Type**: [PageInviteStatus](#entity-PageInviteStatus)

  Invite link status:
  - `0`: Deleted.
  - `1`: Enabled.
  - `2`: Disabled.

  _Enum:_{.json-schema-reset .json-schema-value} `0`, `1`, `2`

  _Example:_{.json-schema-reset .json-schema-example} `0`

{% endcut %}

Invite link status: `0` means deleted (not returned by the API), `1` means enabled, and `2` means disabled.

_Example:_{.json-schema-reset .json-schema-example} `0`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "status": 0
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PageAccessPolicySchema {#entity-PageAccessPolicySchema}

Page access policy

#|
|| **Name** | **Description** ||
||

_access_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageAccessTypeAPI**

  **Type**: [PageAccessTypeAPI](#entity-PageAccessTypeAPI)

  Page access type:
  - `inherited`: Access is inherited from the parent page.
  - `all_staff`: Access for all employees.
  - `custom`: Personal access permissions.

  _Enum:_{.json-schema-reset .json-schema-value} `inherited`, `all_staff`, `custom`

{% endcut %}

Access type

_Example:_{.json-schema-reset .json-schema-example} `inherited`
{.table-cell}
||
||

_all_staff_role_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **RoleAllStaffAPI**

  **Type**: [RoleAllStaffAPI](#entity-RoleAllStaffAPI)

  - `reader`: Read.
  - `editor`: Edit.
  - `extra_editor`: Extended editing.

  _Enum:_{.json-schema-reset .json-schema-value} `reader`, `editor`, `extra_editor`

{% endcut %}

Role for "All employees" access

_Example:_{.json-schema-reset .json-schema-example} `reader`
{.table-cell}
||
||

_has_external_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Indicates whether the page is accessible to external consultants. If `null`, the status is unknown.
{.table-cell}
||
||

_inherited_access_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **AccessTypeInheritedAPI**

  **Type**: [AccessTypeInheritedAPI](#entity-AccessTypeInheritedAPI)

  Inherited access type:
  - `all_staff`: Access for all employees.
  - `custom`: Personal access permissions.

  _Enum:_{.json-schema-reset .json-schema-value} `all_staff`, `custom`

{% endcut %}

Inherited access type

_Example:_{.json-schema-reset .json-schema-example} `all_staff`
{.table-cell}
||
||

_invite_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **AclPreviewInviteSchema**

  **Type**: [AclPreviewInviteSchema](#entity-AclPreviewInviteSchema)

  Information about the invite link for page access

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "status": 0
  }
  ```

  {% endcut %}

{% endcut %}

Information about the invite link for page access

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "status": 0
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "access_type": "inherited",
  "inherited_access_type": "all_staff",
  "all_staff_role": "reader",
  "has_external": true,
  "invite": {
    "status": 0
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### UserIdentity {#entity-UserIdentity}

User identifier

#|
|| **Name** | **Description** ||
||

_cloud_uid_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

User identifier in the cloud

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_uid_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Yandex user ID

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "uid": "example",
  "cloud_uid": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### UserSchema {#entity-UserSchema}

User information

#|
|| **Name** | **Description** ||
||

_affiliation_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

User affiliation

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_display_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

User display name

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Internal user identifier
{.table-cell}
||
||

_is_dismissed_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

The user is dismissed
{.table-cell}
||
||

_username_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

User login

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_identity_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **UserIdentity**

  **Type**: [UserIdentity](#entity-UserIdentity)

  User identifier

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "uid": "example",
    "cloud_uid": "example"
  }
  ```

  {% endcut %}

{% endcut %}

User identifier in the system

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "uid": "example",
  "cloud_uid": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ComSource {#entity-ComSource}

Source of the group ID:
- `dir`: IAM.
- `cloud`: Yandex Cloud.
- `com`: Local database.
- `staff`: Internal employee directory.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `dir`, `cloud`, `com`, `staff`

</div>

<div class="openapi-entity">

### ComIdentitySchema {#entity-ComIdentitySchema}

Group identifier

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Group identifier in the specified source

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_src_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **ComSource**

  **Type**: [ComSource](#entity-ComSource)

  Source of the group ID:
  - `dir`: IAM.
  - `cloud`: Yandex Cloud.
  - `com`: Local database.
  - `staff`: Internal employee directory.

  _Enum:_{.json-schema-reset .json-schema-value} `dir`, `cloud`, `com`, `staff`

{% endcut %}

Identifier source

_Example:_{.json-schema-reset .json-schema-example} `dir`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "src": "dir",
  "id": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### GroupType {#entity-GroupType}

Group type:
- `wiki`: Wiki group.
- `service`: Service group.
- `servicerole`: Service role.
- `group`: Regular group.
- `department`: Department.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `wiki`, `service`, `servicerole`, `group`, `department`

</div>

<div class="openapi-entity">

### IntranetGroupMetadata {#entity-IntranetGroupMetadata}

Group metadata from the internal directory

#|
|| **Name** | **Description** ||
||

_externals_count_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Number of external consultants in the group
{.table-cell}
||
||

_url_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Group URL in the directory

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "url": "example",
  "externals_count": 0
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### IamGroupMetadata {#entity-IamGroupMetadata}

Group metadata from IAM (Identity and Access Management)

#|
|| **Name** | **Description** ||
||

_dir_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Directory identifier

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "dir_id": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### GroupSchema {#entity-GroupSchema}

Group information

#|
|| **Name** | **Description** ||
||

_identity_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **ComIdentitySchema**

  **Type**: [ComIdentitySchema](#entity-ComIdentitySchema)

  Group identifier

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "src": "dir",
    "id": "example"
  }
  ```

  {% endcut %}

{% endcut %}

Group identifier in the system

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "src": "dir",
  "id": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Group name

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **GroupType**

  **Type**: [GroupType](#entity-GroupType)

  Group type:
  - `wiki`: Wiki group.
  - `service`: Service group.
  - `servicerole`: Service role.
  - `group`: Regular group.
  - `department`: Department.

  _Enum:_{.json-schema-reset .json-schema-value} `wiki`, `service`, `servicerole`, `group`, `department`

{% endcut %}

Group type

_Example:_{.json-schema-reset .json-schema-example} `wiki`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Group ID. Uses dir_id in the external version and staff_id in the internal version.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_members_count_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Number of group members

_Default:_{.json-schema-reset .json-schema-value} `0`
{.table-cell}
||
||

_metadata_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **IntranetGroupMetadata**

  **Type**: [IntranetGroupMetadata](#entity-IntranetGroupMetadata)

  Group metadata from the internal directory

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "url": "example",
    "externals_count": 0
  }
  ```

  {% endcut %}

- **IamGroupMetadata**

  **Type**: [IamGroupMetadata](#entity-IamGroupMetadata)

  Group metadata from IAM (Identity and Access Management)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "dir_id": "example"
  }
  ```

  {% endcut %}

{% endcut %}

Additional group metadata

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "url": "example",
  "externals_count": 0
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### RoleAPI {#entity-RoleAPI}

Page access role:
- `reader`: Read.
- `editor`: Edit.
- `extra_editor`: Extended editing.
- `author`: Author (full access).

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `reader`, `editor`, `extra_editor`, `author`

</div>

<div class="openapi-entity">

### InheritanceAPI {#entity-InheritanceAPI}

Access inheritance for subpages:
- `inherited`: Subpages inherit the access permission.
- `not_inherited`: Subpages do not inherit the access permission.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `inherited`, `not_inherited`

</div>

<div class="openapi-entity">

### PageAccessItem {#entity-PageAccessItem}

Custom page access item

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Unique access identifier

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_role_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **RoleAPI**

  **Type**: [RoleAPI](#entity-RoleAPI)

  Page access role:
  - `reader`: Read.
  - `editor`: Edit.
  - `extra_editor`: Extended editing.
  - `author`: Author (full access).

  _Enum:_{.json-schema-reset .json-schema-value} `reader`, `editor`, `extra_editor`, `author`

{% endcut %}

Access role

_Example:_{.json-schema-reset .json-schema-example} `reader`
{.table-cell}
||
||

_created_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Date and time the access was created

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_group_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **GroupSchema**

  **Type**: [GroupSchema](#entity-GroupSchema)

  Group information

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": "example",
    "identity": {
      "src": "dir",
      "id": "example"
    },
    "name": "example",
    "type": "wiki",
    "metadata": {
      "url": "example",
      "externals_count": 0
    },
    "members_count": 0
  }
  ```

  {% endcut %}

{% endcut %}

Group granted access (populated if access was granted to a group)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}
```

{% endcut %}
{.table-cell}
||
||

_inheritance_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **InheritanceAPI**

  **Type**: [InheritanceAPI](#entity-InheritanceAPI)

  Access inheritance for subpages:
  - `inherited`: Subpages inherit the access permission.
  - `not_inherited`: Subpages do not inherit the access permission.

  _Enum:_{.json-schema-reset .json-schema-value} `inherited`, `not_inherited`

{% endcut %}

Access inheritance setting for subpages

_Example:_{.json-schema-reset .json-schema-example} `inherited`
{.table-cell}
||
||

_user_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **UserSchema**

  **Type**: [UserSchema](#entity-UserSchema)

  User information

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  }
  ```

  {% endcut %}

{% endcut %}

User granted access (populated if access was granted to a user)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "user": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "group": {
    "id": "example",
    "identity": {
      "src": null,
      "id": "example"
    },
    "name": "example",
    "type": "wiki",
    "metadata": {
      "url": "example",
      "externals_count": 0
    },
    "members_count": 0
  },
  "role": "reader",
  "inheritance": "inherited"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PageAccessListsSchema {#entity-PageAccessListsSchema}

Page access lists

#|
|| **Name** | **Description** ||
||

_by_link_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PageAccessItem](#entity-PageAccessItem)[]

Access via invite link

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "user": {
      "id": 0,
      "identity": null,
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "group": {
      "id": "example",
      "identity": null,
      "name": "example",
      "type": "wiki",
      "metadata": {},
      "members_count": 0
    },
    "role": "reader",
    "inheritance": "inherited"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_direct_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PageAccessItem](#entity-PageAccessItem)[]

Direct custom access to the page

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "user": {
      "id": 0,
      "identity": null,
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "group": {
      "id": "example",
      "identity": null,
      "name": "example",
      "type": "wiki",
      "metadata": {},
      "members_count": 0
    },
    "role": "reader",
    "inheritance": "inherited"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_inherited_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PageAccessItem](#entity-PageAccessItem)[]

Access inherited from parent pages

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "user": {
      "id": 0,
      "identity": null,
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "group": {
      "id": "example",
      "identity": null,
      "name": "example",
      "type": "wiki",
      "metadata": {},
      "members_count": 0
    },
    "role": "reader",
    "inheritance": "inherited"
  }
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "direct": [
    {
      "id": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "user": {
        "id": 0,
        "identity": null,
        "username": "example",
        "display_name": "example",
        "is_dismissed": true,
        "affiliation": "example"
      },
      "group": {
        "id": "example",
        "identity": null,
        "name": "example",
        "type": null,
        "metadata": null,
        "members_count": 0
      },
      "role": "reader",
      "inheritance": "inherited"
    }
  ],
  "by_link": [
    null
  ],
  "inherited": [
    null
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PageOwnerSchema {#entity-PageOwnerSchema}

Page owner

#|
|| **Name** | **Description** ||
||

_group_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **GroupSchema**

  **Type**: [GroupSchema](#entity-GroupSchema)

  Group information

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": "example",
    "identity": {
      "src": "dir",
      "id": "example"
    },
    "name": "example",
    "type": "wiki",
    "metadata": {
      "url": "example",
      "externals_count": 0
    },
    "members_count": 0
  }
  ```

  {% endcut %}

{% endcut %}

Group that owns the page

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}
```

{% endcut %}
{.table-cell}
||
||

_user_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **UserSchema**

  **Type**: [UserSchema](#entity-UserSchema)

  User information

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  }
  ```

  {% endcut %}

{% endcut %}

User who owns the page

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "user": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "group": {
    "id": "example",
    "identity": {
      "src": null,
      "id": "example"
    },
    "name": "example",
    "type": "wiki",
    "metadata": {
      "url": "example",
      "externals_count": 0
    },
    "members_count": 0
  }
}
```

{% endcut %}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.