Skip to content
REST API
/
/
Attach a contact to a com...

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

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

List contacts attached to a company

Request

Returns all contacts (customers) attached to a specific company.

Only returns contacts with type "customer" that have the company in their companyIds array. Uses cursor-based pagination.

Path Parameters

  • id - The Featurebase internal ID of the company (MongoDB ObjectId)

Query Parameters

  • limit - Number of contacts to return (1-100, default: 10)
  • cursor - Opaque cursor from a previous response for pagination

Response Structure

The response includes:

  • object - Always "list"
  • data - Array of contact objects
  • nextCursor - Cursor for the next page (null if no more results)

Example Response

{
  "object": "list",
  "data": [
    {
      "object": "contact",
      "id": "507f1f77bcf86cd799439011",
      "userId": "usr_12345",
      "email": "john@acme.com",
      "name": "John Doe",
      "type": "customer",
      "companies": [...],
      "createdAt": "2025-01-01T12:00:00.000Z"
    }
  ],
  "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
}

Error Responses

  • 404 Not Found - Company with the specified ID does not exist

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Security
bearerAuth
Path
idstringrequired

The Featurebase internal ID of the company (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011
Query
limitinteger[ 1 .. 100 ]

A limit on the number of contacts to be returned, between 1 and 100.

Default 10
Example: limit=10
cursorstring<= 512 characters

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page of results.

Example: cursor=eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
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/companies/507f1f77bcf86cd799439011/contacts?limit=10&cursor=eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9' \
  -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 or nullrequired

Array of contacts

Example: []
data[].​objectstringrequired

Object type identifier

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

Unique identifier

Example: "676f0f6765bdaa7d7d760f88"
data[].​userIdstring

External user ID from SSO

Example: "676f0f673dbb299c8a4f3057"
data[].​organizationIdstring

Organization ID the contact belongs to

Example: "5febde12dc56d60012d47db6"
data[].​companiesArray of objects(Company)

Companies the contact belongs to

Example: []
data[].​emailstring or null

Contact email

Example: "john@example.com"
data[].​namestringrequired

Contact display name

Example: "John Steezy"
data[].​profilePicturestring or null

Profile picture URL

Example: "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/anon_23.png"
data[].​commentsCreatednumber

Number of comments created

Example: 0
data[].​postsCreatednumber

Number of posts created

Example: 0
data[].​lastActivitystring

Last activity ISO timestamp

Example: "2025-01-03T21:42:30.181Z"
data[].​subscribedToChangelogboolean

Whether subscribed to changelog

Example: true
data[].​manuallyOptedOutFromChangelogboolean

Whether manually opted out from changelog

Example: false
data[].​rolesArray of strings

Contact roles

Example: []
data[].​localestring

Contact locale

Example: "en"
data[].​verifiedboolean

Whether email is verified

Example: true
data[].​typestringrequired

Type of contact

Enum"customer""lead"
Example: "customer"
data[].​descriptionstring

Contact description/bio

Example: ""
data[].​customFieldsobject

Custom field values on the contact

nextCursorstring or nullrequired

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

Example: "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
Response
application/json
{
  "object": "list",
  "data": [],
  "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
}

Attach a contact to a company

Request

Attaches a contact (customer) to a company.

Adds the company to the contact's companyIds array and embedded companies array. This operation is additive - existing company associations are preserved. Also increments the linkedUsers count on the company.

Path Parameters

  • id - The Featurebase internal ID of the company (MongoDB ObjectId)

Request Body

FieldTypeRequiredDescription
contactIdstringYesThe Featurebase internal ID of the contact to attach (MongoDB ObjectId)

Example Request

{
  "contactId": "507f1f77bcf86cd799439012"
}

Response

Returns the updated contact object with the new company association.

Example Response

{
  "object": "contact",
  "id": "507f1f77bcf86cd799439012",
  "userId": "usr_12345",
  "email": "john@acme.com",
  "name": "John Doe",
  "type": "customer",
  "companies": [
    {
      "object": "company",
      "id": "507f1f77bcf86cd799439011",
      "companyId": "comp_12345",
      "name": "Acme Inc"
    }
  ]
}

Error Responses

  • 404 Not Found - Company or contact does not exist

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Security
bearerAuth
Path
idstringrequired

The Featurebase internal ID of the company (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011
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
Bodyapplication/json
contactIdstringrequired

The Featurebase internal ID of the contact to attach (MongoDB ObjectId)

Example: "507f1f77bcf86cd799439012"
curl -i -X POST \
  https://docs.featurebase.app/_mock/rest-api/v2/companies/507f1f77bcf86cd799439011/contacts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "contactId": "507f1f77bcf86cd799439012"
  }'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"contact"
Example: "contact"
idstringrequired

Unique identifier

Example: "676f0f6765bdaa7d7d760f88"
userIdstring

External user ID from SSO

Example: "676f0f673dbb299c8a4f3057"
organizationIdstring

Organization ID the contact belongs to

Example: "5febde12dc56d60012d47db6"
companiesArray of objects(Company)

Companies the contact belongs to

Example: []
emailstring or null

Contact email

Example: "john@example.com"
namestringrequired

Contact display name

Example: "John Steezy"
profilePicturestring or null

Profile picture URL

Example: "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/anon_23.png"
commentsCreatednumber

Number of comments created

Example: 0
postsCreatednumber

Number of posts created

Example: 0
lastActivitystring

Last activity ISO timestamp

Example: "2025-01-03T21:42:30.181Z"
subscribedToChangelogboolean

Whether subscribed to changelog

Example: true
manuallyOptedOutFromChangelogboolean

Whether manually opted out from changelog

Example: false
rolesArray of strings

Contact roles

Example: []
localestring

Contact locale

Example: "en"
verifiedboolean

Whether email is verified

Example: true
typestringrequired

Type of contact

Enum"customer""lead"
Example: "customer"
descriptionstring

Contact description/bio

Example: ""
customFieldsobject

Custom field values on the contact

Response
application/json
{
  "object": "contact",
  "id": "676f0f6765bdaa7d7d760f88",
  "userId": "676f0f673dbb299c8a4f3057",
  "organizationId": "5febde12dc56d60012d47db6",
  "companies": [],
  "email": "john@example.com",
  "name": "John Steezy",
  "profilePicture": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/anon_23.png",
  "commentsCreated": 0,
  "postsCreated": 0,
  "lastActivity": "2025-01-03T21:42:30.181Z",
  "subscribedToChangelog": true,
  "manuallyOptedOutFromChangelog": false,
  "roles": [],
  "locale": "en",
  "verified": true,
  "type": "customer",
  "description": "",
  "customFields": {
    "property1": null,
    "property2": null
  }
}

Remove a contact from a company

Request

Removes a contact (customer) from a company.

Removes the company from the contact's companyIds array and embedded companies array. Also decrements the linkedUsers count on the company.

Path Parameters

  • id - The Featurebase internal ID of the company (MongoDB ObjectId)
  • contactId - The Featurebase internal ID of the contact to remove (MongoDB ObjectId)

Response

Returns the updated contact object with the company removed.

Example Response

{
  "object": "contact",
  "id": "507f1f77bcf86cd799439012",
  "userId": "usr_12345",
  "email": "john@acme.com",
  "name": "John Doe",
  "type": "customer",
  "companies": []
}

Error Responses

  • 400 Bad Request - Contact is not attached to this company
  • 404 Not Found - Company or contact does not exist

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Security
bearerAuth
Path
idstringrequired

The Featurebase internal ID of the company (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011
contactIdstringrequired

The Featurebase internal ID of the contact to remove (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439012
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 DELETE \
  https://docs.featurebase.app/_mock/rest-api/v2/companies/507f1f77bcf86cd799439011/contacts/507f1f77bcf86cd799439012 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"contact"
Example: "contact"
idstringrequired

Unique identifier

Example: "676f0f6765bdaa7d7d760f88"
userIdstring

External user ID from SSO

Example: "676f0f673dbb299c8a4f3057"
organizationIdstring

Organization ID the contact belongs to

Example: "5febde12dc56d60012d47db6"
companiesArray of objects(Company)

Companies the contact belongs to

Example: []
emailstring or null

Contact email

Example: "john@example.com"
namestringrequired

Contact display name

Example: "John Steezy"
profilePicturestring or null

Profile picture URL

Example: "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/anon_23.png"
commentsCreatednumber

Number of comments created

Example: 0
postsCreatednumber

Number of posts created

Example: 0
lastActivitystring

Last activity ISO timestamp

Example: "2025-01-03T21:42:30.181Z"
subscribedToChangelogboolean

Whether subscribed to changelog

Example: true
manuallyOptedOutFromChangelogboolean

Whether manually opted out from changelog

Example: false
rolesArray of strings

Contact roles

Example: []
localestring

Contact locale

Example: "en"
verifiedboolean

Whether email is verified

Example: true
typestringrequired

Type of contact

Enum"customer""lead"
Example: "customer"
descriptionstring

Contact description/bio

Example: ""
customFieldsobject

Custom field values on the contact

Response
application/json
{
  "object": "contact",
  "id": "676f0f6765bdaa7d7d760f88",
  "userId": "676f0f673dbb299c8a4f3057",
  "organizationId": "5febde12dc56d60012d47db6",
  "companies": [],
  "email": "john@example.com",
  "name": "John Steezy",
  "profilePicture": "https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/anon_23.png",
  "commentsCreated": 0,
  "postsCreated": 0,
  "lastActivity": "2025-01-03T21:42:30.181Z",
  "subscribedToChangelog": true,
  "manuallyOptedOutFromChangelog": false,
  "roles": [],
  "locale": "en",
  "verified": true,
  "type": "customer",
  "description": "",
  "customFields": {
    "property1": null,
    "property2": null
  }
}

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