Skip to content
Dashboard

Posts

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

List all posts
client.feedback.posts.list(PostListParams { boardId, cursor, inReview, 8 more } params?, RequestOptionsoptions?): CursorPage<Post { id, access, anchor, 30 more } >
GET/v2/posts
Create a new post
client.feedback.posts.create(PostCreateParams { assigneeId, attachTo, author, 19 more } params, RequestOptionsoptions?): Post { id, access, anchor, 30 more }
POST/v2/posts
Get a post by ID
client.feedback.posts.retrieve(stringid, PostRetrieveParams { featurebaseVersion } params?, RequestOptionsoptions?): Post { id, access, anchor, 30 more }
GET/v2/posts/{id}
Update a post
client.feedback.posts.update(stringid, PostUpdateParams { assigneeId, author, boardId, 13 more } params, RequestOptionsoptions?): Post { id, access, anchor, 30 more }
PATCH/v2/posts/{id}
Delete a post
client.feedback.posts.delete(stringid, PostDeleteParams { featurebaseVersion } params?, RequestOptionsoptions?): PostDeleteResponse { id, deleted, object }
DELETE/v2/posts/{id}
Merge two posts
client.feedback.posts.merge(PostMergeParams { destinationPostId, sourcePostId, featurebaseVersion } params, RequestOptionsoptions?): Post { id, access, anchor, 30 more }
POST/v2/posts/merge
Unmerge a post
client.feedback.posts.unmerge(PostUnmergeParams { postId, featurebaseVersion } params, RequestOptionsoptions?): Post { id, access, anchor, 30 more }
POST/v2/posts/unmerge
Search posts
client.feedback.posts.search(PostSearchParams { cursor, limit, query, 3 more } params, RequestOptionsoptions?): PostSearchResponse { data, nextCursor, object, 2 more }
POST/v2/posts/search
ModelsExpand Collapse
Post { id, access, anchor, 30 more }
id: string

Unique identifier

access: PostAccess { companyExternalIds, userIds }
companyExternalIds: Array<string>

External company IDs explicitly granted access to this post. Empty array means no company-level restrictions. Non-empty means only users belonging to these companies can see the post.

userIds: Array<string>

User IDs explicitly granted access to this post. Empty array means no user-level restrictions (post uses board/org visibility). Non-empty means only these users (plus admins) can see the post.

anchor: Anchor | null

When kind is ‘insight’, where exactly the insight points back into its origin: an insight source record with character ranges into its fullText, or the native conversation/message/comment/post ids.

commentId?: string | null
conversationId?: string | null
messageId?: string | null
ranges?: Array<Range> | null
end: number
start: number
sourceRecordId?: string | null
submissionId?: string | null
assigneeId: string | null

ID of the admin assigned to this post, null if unassigned

author: PostAuthor { id, email, name, 2 more } | null
id: string | null

Author unique identifier

email: string | null

Author email (if available)

name: string

Author display name

profilePicture: string | null

Author profile picture URL

type: "admin" | "customer" | "guest" | 3 more

Type of user who authored the post

One of the following:
"admin"
"customer"
"guest"
"integration"
"bot"
"lead"
boardId: string

Board (category) ID this post belongs to

commentCount: number

Total number of comments

content: string

Post content in HTML format

createdAt: string

ISO 8601 timestamp when created

customFields: Record<string, unknown>

Custom field values keyed by field ID

eta: string | null

Estimated completion time as ISO 8601 timestamp, null if not set

features: PostFeatures { commentsEnabled }
commentsEnabled: boolean

Whether comments are allowed on this post

groupKey: string | null

When kind is ‘insight’, the triage grouping key (source record id, conversation id, origin post id, or the insight’s own id for singletons). Legacy insights may be null and group as singletons.

inReview: boolean

Whether the post is pending moderation review

insightSource: InsightSource | null

Provenance of an insight: which channel it came from and how it was captured.

channel: "slack" | "discord" | "email" | 5 more
One of the following:
"slack"
"discord"
"email"
"support"
"widget"
"call"
"api"
"feedback"
capturedBy?: "manual" | "auto" | "ai" | "api" | null
One of the following:
"manual"
"auto"
"ai"
"api"
conversationId?: string | null
externalId?: string | null
sourceLabel?: string | null
url?: string | null
integrations: Integrations { clickup, devops, github, 4 more }

Third-party integration links associated with this post

clickup: Array<Clickup>
id: string

ClickUp task ID

title: string

ClickUp task title

url: string

URL to the ClickUp task

devops: Array<Devop>
id: number

Azure DevOps work item ID

projectId: string

Azure DevOps project ID

projectName: string

Azure DevOps project name

title: string

Work item title

url: string

URL to the work item

github: Array<GitHub>
id: string

GitHub issue ID

number: string

GitHub issue number

repositoryFullName: string

Full repository name (owner/repo)

repositoryName: string

Repository name

title: string

GitHub issue title

url: string

URL to the GitHub issue

hubspot: Array<Hubspot>
dealAmount: number | null

Deal amount (for DEAL type)

dealClosed: boolean | null

Whether the deal is closed (for DEAL type)

objectId: number

HubSpot object ID

type: "TICKET" | "DEAL" | "CONTACT"

HubSpot object type

