Pages

The Pages API provides a functionality for managing site pages.

---

Basic information

• The request structure basic information.
• The responce structure basic information.
• The data types description.

Base URI

• RESOURCE_URIpages/

Scopes

• pages_read
• pages_write

Endpoints

RESOURCE_URI — URI is obtained from token exchange point.
TARGET_RESOURCE_URI — URI is obtained from the "sites/" or the "contacts/" endpoint.

Prefix	Endpoint	Description
RESOURCE_URI	pages/	Getting a list of pages
RESOURCE_URI	pages/add/	Adding a page
RESOURCE_URI	pages/ID	Retrieving page details
RESOURCE_URI	pages/ID/edit/	Editing a page
RESOURCE_URI	pages/ID/delete/	Deleting a page

---

+Getting a list of pages

Endpoint

• RESOURCE_URIpages/

Scopes

• pages_read

Request

• Request object type is @PagesListRequest

Response

• Response object type is @PagesListResponse

---

+Retrieving page details

Endpoint

• RESOURCE_URIpages/ID

Scopes

• pages_read

Request

• Request object type is @PagesItemRequest

Response

• Response object type is @PagesItemResponse

---

+Adding a page

Endpoint

• RESOURCE_URIpages/add/

Scopes

• pages_write

Request

• Request object type is @PagesAddRequest

Response

• Response object type is @PagesItemResponse

---

+Editing a page

Endpoint

• RESOURCE_URIpages/ID/edit/

Scopes

• pages_write

Request

• Request object type is @PagesAddRequest

Response

• Response object type is @PagesItemResponse

---

+Deleting a page

Endpoint

• RESOURCE_URIpages/ID/delete/

Scopes

• pages_write

Request

• No specific request params

Response

• No specific responce params

---

Definitions

PagesListRequest

Name	Description
limit (o) unsigned integer	Number of items expected in response.
cursor (o) string	The value of the next_cursor / prev_cursor parameter from the responce. Should be empty to get the first set (page) of elements.
fields (o) object	@PagesItemFields Read more about the Fields model.

PagesListResponse

Name	Description
items[] object	@PagesItemResponse
limit unsigned integer	Number of returned items (items per page).
next_cursor string	URL for the next portion of items (next page). Empty if there is no items for the next portion.
prev_cursor string	URL for the previous portion of items (previous page). Empty if there is no items for the previous portion.
total_count unsigned integer	Total number of items.

PagesItemRequest

Name	Description
fields (o) object	@PagesItemFields Read more about the Fields model.

PagesItemResponse

Name	Description
id unsigned integer	Page ID.
author_uid unsigned integer	ID of the user who added the page.
publish_time timestamp	Publish time.
title string	Page title.
message ? string	HTML formatted page content.
access ? object	@PagesAccessModel
can_comment ? boolean	true if there is permission to comment the page.
can_edit ? boolean	true if there is permission to edit the page.
comments_count ? unsigned integer	Total number of comments for the page.
attachments ? object	AttachmentStructure

PagesAccessModel

Name	Description
mode string	Possible values: any members member_groups admins
member_groups unsigned integer	Bitmask with member groups IDs Present only if mode is member_groups

PagesItemFields

• id
• author_uid
• publish_time
• title
• message ?
• access ?
• can_comment ?
• can_edit ?
• can_share ?
• comments_count ?
• attachments ?