Skip to content
Featurebase Featurebase Featurebase
Dashboard
API Reference

Users

UsersContacts

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

List contacts
GET/v2/contacts
Create or update a contact
POST/v2/contacts
Get contact by ID
GET/v2/contacts/{id}
Delete contact by ID
DELETE/v2/contacts/{id}
Block a contact
POST/v2/contacts/{id}/block
Unblock a contact
POST/v2/contacts/{id}/unblock
ModelsExpand Collapse
Contact object { id, name, object, 16 more }

User who submitted the response

id: string

Unique identifier

name: string

Contact display name

object: "contact"

Object type identifier

type: "customer" or "lead"

Type of contact

One of the following:
"customer"
"lead"
commentsCreated: optional number

Number of comments created

companies: optional array of Company { id, companyId, companySize, 11 more }

Companies the contact belongs to

id: string

Featurebase internal ID

companyId: string

External company ID from your system

companySize: number

Company employee headcount

createdAt: string

ISO date when company was created

industry: string

Industry

lastActivity: string

ISO date of last activity

linkedUsers: number

Number of users linked to this company

monthlySpend: number

Monthly spend

name: string

Company name

object: "company"

Object type identifier

plan: string

Plan or tier name

updatedAt: string

ISO date when company was last updated

website: string

Company website URL

customFields: optional map[unknown]

Custom field values

customFields: optional map[unknown]

Custom field values on the contact

description: optional string

Contact description/bio

email: optional string

Contact email

lastActivity: optional string

Last activity ISO timestamp

locale: optional string

Contact locale

manuallyOptedOutFromChangelog: optional boolean

Whether manually opted out from changelog

organizationId: optional string

Organization ID the contact belongs to

postsCreated: optional number

Number of posts created

profilePicture: optional string

Profile picture URL

roles: optional array of string

Contact roles

subscribedToChangelog: optional boolean

Whether subscribed to changelog

userId: optional string

External user ID from SSO

verified: optional boolean

Whether email is verified

ContactList object { data, nextCursor, object }
data: array of Contact { id, name, object, 16 more }

Array of contacts

nextCursor: string

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

object: "list"

Object type identifier

DeletedContact object { id, deleted, object }
id: string

Unique identifier of the deleted contact

deleted: true

Indicates the resource was deleted

object: "contact"

Object type identifier

ContactCreateOrUpdateResponse = Contact { id, name, object, 16 more }

User who submitted the response

ContactRetrieveResponse = Contact { id, name, object, 16 more }

User who submitted the response

ContactBlockResponse object { id, blocked, object }
id: string

Unique identifier of the blocked contact

blocked: true

Indicates the contact was blocked

object: "contact"

Object type identifier

ContactUnblockResponse object { id, object, unblocked }
id: string

Unique identifier of the unblocked contact

object: "contact"

Object type identifier

unblocked: true

Indicates the contact was unblocked

UsersContactsBy User ID

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

Get contact by external user ID
GET/v2/contacts/by-user-id/{userId}
Delete contact by external user ID
DELETE/v2/contacts/by-user-id/{userId}
ModelsExpand Collapse
ByUserIDRetrieveResponse = Contact { id, name, object, 16 more }

User who submitted the response

UsersContactsBy User IDEmail Preferences

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

Get contact email preferences by external user ID
GET/v2/contacts/by-user-id/{userId}/email-preferences
Update contact email preferences by external user ID
PATCH/v2/contacts/by-user-id/{userId}/email-preferences

UsersContactsEmail Preferences

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

Get contact email preferences by ID
GET/v2/contacts/{id}/email-preferences
Update contact email preferences by ID
PATCH/v2/contacts/{id}/email-preferences
ModelsExpand Collapse
PreferenceState object { effectiveStatus, status }

Global email preference state for all email notifications.

effectiveStatus: "subscribed" or "unsubscribed"

Final effective status after applying global preference overrides

One of the following:
"subscribed"
"unsubscribed"
status: "subscribed" or "unsubscribed"

Stored preference status for this category

One of the following:
"subscribed"
"unsubscribed"
PreferencesOutput object { contactId, object, preferences, 2 more }
contactId: string

Featurebase contact ID

object: "contact_email_preferences"

Object type identifier

preferences: object { all, changelog, commentReplies, 2 more }

Email preference state for this contact, including both stored status and final effective status.

all: PreferenceState { effectiveStatus, status }

