Posts
featureOS list all posts API
Introduction
This endpoint lists all unhidden posts by default.
GET https://api.featureos.app/api/v3/feature_requests
Headers
Parameter | Default | Description |
---|---|---|
API-KEY | - | Generate from organization settings on the admin dashboard. |
ALLOW-PRIVATE | false | Set to true if filtering out a private board’s posts. |
Query Parameters
Parameter | Default | Format | Description |
---|---|---|---|
page | 1 | Integer | Used to paginate responses. |
per_page | 30 | Integer | Used to limit the posts count |
bucket_id | - | Integer | The ID of the bucket returned in the list buckets endpoint. Needs ALLOW-PRIVATE header to be set if it is a private board ID. |
approval_status | - | String | Filter posts based on its approval status. Can be set to either, 'pending' or 'approved' |
submitter_emails | [] | Array | Filter posts based on submitter emails. |
interactor_emails | [] | Array | Filter posts based on interactor emails for specific interactions like Submission or Vote. |
from_date | - | String (YYYY-MM-DD) | Filter posts based on its created date. Use it along with the below "to_date" parameter to filter the posts for a particular date range. |
to_date | - | String (YYYY-MM-DD) | Filter posts based on its created date. Use it along with the above "from_date" parameter to filter the posts for a particular date range. |
sort | - | String | Can be set to top, latest_created_at, oldest_created_at, latest_updated_at or oldest_updated_at |
Sample response
{
"success": true,
"feature_requests": [
{
"id": 4229,
"slug": "john-smith",
"title": "John Smith",
"preview": "John Smith",
"description": "This is a dummy description. \n\n",
"description_html": "<p>This is a dummy description.</p>",
"status": "In Progress",
"url": "https://feedback.featureos.app/b/api/p/john-smith",
"approval_status": "approved",
"submitter": {
"name": "Swathy",
"email": "[email protected]"
},
"bucket": {
"id": 14,
"name": "API"
},
"votes_count": 0,
"downvotes_count": 0,
"comments_count": 0,
"created_at": "2021-10-20T13:58:49.000Z",
"updated_at": "2021-10-20T13:58:49.000Z"
},
{
"id": 4229,
"slug": "chrissy-smith",
"title": "Chrissy Smith",
"preview": "Chrissy Smith",
"description": "This is a description for dummies. \n\n",
"description_html": "<p>This is a description for dummies.</p>",
"status": "Submitted",
"url": "https://feedback.featureos.app/b/api/p/chrissy-smith",
"approval_status": "approved",
"submitter": {
"name": "Swathy",
"email": "[email protected]"
},
"bucket": {
"id": 14,
"name": "API"
},
"votes_count": 0,
"downvotes_count": 0,
"comments_count": 0,
"created_at": "2021-10-20T13:58:49.000Z",
"updated_at": "2021-10-20T13:58:49.000Z"
}
]
}