One of the following:
"TICKET"
"DEAL"
"CONTACT"
jira: Array<Jira>
issueId: string

Jira issue ID

issueUrl: string | null

URL to the Jira issue

linear: Array<Linear>
issueId: string

Linear issue ID

issueUrl: string | null

URL to the Linear issue

salesforce: Array<Salesforce>
amount: number | null

Opportunity amount (for Opportunity type)

isClosed: boolean | null

Whether the opportunity is closed (for Opportunity type)

objectId: string

Salesforce record ID

objectType: "Opportunity" | "Case"

Salesforce object type

One of the following:
"Opportunity"
"Case"
isPinned: boolean

Whether the post is pinned to the top

kind: "issue" | "insight" | "record"

Discriminates an actionable work item (‘issue’) from a customer submission whose claims were extracted into insights (‘record’ — not a work item). Defaults to ‘issue’ for all pre-existing posts. Default list responses return issues only; pass kind=‘record’ to opt in. Raw signal (‘insight’) is never returned by the posts resource — insights are served by /v2/insights.

One of the following:
"issue"
"insight"
"record"
linkedInsightCount: number

Number of insights linked to this issue as supporting evidence. Only meaningful when kind is ‘issue’.

linkedIssueId: string | null

When kind is ‘insight’, the ID of the issue this insight supports. Null when the insight is unlinked or when kind is ‘issue’.

object: "post"

Object type identifier

opportunityAmount: number | null

Total opportunity amount from linked HubSpot deals and Salesforce opportunities

portalHidden: boolean

True when the issue is hidden from portal/public surfaces. Missing stored values are returned as false.

postUrl: string

Full URL to view the post

slug: string

URL-friendly slug

status: PostStatus { id, color, isDefault, 3 more }
id: string

Unique identifier

color: string

Color for UI display

isDefault: boolean

Whether this is the default status for new posts

name: string

Display name

object: "post_status"

Object type identifier

type: "reviewing" | "unstarted" | "active" | 2 more

The workflow stage this status represents

One of the following:
"reviewing"
"unstarted"
"active"
"completed"
"canceled"
tags: Array<PostTag { id, color, name } >

Tags attached to this post

id: string

Tag unique identifier

color: string | null

Tag color hex code

name: string

Tag name

title: string

Post title

updatedAt: string

ISO 8601 timestamp when last modified

upvotes: number

Total number of upvotes

deduped?: true

Present and true only on POST /v2/posts, when the request carried a source.externalId that already had a post. The existing post is returned unchanged with HTTP 200; a newly created post returns HTTP 201 without this field.

intakeMode?: "request" | "feedback"

Present only on POST /v2/posts: the intakeMode the post was processed under (‘request’ when the request named none). On an idempotent replay (deduped: true) this is the mode the post was ORIGINALLY created with.

One of the following:
"request"
"feedback"
processing?: PostProcessing { status, reason, results }

On POST /v2/posts — queued: a processing run (claim extraction or the Organize rewrite) was enqueued and its result lands asynchronously on the post. skipped: nothing was enqueued; reason says which gate decided (‘request_mode’ for every intakeMode: ‘request’ create). existing: the create was an idempotent replay and the post was not processed again. On GET /v2/posts/{id} this field is present only for posts created with intakeMode: 'feedback' and reports how far that processing has got (‘queued’, ‘processing’, ‘complete’, ‘needs_review’, or ‘skipped’ with the same reason the create returned), with results listing what was made of the submission once the run has finished.

status: "queued" | "processing" | "complete" | 3 more

‘queued’ = an AI run was enqueued and has not landed yet; ‘processing’ = the run is working on the submission; ‘complete’ = it finished and results lists what it produced; ‘needs_review’ = it finished and a teammate still has to decide something; ‘skipped’ = nothing was enqueued (see reason); ‘existing’ = idempotent replay, not processed again.

One of the following:
"queued"
"processing"
"complete"
"needs_review"
"skipped"
"existing"
reason?: "request_mode" | "autopilot_off" | "insights_disabled" | 11 more

Why processing was skipped. ‘request_mode’ = intakeMode was ‘request’ (the default); ‘autopilot_off’ = the workspace’s Autopilot dial is off or its plan does not include it; ‘pipeline_paused’ = the platform paused AI processing (it resumes automatically); ‘support_board’ / ‘spam_held’ / ‘staff_authored’ / ‘no_content’ = the post did not qualify; ‘source_too_long’ = the text was over the length limit when the run read it (a create that long is normally refused with a 400 first); ‘extraction_failed’ = the AI could not read the text after repeated attempts; nothing was written, and opening the post in Triage runs the analysis again.

One of the following:
"request_mode"
"autopilot_off"
"insights_disabled"
"pipeline_paused"
"support_board"
"spam_held"
"staff_authored"
"not_a_post"
"no_board"
"no_id"
"no_content"
"source_too_long"
"extraction_failed"
"hook_error"
results?: Array<Result>

What the workspace’s “Organize submissions” lane made of this submission, one entry per ask it found, in the order they appear in the text. Present on GET /v2/posts/{id} for posts created with intakeMode: 'feedback' once the run has finished. Absent while the run is still working, and absent for workspaces that do not organize submissions — there the post itself is the request.

