Get a collection

Understanding how to use FeatureOS API to build custom integrations.

Introduction

The FeatureOS get a collection API allows you to retrieve information about your collections and their associated data.

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

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

const response = await fetch('https://api.featureos.app/api/v3/collections/: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/collections/: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.

Query Parameters

Parameter	Default	Description
id	-	The ID of the collection returned in the list collections endpoint.

Sample response

{
  "id": 12,
  "slug": "organization-settings",
  "color": "default",
  "description": "Everything you needs to set up your organization's branding and global settings.",
  "icon": "https://assets.production.skcript.com/featureos/app-assets/icons/regular/buildings.svg",
  "kind": "category",
  "name": "Organization Settings",
  "published_articles_count": 23,
  "published_articles_count_with_children": 0,
  "read_only": false,
  "sub_categories_count": 0,
  "created_at": "2024-05-20T05:44:33.911Z",
  "updated_at": "2024-11-26T11:21:03.404Z",
  "parent_id": null,
  "user_id": 123,
  "privacy": "public",
  "position": 10,
  "seo_title": null,
  "seo_description": null
}