Global email preference state for all email notifications.

effectiveStatus: "subscribed" or "unsubscribed"

Final effective status after applying global preference overrides

One of the following:
"subscribed"
"unsubscribed"
status: "subscribed" or "unsubscribed"

Stored preference status for this category

One of the following:
"subscribed"
"unsubscribed"
changelog: PreferenceState { effectiveStatus, status }

Global email preference state for all email notifications.

effectiveStatus: "subscribed" or "unsubscribed"

Final effective status after applying global preference overrides

One of the following:
"subscribed"
"unsubscribed"
status: "subscribed" or "unsubscribed"

Stored preference status for this category

One of the following:
"subscribed"
"unsubscribed"
commentReplies: PreferenceState { effectiveStatus, status }

Global email preference state for all email notifications.

effectiveStatus: "subscribed" or "unsubscribed"

Final effective status after applying global preference overrides

One of the following:
"subscribed"
"unsubscribed"
status: "subscribed" or "unsubscribed"

Stored preference status for this category

One of the following:
"subscribed"
"unsubscribed"
postComments: PreferenceState { effectiveStatus, status }

Global email preference state for all email notifications.

effectiveStatus: "subscribed" or "unsubscribed"

Final effective status after applying global preference overrides

One of the following:
"subscribed"
"unsubscribed"
status: "subscribed" or "unsubscribed"

Stored preference status for this category

One of the following:
"subscribed"
"unsubscribed"
postUpdates: PreferenceState { effectiveStatus, status }

Global email preference state for all email notifications.

effectiveStatus: "subscribed" or "unsubscribed"

Final effective status after applying global preference overrides

One of the following:
"subscribed"
"unsubscribed"
status: "subscribed" or "unsubscribed"

Stored preference status for this category

One of the following:
"subscribed"
"unsubscribed"
email: optional string

Contact email address, if available

userId: optional string

External user ID from your system, if available

UpdatePreferenceBody object { preferences }
preferences: object { all, changelog, commentReplies, 2 more }
all: optional "subscribed" or "unsubscribed"

Master delivery gate. When unsubscribed, the contact receives no emails regardless of the per-category values. Per-category values are preserved.

One of the following:
"subscribed"
"unsubscribed"
changelog: optional "subscribed" or "unsubscribed"

Stored status for new changelog release notifications.

One of the following:
"subscribed"
"unsubscribed"
commentReplies: optional "subscribed" or "unsubscribed"

Stored status for replies to the contact’s own comments.

One of the following:
"subscribed"
"unsubscribed"
postComments: optional "subscribed" or "unsubscribed"

Stored status for new comments on posts the contact follows.

One of the following:
"subscribed"
"unsubscribed"
postUpdates: optional "subscribed" or "unsubscribed"

Stored status for post status changes and updates on posts the contact follows.

One of the following:
"subscribed"
"unsubscribed"

UsersCompanies

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

List all companies
GET/v2/companies
Create or update a company
POST/v2/companies
Get company by ID
GET/v2/companies/{id}
Delete a company
DELETE/v2/companies/{id}
Delete a company by external company ID
DELETE/v2/companies/by-company-id/{companyId}
ModelsExpand Collapse
Company object { id, companyId, companySize, 11 more }
id: string

Featurebase internal ID

companyId: string

External company ID from your system

companySize: number

Company employee headcount

createdAt: string

ISO date when company was created

industry: string

Industry

lastActivity: string

ISO date of last activity

linkedUsers: number

Number of users linked to this company

monthlySpend: number

Monthly spend

name: string

Company name

object: "company"

Object type identifier

plan: string

Plan or tier name

updatedAt: string

ISO date when company was last updated

website: string

Company website URL

customFields: optional map[unknown]

Custom field values

DeletedCompany object { id, deleted, object }
id: string

Unique identifier of the deleted company

deleted: true

Indicates the resource was deleted

object: "company"

Object type identifier

UsersCompaniesContacts

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

List contacts attached to a company
GET/v2/companies/{id}/contacts
Attach a contact to a company
POST/v2/companies/{id}/contacts
Remove a contact from a company
DELETE/v2/companies/{id}/contacts/{contactId}
ModelsExpand Collapse
ContactAttachResponse = Contact { id, name, object, 16 more }

User who submitted the response

ContactRemoveResponse = Contact { id, name, object, 16 more }

User who submitted the response