outcome: "attached" | "request" | "question" | "held"

‘request’ = the ask became a request of its own; ‘attached’ = it was added as evidence to a request that already existed; ‘held’ = it became a request that is waiting for a teammate to publish it; ‘question’ = it asked something and no request was created, so a teammate answers it.

One of the following:
"attached"
"request"
"question"
"held"
title: string

The ask, as it was written up.

postId?: string

The request this ask became, or was attached to. Absent for a question, and absent when the request is not readable through this API (for example a ticket board).

postTitle?: string

Title of postId.

reason?: "too_many_topics" | "uncertain" | "custom_fields" | "processing_failed"

Why a ‘held’ result is waiting for a teammate. Only on a ‘held’ result, and only one of these codes: ‘too_many_topics’ = the submission held more separate asks than one submission can become requests, so this one request lists the asks that did not fit, one line each in the customer’s words; ‘uncertain’ = the ask was too vague to file without a person; ‘custom_fields’ = the board requires custom fields this submission did not carry; ‘processing_failed’ = the AI could not rewrite the text (the request then holds the original words) or could not check this ask against existing requests, so a teammate confirms it is not a duplicate.

One of the following:
"too_many_topics"
"uncertain"
"custom_fields"
"processing_failed"
PostAccess { companyExternalIds, userIds }
companyExternalIds: Array<string>

External company IDs explicitly granted access to this post. Empty array means no company-level restrictions. Non-empty means only users belonging to these companies can see the post.

userIds: Array<string>

User IDs explicitly granted access to this post. Empty array means no user-level restrictions (post uses board/org visibility). Non-empty means only these users (plus admins) can see the post.

PostAuthor { id, email, name, 2 more }
id: string | null

Author unique identifier

email: string | null

Author email (if available)

name: string

Author display name

profilePicture: string | null

Author profile picture URL

type: "admin" | "customer" | "guest" | 3 more

Type of user who authored the post

One of the following:
"admin"
"customer"
"guest"
"integration"
"bot"
"lead"
PostFeatures { commentsEnabled }
commentsEnabled: boolean

Whether comments are allowed on this post

PostList { data, nextCursor, object, pagination }
data: Array<Post { id, access, anchor, 30 more } >

Array of posts

id: string

Unique identifier

access: PostAccess { companyExternalIds, userIds }
companyExternalIds: Array<string>

External company IDs explicitly granted access to this post. Empty array means no company-level restrictions. Non-empty means only users belonging to these companies can see the post.

userIds: Array<string>

User IDs explicitly granted access to this post. Empty array means no user-level restrictions (post uses board/org visibility). Non-empty means only these users (plus admins) can see the post.

anchor: Anchor | null

When kind is ‘insight’, where exactly the insight points back into its origin: an insight source record with character ranges into its fullText, or the native conversation/message/comment/post ids.

commentId?: string | null
conversationId?: string | null
messageId?: string | null
ranges?: Array<Range> | null
end: number
start: number
sourceRecordId?: string | null
submissionId?: string | null
assigneeId: string | null

ID of the admin assigned to this post, null if unassigned

author: PostAuthor { id, email, name, 2 more } | null
id: string | null

Author unique identifier

email: string | null

Author email (if available)

name: string

Author display name

profilePicture: string | null

Author profile picture URL

type: "admin" | "customer" | "guest" | 3 more

Type of user who authored the post

One of the following:
"admin"
"customer"
"guest"
"integration"
"bot"
"lead"
boardId: string

Board (category) ID this post belongs to

commentCount: number

Total number of comments

content: string

Post content in HTML format

createdAt: string

ISO 8601 timestamp when created

customFields: Record<string, unknown>

Custom field values keyed by field ID

eta: string | null

Estimated completion time as ISO 8601 timestamp, null if not set

features: PostFeatures { commentsEnabled }
commentsEnabled: boolean

Whether comments are allowed on this post

groupKey: string | null

When kind is ‘insight’, the triage grouping key (source record id, conversation id, origin post id, or the insight’s own id for singletons). Legacy insights may be null and group as singletons.

inReview: boolean

Whether the post is pending moderation review

insightSource: InsightSource | null

Provenance of an insight: which channel it came from and how it was captured.

channel: "slack" | "discord" | "email" | 5 more
One of the following:
"slack"
"discord"
"email"
"support"
"widget"
"call"
"api"
"feedback"
capturedBy?: "manual" | "auto" | "ai" | "api" | null
One of the following:
"manual"
"auto"
"ai"
"api"
conversationId?: string | null
externalId?: string | null
sourceLabel?: string | null
url?: string | null
integrations: Integrations { clickup, devops, github, 4 more }

Third-party integration links associated with this post

clickup: Array<Clickup>
id: string

ClickUp task ID

title: string

ClickUp task title

url: string

URL to the ClickUp task

devops: Array<Devop>
id: number

Azure DevOps work item ID

projectId: string

Azure DevOps project ID

projectName: string

Azure DevOps project name

title: string

Work item title

url: string

URL to the work item

github: Array<GitHub>
id: string

GitHub issue ID

number: string

GitHub issue number

repositoryFullName: string

Full repository name (owner/repo)

repositoryName: string

Repository name

title: string

GitHub issue title

url: string

URL to the GitHub issue

