REST API Documentation
/cms/records/{database_id}
Get list of records
For requests using an OAuth Access Token for a particular member, only records the authorized user can view will be included
Parameters
| Name | Type | Description |
|---|---|---|
ids
|
string | Comma-delimited list of record IDs |
categories
|
string | Comma-delimited list of category IDs |
authors
|
string | Comma-delimited list of member IDs - if provided, only records started by those members are returned |
locked
|
int | If 1, only records which are locked are returned, if 0 only unlocked |
hidden
|
int | If 1, only records which are hidden are returned, if 0 only not hidden |
pinned
|
int | If 1, only records which are pinned are returned, if 0 only not pinned |
featured
|
int | If 1, only records which are featured are returned, if 0 only not featured |
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
| Code | Message | Description |
|---|---|---|
2T306/1 |
INVALID_DATABASE |
The database ID does not exist or the authorized user does not have permission to view it |
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 records objects | The results for this page |
records object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
title
|
string | Title |
category
|
categories object | Category |
fields
|
object | Field values |
author
|
member object | The member that created the event |
date
|
datetime | When the record was created |
description
|
string | Event description |
comments
|
int | Number of comments |
reviews
|
int | Number of reviews |
views
|
int | Number of posts |
prefix
|
string | The prefix tag, if there is one |
tags
|
array of strings | The tags |
locked
|
bool | Event is locked |
hidden
|
bool | Event is hidden |
pinned
|
bool | Event is pinned |
featured
|
bool | Event is featured |
url
|
string|NULL | URL, or NULL if the database has not been embedded onto a page |
rating
|
float | Average Rating |
image
|
string | Record Image |
topic
|
topic object | The topic |
categories object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Name |
url
|
string | URL |
class
|
string | Node class |
parentId
|
int|null | Parent Node ID |
permissions
|
object|null | Node permissions |
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 |
topic object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
title
|
string | Title |
forum
|
forum object | Forum |
posts
|
int | Number of posts |
views
|
int | Number of views |
prefix
|
string | The prefix tag, if there is one |
tags
|
array of strings | The tags |
firstPost
|
post object | The first post in the topic |
lastPost
|
post object | The last post in the topic |
bestAnswer
|
post object | The best answer, if this is a question and there is one |
locked
|
bool | Topic is locked |
hidden
|
bool | Topic is hidden |
pinned
|
bool | Topic is pinned |
featured
|
bool | Topic is featured |
archived
|
bool | Topic is archived |
poll
|
poll object | Poll data, if there is one |
url
|
string | URL |
rating
|
float | Average Rating |
forum object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Forum name |
path
|
string | Forum name including parents (e.g. "Example Category > Example Forum") |
type
|
string | The type of forum: "discussions", "questions", "category", or "redirect" |
topics
|
int | Number of topics in forum |
url
|
string | URL |
parentId
|
int|null | Parent Node ID |
permissions
|
object|null | Node permissions |
post object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
item_id
|
int | The ID number of the item this belongs to |
author
|
member object | Author |
date
|
datetime | Date |
content
|
string | The content |
hidden
|
bool | Is hidden? |
url
|
string | URL to content |
reactions
|
array | Array of reactions given, array key is member_id of reaction giver ([member_id => [ title, id, value, icon ]]) |
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 |