Skip to content
/Custom Fields

Featurebase API (2026-01-01.nova)

Welcome to the Featurebase API. This API allows you to programmatically interact with your Featurebase organization.

This documentation reflects API version 2026-01-01.nova.

Download OpenAPI description
index.json
index.yaml
Overview
URL
https://featurebase.app
License
Proprietary
Languages
Servers
Mock server
https://docs.featurebase.app/_mock/rest-api
Production
https://do.featurebase.app

API Versioning

This API uses date-based versioning. Each version is identified by a release date and slug, e.g., 2026-01-01.nova.

Specifying a Version

Include the version in the request header:

Featurebase-Version: 2026-01-01.nova

Or set a default version for your organization in the dashboard settings.

Version Compatibility

  • Newer versions may add new fields to responses (always backwards-compatible)
  • Breaking changes (removed/renamed fields, changed behavior) only occur in new versions
  • Your integration will continue to work as long as you pin to a specific version

Authentication

All API requests require authentication via API key.

Include in headers:

Authorization: Bearer <api-key>

Create and manage your API keys in the Featurebase dashboard.

Error Handling

The API uses conventional HTTP response codes to indicate success or failure:

  • 2xx - Success
  • 4xx - Client errors (bad request, unauthorized, not found, etc.)
  • 5xx - Server errors (internal error)

Error Response Format

All errors follow a consistent format:

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "Post not found",
    "param": "id",
    "status": 404
  }
}

Error Types

TypeDescription
authentication_errorAuthentication failed (401)
authorization_errorPermission denied (403)
invalid_request_errorInvalid request parameters or resource not found (400, 404, 410)
api_errorServer-side error (500)
rate_limit_errorToo many requests (429)

Boards

Boards (post categories) organize feedback into distinct containers with their own settings.

Operations

Posts

User-submitted feedback and feature requests. Posts belong to boards and can be upvoted, commented on, and tracked through statuses.

Operations

Post Statuses

Post statuses define the workflow stages for posts (e.g., In Review, Active, Completed).

Operations

Comments

Threaded discussions on posts and changelogs. Comments support voting, moderation, and privacy controls.

Operations

Custom Fields

Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.

Operations

List custom fields

Request

Returns all custom fields configured in your organization.

This endpoint returns all custom fields at once (typically a small list). No pagination is supported.

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of custom field objects
  • nextCursor - Always null

Custom Field Object

Each custom field includes:

  • id - Unique field identifier
  • label - Field label displayed to users
  • type - Field type (text, number, select, multi-select, checkbox, date)
  • required - Whether the field is required
  • placeholder - Placeholder text (for text/number fields)
  • public - Whether the field value is publicly visible
  • internal - Whether the field is for internal use only
  • options - Array of options (for select/multi-select fields)

Field Types

  • text - Single line text input
  • number - Numeric input
  • select - Single-choice dropdown
  • multi-select - Multiple-choice dropdown
  • checkbox - Boolean checkbox
  • date - Date picker
Security
bearerAuth
Headers
Featurebase-Versionstring(FeaturebaseVersion)

API version for this request. Defaults to your organization's configured API version if not specified.

Example: 2026-01-01.nova
curl -i -X GET \
  https://docs.featurebase.app/_mock/rest-api/v2/custom_fields \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"list"
Example: "list"
dataArray of objects(CustomField)required

Array of custom fields

Example: []
data[].​objectstringrequired

Object type identifier

Value"custom_field"
Example: "custom_field"
data[].​idstringrequired

Unique identifier

Example: "65d26304b2e65b1e1278170c"
data[].​labelstringrequired

Field label displayed to users

Example: "Your @username"
data[].​typestringrequired

Field type

Enum"text""number""select""multi-select""checkbox""date"
Example: "text"
data[].​requiredboolean

Whether the field is required

Example: true
data[].​placeholderstring

Placeholder text

Example: "Enter your username"
data[].​publicboolean