hubspot: Array<Hubspot>
dealAmount: number | null

Deal amount (for DEAL type)

dealClosed: boolean | null

Whether the deal is closed (for DEAL type)

objectId: number

HubSpot object ID

type: "TICKET" | "DEAL" | "CONTACT"

HubSpot object type

One of the following:
"TICKET"
"DEAL"
"CONTACT"
jira: Array<Jira>
issueId: string

Jira issue ID

issueUrl: string | null

URL to the Jira issue

linear: Array<Linear>
issueId: string

Linear issue ID

issueUrl: string | null

URL to the Linear issue

salesforce: Array<Salesforce>
amount: number | null

Opportunity amount (for Opportunity type)

isClosed: boolean | null

Whether the opportunity is closed (for Opportunity type)

objectId: string

Salesforce record ID

objectType: "Opportunity" | "Case"

Salesforce object type

One of the following:
"Opportunity"
"Case"
isPinned: boolean

Whether the post is pinned to the top

kind: "issue" | "insight" | "record"

Discriminates an actionable work item (‘issue’) from a customer submission whose claims were extracted into insights (‘record’ — not a work item). Defaults to ‘issue’ for all pre-existing posts. Default list responses return issues only; pass kind=‘record’ to opt in. Raw signal (‘insight’) is never returned by the posts resource — insights are served by /v2/insights.

One of the following:
"issue"
"insight"
"record"
linkedInsightCount: number

Number of insights linked to this issue as supporting evidence. Only meaningful when kind is ‘issue’.

linkedIssueId: string | null

When kind is ‘insight’, the ID of the issue this insight supports. Null when the insight is unlinked or when kind is ‘issue’.

object: "post"

Object type identifier

opportunityAmount: number | null

Total opportunity amount from linked HubSpot deals and Salesforce opportunities

portalHidden: boolean

True when the issue is hidden from portal/public surfaces. Missing stored values are returned as false.

postUrl: string

Full URL to view the post

slug: string

URL-friendly slug

status: PostStatus { id, color, isDefault, 3 more }
id: string

Unique identifier

color: string

Color for UI display

isDefault: boolean

Whether this is the default status for new posts

name: string

Display name

object: "post_status"

Object type identifier

type: "reviewing" | "unstarted" | "active" | 2 more

The workflow stage this status represents

One of the following:
"reviewing"
"unstarted"
"active"
"completed"
"canceled"
tags: Array<PostTag { id, color, name } >

Tags attached to this post

id: string

Tag unique identifier

color: string | null

Tag color hex code

name: string

Tag name

title: string

Post title

updatedAt: string

ISO 8601 timestamp when last modified

upvotes: number

Total number of upvotes

deduped?: true

Present and true only on POST /v2/posts, when the request carried a source.externalId that already had a post. The existing post is returned unchanged with HTTP 200; a newly created post returns HTTP 201 without this field.

intakeMode?: "request" | "feedback"

Present only on POST /v2/posts: the intakeMode the post was processed under (‘request’ when the request named none). On an idempotent replay (deduped: true) this is the mode the post was ORIGINALLY created with.

One of the following:
"request"
"feedback"
processing?: PostProcessing { status, reason, results }

On POST /v2/posts — queued: a processing run (claim extraction or the Organize rewrite) was enqueued and its result lands asynchronously on the post. skipped: nothing was enqueued; reason says which gate decided (‘request_mode’ for every intakeMode: ‘request’ create). existing: the create was an idempotent replay and the post was not processed again. On GET /v2/posts/{id} this field is present only for posts created with intakeMode: 'feedback' and reports how far that processing has got (‘queued’, ‘processing’, ‘complete’, ‘needs_review’, or ‘skipped’ with the same reason the create returned), with results listing what was made of the submission once the run has finished.

status: "queued" | "processing" | "complete" | 3 more

‘queued’ = an AI run was enqueued and has not landed yet; ‘processing’ = the run is working on the submission; ‘complete’ = it finished and results lists what it produced; ‘needs_review’ = it finished and a teammate still has to decide something; ‘skipped’ = nothing was enqueued (see reason); ‘existing’ = idempotent replay, not processed again.

One of the following:
"queued"
"processing"
"complete"
"needs_review"
"skipped"
"existing"
reason?: "request_mode" | "autopilot_off" | "insights_disabled" | 11 more

Why processing was skipped. ‘request_mode’ = intakeMode was ‘request’ (the default); ‘autopilot_off’ = the workspace’s Autopilot dial is off or its plan does not include it; ‘pipeline_paused’ = the platform paused AI processing (it resumes automatically); ‘support_board’ / ‘spam_held’ / ‘staff_authored’ / ‘no_content’ = the post did not qualify; ‘source_too_long’ = the text was over the length limit when the run read it (a create that long is normally refused with a 400 first); ‘extraction_failed’ = the AI could not read the text after repeated attempts; nothing was written, and opening the post in Triage runs the analysis again.

One of the following:
"request_mode"
"autopilot_off"
"insights_disabled"
"pipeline_paused"
"support_board"
"spam_held"
"staff_authored"
"not_a_post"
"no_board"
"no_id"
"no_content"
"source_too_long"
"extraction_failed"
"hook_error"
results?: Array<Result>

