API PageTypes Reference
When filtering by content type in API endpoints, use PageType values from the enumeration below. PageType parameters accept both numeric IDs and string names.
Examples
Filter by numeric ID:
{
"includePageTypes": [1, 11, 26]
}
Filter by name:
{
"includePageTypes": ["Page", "Post", "ForumTopic"]
}
Mixed usage:
{
"includePageTypes": [15, "Profile"],
"excludePageTypes": ["Section", 27]
}
Supported PageTypes
| Value | Name | Description |
|---|---|---|
| 1 | Page | Standard page |
| 2 | Section | Section or space container |
| 3 | Link | Internal link to another page |
| 4 | ExternalLink | Link to external URL |
| 6 | Calendar | Calendar container |
| 7 | PhotoGallery | Photo gallery |
| 8 | NewsBlog | Blog (container for posts) |
| 9 | Forum | Forum (container for topics) |
| 10 | Group | Group space |
| 11 | Post | Individual blog post |
| 12 | PostLink | Link within a blog |
| 13 | ExternalPostLink | External link within a blog |
| 14 | CalendarEvent | Calendar event |
| 15 | Document | File or document (includes media files) |
| 20 | Profile | User profile page |
| 23 | ProfileRoot | Employee Directory |
| 26 | ForumTopic | Forum discussion topic |
| 27 | Folder | Document folder |
| 28 | Home | Home page |
| 30 | MicroBlogEntry | Update or shoutout |
Common Filtering Scenarios
User-Generated Content:
{
"includePageTypes": ["Page", 11, "Post", 26, 30]
}
All Blog-Related Content:
{
"includePageTypes": [8, "Post"]
}All Forum Content:
{
"includePageTypes": ["Forum", 26]
}Files and Documents:
{
"includePageTypes": [15, "Folder"]
}Social/Activity Content:
{
"includePageTypes": ["MicroBlogEntry"]
}Notes
- Containers vs Content: Page types like NewsBlog (8), Forum (9), and PhotoGallery (7) are containers. Filter on Post (11), ForumTopic (26), or Document (15) to get the content within them.
- MicroBlogEntry (30): Updates and shoutouts posted to user profiles or groups
- ProfileRoot (23): The Employee Directory page listing all user profiles
- Other numeric values represent internal page types not supported by the API.
Comments
0 comments
Article is closed for comments.