References
Forum Resources
Endpoints
GET
https://api.upcoach.com/forum-posts
List forum posts
Returns a list of forum posts
Parameters
Query
filter[user]
String
: Author user
filter[program]
String
: Program id
Responses
200: OK
A paginated list of Forum Post Resource Objects
200: OK
A paginated list of Forum Post Resource Objects
{
"data": [
{
"id": "...",
"author": {
"avatar": "...",
"email": "...",
"id": "...",
"name": "...",
"timezone": "..."
},
"program": {
"id": "...",
"name": "...",
"created_at": ...
},
...
},
...
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": ...,
"from": ...,
"last_page": ...,
"path": "...",
"per_page": ...,
"to": ...,
"total": ...
}
}
Resource Objects
Forum Post
Property | Type | Description |
---|---|---|
id | int | Forum post ID |
author | Author user | |
program | Program | |
category | Post category | |
title | string | Title |
link | string | Forum post link |
likes_count | int | Total number of likes |
comments_count | int | Total number of comments |
created_at | integer | Published date and time (Unix timestamp) |
Simple Category
Property | Type | Description |
---|---|---|
name | string | Category name |