What the workspace’s “Organize submissions” lane made of this submission, one entry per ask it found, in the order they appear in the text. Present on GET /v2/posts/{id} for posts created with intakeMode: 'feedback' once the run has finished. Absent while the run is still working, and absent for workspaces that do not organize submissions — there the post itself is the request.

outcome: "attached" | "request" | "question" | "held"

‘request’ = the ask became a request of its own; ‘attached’ = it was added as evidence to a request that already existed; ‘held’ = it became a request that is waiting for a teammate to publish it; ‘question’ = it asked something and no request was created, so a teammate answers it.

One of the following:
"attached"
"request"
"question"
"held"
title: string

The ask, as it was written up.

postId?: string

The request this ask became, or was attached to. Absent for a question, and absent when the request is not readable through this API (for example a ticket board).

postTitle?: string

Title of postId.

reason?: "too_many_topics" | "uncertain" | "custom_fields" | "processing_failed"

Why a ‘held’ result is waiting for a teammate. Only on a ‘held’ result, and only one of these codes: ‘too_many_topics’ = the submission held more separate asks than one submission can become requests, so this one request lists the asks that did not fit, one line each in the customer’s words; ‘uncertain’ = the ask was too vague to file without a person; ‘custom_fields’ = the board requires custom fields this submission did not carry; ‘processing_failed’ = the AI could not rewrite the text (the request then holds the original words) or could not check this ask against existing requests, so a teammate confirms it is not a duplicate.

One of the following:
"too_many_topics"
"uncertain"
"custom_fields"
"processing_failed"
nextCursor: string | null

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

maxLength512
object: "list"

Object type identifier

PostProcessing { status, reason, results }

On POST /v2/posts — queued: a processing run (claim extraction or the Organize rewrite) was enqueued and its result lands asynchronously on the post. skipped: nothing was enqueued; reason says which gate decided (‘request_mode’ for every intakeMode: ‘request’ create). existing: the create was an idempotent replay and the post was not processed again. On GET /v2/posts/{id} this field is present only for posts created with intakeMode: 'feedback' and reports how far that processing has got (‘queued’, ‘processing’, ‘complete’, ‘needs_review’, or ‘skipped’ with the same reason the create returned), with results listing what was made of the submission once the run has finished.

status: "queued" | "processing" | "complete" | 3 more

‘queued’ = an AI run was enqueued and has not landed yet; ‘processing’ = the run is working on the submission; ‘complete’ = it finished and results lists what it produced; ‘needs_review’ = it finished and a teammate still has to decide something; ‘skipped’ = nothing was enqueued (see reason); ‘existing’ = idempotent replay, not processed again.

One of the following:
"queued"
"processing"
"complete"
"needs_review"
"skipped"
"existing"
reason?: "request_mode" | "autopilot_off" | "insights_disabled" | 11 more

Why processing was skipped. ‘request_mode’ = intakeMode was ‘request’ (the default); ‘autopilot_off’ = the workspace’s Autopilot dial is off or its plan does not include it; ‘pipeline_paused’ = the platform paused AI processing (it resumes automatically); ‘support_board’ / ‘spam_held’ / ‘staff_authored’ / ‘no_content’ = the post did not qualify; ‘source_too_long’ = the text was over the length limit when the run read it (a create that long is normally refused with a 400 first); ‘extraction_failed’ = the AI could not read the text after repeated attempts; nothing was written, and opening the post in Triage runs the analysis again.

One of the following:
"request_mode"
"autopilot_off"
"insights_disabled"
"pipeline_paused"
"support_board"
"spam_held"
"staff_authored"
"not_a_post"
"no_board"
"no_id"
"no_content"
"source_too_long"
"extraction_failed"
"hook_error"
results?: Array<Result>

What the workspace’s “Organize submissions” lane made of this submission, one entry per ask it found, in the order they appear in the text. Present on GET /v2/posts/{id} for posts created with intakeMode: 'feedback' once the run has finished. Absent while the run is still working, and absent for workspaces that do not organize submissions — there the post itself is the request.

outcome: "attached" | "request" | "question" | "held"

‘request’ = the ask became a request of its own; ‘attached’ = it was added as evidence to a request that already existed; ‘held’ = it became a request that is waiting for a teammate to publish it; ‘question’ = it asked something and no request was created, so a teammate answers it.

One of the following:
"attached"
"request"
"question"
"held"
title: string

The ask, as it was written up.

postId?: string

The request this ask became, or was attached to. Absent for a question, and absent when the request is not readable through this API (for example a ticket board).

postTitle?: string

Title of postId.

reason?: "too_many_topics" | "uncertain" | "custom_fields" | "processing_failed"

Why a ‘held’ result is waiting for a teammate. Only on a ‘held’ result, and only one of these codes: ‘too_many_topics’ = the submission held more separate asks than one submission can become requests, so this one request lists the asks that did not fit, one line each in the customer’s words; ‘uncertain’ = the ask was too vague to file without a person; ‘custom_fields’ = the board requires custom fields this submission did not carry; ‘processing_failed’ = the AI could not rewrite the text (the request then holds the original words) or could not check this ask against existing requests, so a teammate confirms it is not a duplicate.

One of the following:
"too_many_topics"
"uncertain"
"custom_fields"
"processing_failed"
PostTag { id, color, name }
id: string

