Get Organization Info

Understanding how to use FeatureOS API to build custom integrations.

Introduction

The FeatureOS Organizations API allows you to retrieve information about your organization. You can also retrieve organization's associated data.

GET https://api.featureos.app/api/v3/organizations/info

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

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

Sample response

{
  "success": true,
  "organization": {
    "subdomain": "feedback",
    "name": "FeatureOS",
    "description": "",
    "home_page": "http://feedback.featureos.app/",
    "avatar": null,
    "brand_colors": {
      "primary": "#4353FF",
      "primary_light": "#C8C8FF",
      "primary_dark": "#3947D9"
    }
  },
  "form": {
    "description": "Have something to say? Join the conversation.",
    "submit_button_text": "New Post"
  },
  "status_info": [
        {
            "id": 1,
            "slug": "under_review",
            "name": "In Review",
            "status": "under_review",
            "color": "#A855F7",
            "position": 0,
        },
        {
            "id": 2,
            "slug": "planned",
            "name": "Planned",
            "status": "planned",
            "color": "#EC4899",
            "position": 0,
        },
        ...
    ]
}