Featurebase

App · 20 actions

Manage feedback posts and comments, and read tickets, contacts, companies, and changelogs.

Actions

ActionWhat it does
Create commentCreates a new comment or reply to an existing comment.
Create postCreates a new post (feedback submission) in the specified board.
Delete commentDeletes a comment by its unique identifier.
Delete postPermanently deletes a post.
Get changelogRetrieves a single Changelog by its unique identifier.
Get commentRetrieves a single comment by its unique identifier.
Get contactRetrieves a single contact by their Featurebase ID.
Get conversationRetrieve conversation from Featurebase.
Get postRetrieves a single post by its unique identifier.
Get ticketRetrieves a single ticket by its ticket number.
List boardsReturns all boards (post categories) for the authenticated organization.
List changelogsReturns the Changelogs (release notes) of your organization.
List commentsReturns comments for your organization.
List companiesReturns all companies in your organization with cursor-based pagination.
List contactsReturns a list of contacts (customers and leads) in your organization using cursor-based pagination.
List conversationsReturns a list of conversations in your organization using cursor-based pagination.
List post statusesReturns all post statuses for the authenticated organization.
List postsReturns all posts (feedback submissions) for the authenticated organization.
List ticketsReturns a list of tickets in your organization using cursor-based pagination.
Update postUpdates an existing post.

Create comment

Creates a new comment or reply to an existing comment.

Inputs

ContentcontenttextRequired
Content.
Postpost_idtext
Post ID.
Changelogchangelog_idtext
Changelog ID.
Is privateis_privatetrue/false
Only let admins see the comment.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "content": "example",
    "createdAt": "example",
    "id": "example",
    "postId": "example",
    "updatedAt": "example"
  }
}

Create post

Creates a new post (feedback submission) in the specified board.

Inputs

TitletitletextRequired
Title.
Contentcontenttext
Content.
Boardboard_idtext
Board ID.
Statusstatus_idtext
Status ID.
Etaetadate
Eta.
Tagstagslist
Tags.
Comments enabledcomments_enabledtrue/false
Comments enabled.
Visibilityvisibilitytext
Visibility.One of: public, authorOnly, companyOnly.
Internalinternaltrue/false
Internal.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "board": {
      "id": "example",
      "name": "example"
    },
    "content": "example",
    "createdAt": "example",
    "id": "example",
    "status": {
      "id": "example",
      "name": "example"
    },
    "title": "example",
    "updatedAt": "example"
  }
}

Delete comment

Deletes a comment by its unique identifier.

Inputs

Comment IDcomment_idtextRequired
ID.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "deleted": false,
    "id": "example"
  }
}

Delete post

Permanently deletes a post. This action cannot be undone.

Inputs

Postpost_idtextRequired
ID.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "deleted": false,
    "id": "example"
  }
}

Get changelog

Retrieves a single Changelog by its unique identifier. Supply the id returned by the API, not its public-page slug.

Inputs

Changelogchangelog_idtextRequired
ID.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "createdAt": "example",
    "id": "example",
    "title": "example",
    "updatedAt": "example"
  }
}

Get comment

Retrieves a single comment by its unique identifier.

Inputs

Comment IDcomment_idtextRequired
ID.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "content": "example",
    "createdAt": "example",
    "id": "example",
    "postId": "example",
    "updatedAt": "example"
  }
}

Get contact

Retrieves a single contact by their Featurebase ID.

Inputs

Contact IDcontact_idtextRequired
ID.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "email": "example",
    "id": "example",
    "name": "example"
  }
}

Get conversation

Retrieve conversation from Featurebase.

Inputs

Conversation IDconversation_idtextRequired
ID.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "createdAt": "example",
    "id": "example",
    "title": "example",
    "updatedAt": "example"
  }
}

Get post

Retrieves a single post by its unique identifier.

Inputs

Postpost_idtextRequired
ID.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "board": {
      "id": "example",
      "name": "example"
    },
    "content": "example",
    "createdAt": "example",
    "id": "example",
    "status": {
      "id": "example",
      "name": "example"
    },
    "title": "example",
    "updatedAt": "example"
  }
}

Get ticket

Retrieves a single ticket by its ticket number.

Inputs

Ticket IDticket_idtextRequired
ID.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "createdAt": "example",
    "id": "example",
    "status": {
      "id": "example",
      "name": "example"
    },
    "title": "example",
    "updatedAt": "example"
  }
}

List boards

Returns all boards (post categories) for the authenticated organization.

Inputs

None.

Outputs

datalist
The result returned by Featurebase.
Example output
{
  "data": []
}

List changelogs

Returns the Changelogs (release notes) of your organization.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "data": [],
    "nextCursor": "example"
  }
}

List comments

Returns comments for your organization.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.
Postpost_idtext
Post ID.
Changelogchangelog_idtext
Changelog ID.
Privacyprivacytext
Privacy.One of: public, private, all.
Sort bysort_bytext
Sort by.One of: best, top, new, old.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "data": [],
    "nextCursor": "example"
  }
}

List companies

Returns all companies in your organization with cursor-based pagination.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "data": [],
    "nextCursor": "example"
  }
}

List contacts

Returns a list of contacts (customers and leads) in your organization using cursor-based pagination.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "data": [],
    "nextCursor": "example"
  }
}

List conversations

Returns a list of conversations in your organization using cursor-based pagination.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "data": [],
    "nextCursor": "example"
  }
}

List post statuses

Returns all post statuses for the authenticated organization.

Inputs

None.

Outputs

datalist
The result returned by Featurebase.
Example output
{
  "data": []
}

List posts

Returns all posts (feedback submissions) for the authenticated organization.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.
Boardboard_idtext
Board ID.
Statusstatus_idtext
Status ID.
Search querysearch_querytext
Q.
In reviewin_reviewtrue/false
In review.
Sort bysort_bytext
Sort by.One of: createdAt, upvotes, trending, recent.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "data": [],
    "nextCursor": "example"
  }
}

List tickets

Returns a list of tickets in your organization using cursor-based pagination.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "data": [],
    "nextCursor": "example"
  }
}

Update post

Updates an existing post. Only provided fields will be modified.

Inputs

Postpost_idtextRequired
ID.
Titletitletext
Title.
Contentcontenttext
Content.
Boardboard_idtext
Board ID.
Statusstatus_idtext
Status ID.
Etaetadate
Eta.
Tagstagslist
Tags.
Comments enabledcomments_enabledtrue/false
Comments enabled.
Visibilityvisibilitytext
Visibility.One of: public, authorOnly, companyOnly.

Outputs

dataobject
The result returned by Featurebase.
Example output
{
  "data": {
    "board": {
      "id": "example",
      "name": "example"
    },
    "content": "example",
    "createdAt": "example",
    "id": "example",
    "status": {
      "id": "example",
      "name": "example"
    },
    "title": "example",
    "updatedAt": "example"
  }
}

On this page