Featurebase API (2026-01-01.nova)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

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.

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.

Retrieves the email preference state for a customer contact by their Featurebase ID.

Important: This endpoint only supports customer contacts. Leads do not have a customer email preference surface in the public API.

Path Parameters

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

Response Format

Returns a contact email preferences object with:

• object - Always "contact_email_preferences"
• contactId - Featurebase contact ID
• userId - External user ID, if available
• email - Contact email address, if available
• preferences - Current email preference state

Preference Semantics

Each preference includes:

• status - The stored preference state for that category
• effectiveStatus - The final state after applying the global all preference override

Example Response

{
  "object": "contact_email_preferences",
  "contactId": "676f0f6765bdaa7d7d760f88",
  "userId": "usr_12345",
  "email": "john@example.com",
  "preferences": {
    "all": {
      "status": "unsubscribed",
      "effectiveStatus": "unsubscribed"
    },
    "postUpdates": {
      "status": "subscribed",
      "effectiveStatus": "unsubscribed"
    },
    "postComments": {
      "status": "subscribed",
      "effectiveStatus": "unsubscribed"
    },
    "commentReplies": {
      "status": "subscribed",
      "effectiveStatus": "unsubscribed"
    },
    "changelog": {
      "status": "subscribed",
      "effectiveStatus": "unsubscribed"
    }
  }
}