Tag unique identifier

color: string | null

Tag color hex code

name: string

Tag name

SearchFilter { field, operator, value }
field: string

Field name to filter on (e.g. state, tag_ids, created_at)

minLength1
maxLength64
operator: "=" | "!=" | "IN" | 9 more

Comparison operator

One of the following:
"="
"!="
"IN"
"NIN"
">"
"<"
">="
"<="
"~"
"!~"
"^"
"$"
value: string | number | boolean | Array<string | number> | null

Value to compare against (primitive or array of primitives)

One of the following:
string
number
boolean
Array<string | number>
string
number
SearchFilterGroup { operator, value }
operator: "AND" | "OR"

Group operator: AND (all match) or OR (any match)

One of the following:
"AND"
"OR"
value: Array<SearchFilter { field, operator, value } >

Array of filter clauses (1-15 entries)

field: string

Field name to filter on (e.g. state, tag_ids, created_at)

minLength1
maxLength64
operator: "=" | "!=" | "IN" | 9 more

Comparison operator

One of the following:
"="
"!="
"IN"
"NIN"
">"
"<"
">="
"<="
"~"
"!~"
"^"
"$"
value: string | number | boolean | Array<string | number> | null

Value to compare against (primitive or array of primitives)

One of the following:
string
number
boolean
Array<string | number>
string
number
PostDeleteResponse { id, deleted, object }
id: string

Unique identifier of the deleted post

deleted: true

Indicates the resource was deleted

object: "post"

Object type identifier

PostSearchResponse { data, nextCursor, object, 2 more }
data: Array<Data>

Array of search results

id: string

Unique identifier

access: PostAccess { companyExternalIds, userIds }
companyExternalIds: Array<string>

External company IDs explicitly granted access to this post. Empty array means no company-level restrictions. Non-empty means only users belonging to these companies can see the post.

userIds: Array<string>

User IDs explicitly granted access to this post. Empty array means no user-level restrictions (post uses board/org visibility). Non-empty means only these users (plus admins) can see the post.

anchor: Anchor | null

When kind is ‘insight’, where exactly the insight points back into its origin: an insight source record with character ranges into its fullText, or the native conversation/message/comment/post ids.

commentId?: string | null
conversationId?: string | null
messageId?: string | null
ranges?: Array<Range> | null
end: number
start: number
sourceRecordId?: string | null
submissionId?: string | null
assigneeId: string | null

ID of the admin assigned to this post, null if unassigned

author: PostAuthor { id, email, name, 2 more } | null
id: string | null

Author unique identifier

email: string | null

Author email (if available)

name: string

Author display name

profilePicture: string | null

Author profile picture URL

type: "admin" | "customer" | "guest" | 3 more

Type of user who authored the post

One of the following:
"admin"
"customer"
"guest"
"integration"
"bot"
"lead"
boardId: string

Board (category) ID this post belongs to

commentCount: number

Total number of comments

content: string

Post content in HTML format

createdAt: string

ISO 8601 timestamp when created

customFields: Record<string, unknown>

Custom field values keyed by field ID

eta: string | null

Estimated completion time as ISO 8601 timestamp, null if not set

features: PostFeatures { commentsEnabled }
commentsEnabled: boolean

Whether comments are allowed on this post

groupKey: string | null

When kind is ‘insight’, the triage grouping key (source record id, conversation id, origin post id, or the insight’s own id for singletons). Legacy insights may be null and group as singletons.

inReview: boolean

Whether the post is pending moderation review

insightSource: InsightSource | null

Provenance of an insight: which channel it came from and how it was captured.

channel: "slack" | "discord" | "email" | 5 more
One of the following:
"slack"
"discord"
"email"
"support"
"widget"
"call"
"api"
"feedback"
capturedBy?: "manual" | "auto" | "ai" | "api" | null
One of the following:
"manual"
"auto"
"ai"
"api"
conversationId?: string | null
externalId?: string | null
sourceLabel?: string | null
url?: string | null
integrations: Integrations { clickup, devops, github, 4 more }

Third-party integration links associated with this post

clickup: Array<Clickup>
id: string

ClickUp task ID

title: string

ClickUp task title

url: string

URL to the ClickUp task

devops: Array<Devop>
id: number

Azure DevOps work item ID

projectId: string

Azure DevOps project ID

projectName: string

Azure DevOps project name

title: string

Work item title

url: string

URL to the work item

github: Array<GitHub>
id: string

GitHub issue ID

number: string

GitHub issue number

repositoryFullName: string

Full repository name (owner/repo)

repositoryName: string

Repository name

title: string

GitHub issue title

url: string

URL to the GitHub issue

hubspot: Array<Hubspot>
dealAmount: number | null

Deal amount (for DEAL type)

dealClosed: boolean | null

Whether the deal is closed (for DEAL type)

objectId: number

HubSpot object ID

type: "TICKET" | "DEAL" | "CONTACT"

HubSpot object type

One of the following:
"TICKET"
"DEAL"
"CONTACT"
jira: Array<Jira>
issueId: string

Jira issue ID

issueUrl: string | null

URL to the Jira issue

linear: Array<Linear>
issueId: string

Linear issue ID

issueUrl: string | null