Whether the field value is publicly visible

Example: false
data[].​internalboolean

Whether the field is for internal use only

Example: false
data[].​optionsArray of objects(CustomFieldOption)

Options for select/multi-select fields

Example: [{"id":"65d26304b2e65b1e1278170d","label":"High Priority"}]
data[].​createdAtstring

ISO timestamp when created

Example: "2025-04-06T14:11:58.141Z"
data[].​updatedAtstring

ISO timestamp when last updated

Example: "2025-04-06T14:11:58.141Z"
nextCursorstring or nullrequired

Cursor for fetching the next page (cursor-based pagination)

Example: null
paginationobject

Pagination metadata for page-based requests

Response
application/json
{
  "object": "list",
  "data": [],
  "nextCursor": null,
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 42,
    "totalPages": 5
  }
}

Get a custom field by ID

Request

Retrieves a single custom field by its unique identifier.

Returns the custom field object if found in your organization.

Response

Returns a custom field object with:

  • id - Unique field identifier
  • label - Field label displayed to users
  • type - Field type (text, number, select, multi-select, checkbox, date)
  • required - Whether the field is required
  • placeholder - Placeholder text (for text/number fields)
  • public - Whether the field value is publicly visible
  • internal - Whether the field is for internal use only
  • options - Array of options (for select/multi-select fields)

Errors

  • 404 - Custom field not found in your organization
Security
bearerAuth
Path
idstringrequired

Custom field unique identifier

Example: 65d26304b2e65b1e1278170c
Headers
Featurebase-Versionstring(FeaturebaseVersion)

API version for this request. Defaults to your organization's configured API version if not specified.

Example: 2026-01-01.nova
curl -i -X GET \
  https://docs.featurebase.app/_mock/rest-api/v2/custom_fields/65d26304b2e65b1e1278170c \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"custom_field"
Example: "custom_field"
idstringrequired

Unique identifier

Example: "65d26304b2e65b1e1278170c"
labelstringrequired

Field label displayed to users

Example: "Your @username"
typestringrequired

Field type

Enum"text""number""select""multi-select""checkbox""date"
Example: "text"
requiredboolean

Whether the field is required

Example: true
placeholderstring

Placeholder text

Example: "Enter your username"
publicboolean

Whether the field value is publicly visible

Example: false
internalboolean

Whether the field is for internal use only

Example: false
optionsArray of objects(CustomFieldOption)

Options for select/multi-select fields

Example: [{"id":"65d26304b2e65b1e1278170d","label":"High Priority"}]
createdAtstring

ISO timestamp when created

Example: "2025-04-06T14:11:58.141Z"
updatedAtstring

ISO timestamp when last updated

Example: "2025-04-06T14:11:58.141Z"
Response
application/json
{
  "object": "custom_field",
  "id": "65d26304b2e65b1e1278170c",
  "label": "Your @username",
  "type": "text",
  "required": true,
  "placeholder": "Enter your username",
  "public": false,
  "internal": false,
  "options": [
    { … }
  ],
  "createdAt": "2025-04-06T14:11:58.141Z",
  "updatedAt": "2025-04-06T14:11:58.141Z"
}

Changelogs

Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.

Operations

Admins

Team members who manage your Featurebase organization. Admins have roles that define their permissions.

Operations

Teams

Teams are groups within your Featurebase organization. Use this endpoint to list and retrieve team information for conversation assignment and organization management.

Operations

Brands

Brands represent distinct brand identities within your organization. Each brand can have its own help center and email sending address. Use this endpoint to list and retrieve brand information.

Operations

Contacts

Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.

Operations

Companies

Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.

Operations

Surveys

Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.

Operations

Help Centers

Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.

Operations

Conversations

Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.

Operations

Webhooks

Webhooks allow you to receive real-time HTTP callbacks when events occur in your Featurebase organization. Configure webhook endpoints to subscribe to specific event types.

Operations