Retrieve Board

Retrieve details of a specific feedback board by ID.

Introduction

The FeatureOS retrieve boards API allows you to retrieve boards from your organization.

GET https://api.featureos.app/api/v3/buckets/:id

curl -X GET 'https://api.featureos.app/api/v3/buckets/:id' \
  -H 'API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.featureos.app/api/v3/buckets/:id', {
  method: 'GET',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.get(
    'https://api.featureos.app/api/v3/buckets/:id',
    headers={
        'API-KEY': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)
data = response.json()

Headers

Parameter	Default	Description
API-KEY	-	Generate from organization settings on the admin dashboard.
ALLOW-PRIVATE	false	Set to true if retrieving a private boards.

Query Parameters

Parameter	Default	Description
id	-	The ID of the board returned in the list boards endpoint.

{
  "success": true,
  "id": 1,
  "slug": "feedback",
  "name": "Feedback",
  "default": true,
  "private": false,
  "read_only": false,
  "form": {
    "description": null,
    "details": "Your Thoughts",
    "details_placeholder": "Remember, the more you tell, the more we know.",
    "heading": "New Submission",
    "title": "Title",
    "title_placeholder": "Title of your submission",
    "hello_sentence": null,
    "submission_template": null,
    "submit_button_text": "New Post"
  }
}