URL to the Linear issue

salesforce: Array<Salesforce>
amount: number | null

Opportunity amount (for Opportunity type)

isClosed: boolean | null

Whether the opportunity is closed (for Opportunity type)

objectId: string

Salesforce record ID

objectType: "Opportunity" | "Case"

Salesforce object type

One of the following:
"Opportunity"
"Case"
isPinned: boolean

Whether the post is pinned to the top

kind: "issue" | "insight" | "record"

Discriminates an actionable work item (‘issue’) from a customer submission whose claims were extracted into insights (‘record’ — not a work item). Defaults to ‘issue’ for all pre-existing posts. Default list responses return issues only; pass kind=‘record’ to opt in. Raw signal (‘insight’) is never returned by the posts resource — insights are served by /v2/insights.

One of the following:
"issue"
"insight"
"record"
linkedInsightCount: number

Number of insights linked to this issue as supporting evidence. Only meaningful when kind is ‘issue’.

linkedIssueId: string | null

When kind is ‘insight’, the ID of the issue this insight supports. Null when the insight is unlinked or when kind is ‘issue’.

object: "post"

Object type identifier

opportunityAmount: number | null

Total opportunity amount from linked HubSpot deals and Salesforce opportunities

portalHidden: boolean

True when the issue is hidden from portal/public surfaces. Missing stored values are returned as false.

postUrl: string

Full URL to view the post

slug: string

URL-friendly slug

status: PostStatus { id, color, isDefault, 3 more }
id: string

Unique identifier

color: string

Color for UI display

isDefault: boolean

Whether this is the default status for new posts

name: string

Display name

object: "post_status"

Object type identifier

type: "reviewing" | "unstarted" | "active" | 2 more

The workflow stage this status represents

One of the following:
"reviewing"
"unstarted"
"active"
"completed"
"canceled"
tags: Array<PostTag { id, color, name } >

Tags attached to this post

id: string

Tag unique identifier

color: string | null

Tag color hex code

name: string

Tag name

title: string

Post title

updatedAt: string

ISO 8601 timestamp when last modified

upvotes: number

Total number of upvotes

deduped?: true

Present and true only on POST /v2/posts, when the request carried a source.externalId that already had a post. The existing post is returned unchanged with HTTP 200; a newly created post returns HTTP 201 without this field.

intakeMode?: "request" | "feedback"

Present only on POST /v2/posts: the intakeMode the post was processed under (‘request’ when the request named none). On an idempotent replay (deduped: true) this is the mode the post was ORIGINALLY created with.

One of the following:
"request"
"feedback"
processing?: PostProcessing { status, reason, results }

On POST /v2/posts — queued: a processing run (claim extraction or the Organize rewrite) was enqueued and its result lands asynchronously on the post. skipped: nothing was enqueued; reason says which gate decided (‘request_mode’ for every intakeMode: ‘request’ create). existing: the create was an idempotent replay and the post was not processed again. On GET /v2/posts/{id} this field is present only for posts created with intakeMode: 'feedback' and reports how far that processing has got (‘queued’, ‘processing’, ‘complete’, ‘needs_review’, or ‘skipped’ with the same reason the create returned), with results listing what was made of the submission once the run has finished.

status: "queued" | "processing" | "complete" | 3 more

‘queued’ = an AI run was enqueued and has not landed yet; ‘processing’ = the run is working on the submission; ‘complete’ = it finished and results lists what it produced; ‘needs_review’ = it finished and a teammate still has to decide something; ‘skipped’ = nothing was enqueued (see reason); ‘existing’ = idempotent replay, not processed again.

One of the following:
"queued"
"processing"
"complete"
"needs_review"
"skipped"
"existing"
reason?: "request_mode" | "autopilot_off" | "insights_disabled" | 11 more

Why processing was skipped. ‘request_mode’ = intakeMode was ‘request’ (the default); ‘autopilot_off’ = the workspace’s Autopilot dial is off or its plan does not include it; ‘pipeline_paused’ = the platform paused AI processing (it resumes automatically); ‘support_board’ / ‘spam_held’ / ‘staff_authored’ / ‘no_content’ = the post did not qualify; ‘source_too_long’ = the text was over the length limit when the run read it (a create that long is normally refused with a 400 first); ‘extraction_failed’ = the AI could not read the text after repeated attempts; nothing was written, and opening the post in Triage runs the analysis again.

One of the following:
"request_mode"
"autopilot_off"
"insights_disabled"
"pipeline_paused"
"support_board"
"spam_held"
"staff_authored"
"not_a_post"
"no_board"
"no_id"
"no_content"
"source_too_long"
"extraction_failed"
"hook_error"
results?: Array<Result>

What the workspace’s “Organize submissions” lane made of this submission, one entry per ask it found, in the order they appear in the text. Present on GET /v2/posts/{id} for posts created with intakeMode: 'feedback' once the run has finished. Absent while the run is still working, and absent for workspaces that do not organize submissions — there the post itself is the request.

outcome: "attached" | "request" | "question" | "held"

‘request’ = the ask became a request of its own; ‘attached’ = it was added as evidence to a request that already existed; ‘held’ = it became a request that is waiting for a teammate to publish it; ‘question’ = it asked something and no request was created, so a teammate answers it.

