REST API Documentation
/blog/entries
Get list of entries
For requests using an OAuth Access Token for a particular member, only entries that are published and in blogs that are not disabled and not belonging to a particular club or social group will be included
Parameters
| Name | Type | Description |
|---|---|---|
ids
|
string | Comma-delimited list of entry IDs |
blogs
|
string | Comma-delimited list of blog IDs |
authors
|
string | Comma-delimited list of member IDs - if provided, only entries started by those members are returned |
locked
|
int | If 1, only entries which are locked are returned, if 0 only unlocked |
hidden
|
int | If 1, only entries which are hidden are returned, if 0 only not hidden |
pinned
|
int | If 1, only entries which are pinned are returned, if 0 only not pinned |
featured
|
int | If 1, only entries which are featured are returned, if 0 only not featured |
draft
|
int | If 1, only draft entries are returned, if 0 only published |
sortBy
|
string | What to sort by. Can be 'date' for creation date, 'title', 'updated' or leave unspecified for ID |
sortDir
|
string | Sort direction. Can be 'asc' or 'desc' - defaults to 'asc' |
page
|
int | Page number |
perPage
|
int | Number of results per page - defaults to 25 |
Exceptions
This endpoint doesn't throw any exceptions.
Response
| Name | Type | Description |
|---|---|---|
page
|
int | The page number for the results being shown |
perPage
|
int | The number of results that will be on each page |
totalResults
|
int | The total number of results |
totalPages
|
int | The number of pages of results |
results
|
array of entry objects | The results for this page |
entry object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
title
|
string | Title |
blog
|
blog object | Blog |
author
|
member object | The member that created the entry |
draft
|
bool | If this entry is a draft |
date
|
datetime | Date |
entry
|
string | Entry content |
comments
|
int | Number of comments |
views
|
int | Number of posts |
prefix
|
string | The prefix tag, if there is one |
tags
|
array of strings | The tags |
locked
|
bool | Entry is locked |
hidden
|
bool | Entry is hidden |
future
|
bool | Will be published at a future date? |
pinned
|
bool | Entry is pinned |
featured
|
bool | Entry is featured |
poll
|
poll object | Poll data, if there is one |
url
|
string | URL |
rating
|
float | Average Rating |
category
|
category object | Category |
blog object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Name |
description
|
string | Description |
owner
|
member object | If the blog is owned by a single member, the member |
groups
|
array of group objects | If the blog is owned by groups, an array of the groups |
pinned
|
bool | If the blog is pinned |
entries
|
int | Number of entries |
comments
|
int | Number of comments |
url
|
string | URL |
category
|
\IPS\blog\Category|NULL | Category, or NULL for club blogs |
member object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Username |
title
|
string | Member title |
timezone
|
string | Member timezone |
formattedName
|
string | Username with group formatting |
primaryGroup
|
group object | Primary group |
secondaryGroups
|
array of group objects | Secondary groups |
email
|
string | Email address |
joined
|
datetime | Registration date |
registrationIpAddress
|
string | IP address when registered |
warningPoints
|
int | Number of active warning points |
reputationPoints
|
int | Number of reputation points |
photoUrl
|
string | URL to photo (which will be the site's default if they haven't set one) |
photoUrlIsDefault
|
bool | Indicates if the value of photoUrl is the site's default |
coverPhotoUrl
|
string | URL to profile cover photo (will be blank if there isn't one) |
profileUrl
|
string|null | URL to profile |
validating
|
bool | Whether or not the validating flag is set on the member account |
posts
|
int | Number of content item submissions member has made |
lastActivity
|
datetime|null | Last activity date on the site. |
lastVisit
|
datetime|null | Last distinct visit date on the site. |
lastPost
|
datetime|null | Latest content submission date. |
profileViews
|
int | Number of times member's profile has been viewed |
birthday
|
string | Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied). |
customFields
|
array of fieldgroup objects | Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included |
rank
|
array of rank objects | Rank |
achievements_points
|
int | Points |
allowAdminEmails
|
bool | Whether or not this member wants to receive admin emails |
completed
|
bool | Whether or not the registration is completed |
group object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Name |
formattedName
|
string | Name with formatting |
rank object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Name |
url
|
string | Path to the rank icon |
points
|
int | Points |
poll object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
title
|
string | Title |
startDate
|
datetime | Start Date |
closed
|
bool | Closed |
closedDate
|
datetime | Closed Date |
public
|
bool | Public poll |
votes
|
int | Number of votes |
questions
|
array of question objects | The questions |