Skip to content
REST API
/
/
Get contact by external u...

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

Contacts

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

Operations

Delete contact by ID

Request

Permanently deletes a contact by their Featurebase ID.

Supports deleting both customers and leads.

Path Parameters

  • id - The Featurebase contact ID (24-character ObjectId)

Deletion Behavior

When a contact is deleted:

  • The contact record is permanently removed
  • Associated data cleanup is triggered asynchronously
  • Comments and posts created by the contact are handled according to retention policies

Response

Returns a deletion confirmation object:

  • id - The ID of the deleted contact
  • object - Always "contact"
  • deleted - Always true

Example Response

{
  "id": "676f0f6765bdaa7d7d760f88",
  "object": "contact",
  "deleted": true
}

Version Availability

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

Security
bearerAuth
Path
idstringrequired

Featurebase contact ID

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

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier of the deleted contact

Example: "507f1f77bcf86cd799439011"
objectstringrequired

Object type identifier

Value"contact"
Example: "contact"
deletedbooleanrequired

Indicates the resource was deleted

Valuetrue
Example: true
Response
application/json
{
  "id": "507f1f77bcf86cd799439011",
  "object": "contact",
  "deleted": true
}

Get contact by external user ID

Request

Retrieves a single contact by their external user ID (from your system via SSO).

Important: This endpoint only returns customers (type: "customer"). Leads are not returned.

Path Parameters

  • userId - The external user ID from your system (matched via SSO integration)

Response Format

Returns a single contact object with:

  • object - Always "contact"
  • id - Unique contact identifier
  • userId - External user ID from SSO
  • email - Contact email address
  • name - Contact display name
  • profilePicture - Profile picture URL
  • type - Always "customer" for this endpoint
  • companies - Array of companies the contact belongs to
  • customFields - Custom field values
  • postsCreated - Number of posts created
  • commentsCreated - Number of comments created
  • lastActivity - Last activity timestamp

Example

{
  "object": "contact",
  "id": "676f0f6765bdaa7d7d760f88",
  "userId": "usr_12345",
  "email": "john@example.com",
  "name": "John Doe",
  "type": "customer",
  ...
}

Use Case

This endpoint is useful when you need to look up a contact using your own system's user identifier, such as when displaying Featurebase data alongside your user's information in your own application.

Version Availability

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

Security
bearerAuth
Path
userIdstring<= 255 charactersrequired

External user ID from your system

Example: usr_12345
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/contacts/by-user-id/usr_12345 \
  -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
  }
}

Delete contact by external user ID

Request

Permanently deletes a contact by their external user ID.

Important: This endpoint only deletes customers (type: "customer"). Leads cannot be deleted using this endpoint.

Path Parameters

  • userId - The external user ID from your system

Deletion Behavior

When a contact is deleted:

  • The contact record is permanently removed
  • Associated data cleanup is triggered asynchronously
  • Comments and posts created by the contact are handled according to retention policies

Response

Returns a deletion confirmation object:

  • id - The ID of the deleted contact
  • object - Always "contact"
  • deleted - Always true

Example Response

{
  "id": "676f0f6765bdaa7d7d760f88",
  "object": "contact",
  "deleted": true
}

Use Case

Use this endpoint when you need to delete a contact using your own system's user identifier, such as when a user deletes their account in your application.

Version Availability

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

Security
bearerAuth
Path
userIdstring<= 255 charactersrequired

External user ID from your system

Example: usr_12345
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/contacts/by-user-id/usr_12345 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier of the deleted contact

Example: "507f1f77bcf86cd799439011"
objectstringrequired

Object type identifier

Value"contact"
Example: "contact"
deletedbooleanrequired

Indicates the resource was deleted

Valuetrue
Example: true
Response
application/json
{
  "id": "507f1f77bcf86cd799439011",
  "object": "contact",
  "deleted": true
}

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