One of the following:
"attached"
"request"
"question"
"held"
title: string

The ask, as it was written up.

postId?: string

The request this ask became, or was attached to. Absent for a question, and absent when the request is not readable through this API (for example a ticket board).

postTitle?: string

Title of postId.

reason?: "too_many_topics" | "uncertain" | "custom_fields" | "processing_failed"

Why a ‘held’ result is waiting for a teammate. Only on a ‘held’ result, and only one of these codes: ‘too_many_topics’ = the submission held more separate asks than one submission can become requests, so this one request lists the asks that did not fit, one line each in the customer’s words; ‘uncertain’ = the ask was too vague to file without a person; ‘custom_fields’ = the board requires custom fields this submission did not carry; ‘processing_failed’ = the AI could not rewrite the text (the request then holds the original words) or could not check this ask against existing requests, so a teammate confirms it is not a duplicate.

One of the following:
"too_many_topics"
"uncertain"
"custom_fields"
"processing_failed"
nextCursor: string | null

Cursor for fetching the next page (null if no more results)

object: "list"

Object type identifier

totalCount?: number

Total number of posts matching the query, capped at 5000. When the actual total is at or above the cap, totalCountCapped is true and the value is exactly the cap.

totalCountCapped?: boolean

True when totalCount is exactly the cap and the real count may be higher. UI can render as e.g. “5000+”.

PostsVoters

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

List voters on a post
client.feedback.posts.voters.list(stringid, VoterListParams { cursor, limit, featurebaseVersion } params?, RequestOptionsoptions?): CursorPage<VoterListResponse { id, name, object, 16 more } >
GET/v2/posts/{id}/voters
Add a voter to a post
client.feedback.posts.voters.add(stringid, VoterAddParams { id, email, name, 3 more } params, RequestOptionsoptions?): VoterAddResponse { id, added, object, postId }
POST/v2/posts/{id}/voters
Remove a voter from a post
client.feedback.posts.voters.remove(stringid, VoterRemoveParams { id, email, userId, featurebaseVersion } params, RequestOptionsoptions?): VoterRemoveResponse { id, object, postId, removed }
DELETE/v2/posts/{id}/voters
ModelsExpand Collapse
VoterListResponse { id, name, object, 16 more }
id: string

Unique identifier

name: string

User display name

object: "contact"

Object type identifier

type: "admin" | "customer" | "guest" | 3 more

Type of user

One of the following:
"admin"
"customer"
"guest"
"integration"
"bot"
"lead"
commentsCreated?: number

Number of comments created

companies?: Array<Company { id, companyId, companySize, 11 more } >

Companies the user belongs to

id: string

Featurebase internal ID

companyId: string

External company ID from your system

companySize: number | null

Company employee headcount

createdAt: string | null

ISO date when company was created

industry: string | null

Industry

lastActivity: string | null

ISO date of last activity

linkedUsers: number | null

Number of users linked to this company

monthlySpend: number | null

Monthly spend

name: string

Company name

object: "company"

Object type identifier

plan: string | null

Plan or tier name

updatedAt: string | null

ISO date when company was last updated

website: string | null

Company website URL

customFields?: Record<string, unknown>

Custom field values

customFields?: Record<string, unknown>

Custom field values on the user

description?: string

User description/bio

email?: string | null

User email

lastActivity?: string

Last activity ISO timestamp

locale?: string

User locale

manuallyOptedOutFromChangelog?: boolean

Whether manually opted out from changelog

organizationId?: string

Organization ID the user belongs to

postsCreated?: number

Number of posts created

profilePicture?: string | null

Profile picture URL

roles?: Array<string>

User roles

subscribedToChangelog?: boolean

Whether subscribed to changelog

userId?: string

External user ID from SSO

verified?: boolean

Whether email is verified

VoterAddResponse { id, added, object, postId }
id: string

Voter unique identifier

added: true

Indicates the voter was added

object: "voter"

Object type identifier

postId: string

Post ID the voter was added to

VoterRemoveResponse { id, object, postId, removed }
id: string

Voter unique identifier

object: "voter"

Object type identifier

postId: string

Post ID the voter was removed from

removed: true

Indicates the voter was removed

PostsInsights

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

List the insights filed under a request
client.feedback.posts.insights.list(stringid, InsightListParams { cursor, limit, featurebaseVersion } params?, RequestOptionsoptions?): CursorPage<Post { id, access, anchor, 30 more } >
GET/v2/posts/{id}/insights
File a post as an insight under a request
client.feedback.posts.insights.link(stringid, InsightLinkParams { issueId, linkSource, featurebaseVersion } params, RequestOptionsoptions?): Post { id, access, anchor, 30 more }
POST/v2/posts/{id}/link-insight
Detach an insight from its request
client.feedback.posts.insights.unlink(stringid, InsightUnlinkParams { featurebaseVersion } params?, RequestOptionsoptions?): Post { id, access, anchor, 30 more }
POST/v2/posts/{id}/unlink-insight
Promote an insight into a request
client.feedback.posts.insights.convertToPost(stringid, InsightConvertToPostParams { featurebaseVersion } params?, RequestOptionsoptions?): Post { id, access, anchor, 30 more }
POST/v2/posts/{id}/convert-to-issue