This reference summarizes the public Userorbit API action endpoints. All endpoints use POST and JSON request bodies.

Authentication

Authorization: Bearer YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Content-Type: application/json

Feedback

  • feedbacks.create required: title

  • feedbacks.list optional: from, to

  • feedbacks.info required: id

  • feedbacks.update required: id

  • feedbacks.archive, feedbacks.restore, feedbacks.delete, feedbacks.vote required: id

Feedback boards

  • feedback-boards.create required: name

  • feedback-boards.list

  • feedback-boards.info, feedback-boards.update, feedback-boards.delete required: id

Announcements

  • announcements.create required: collectionId, title, text, meta

  • announcements.list optional: from, to

  • announcements.info, announcements.update, announcements.archive, announcements.restore, announcements.pin, announcements.unpin required: id

Announcement collections

  • collections.create required: name

  • collections.list

  • collections.info, collections.update, collections.delete required: id

Roadmaps and topics

  • roadmaps.create required: name

  • roadmaps.list

  • roadmaps.info, roadmaps.update, roadmaps.delete, roadmaps.stages required: id

  • stages.create required: title, roadmapId

  • stages.list required: roadmapId

  • topics.create required: title; optional: roadmapId, stageId, publish, feedbackIds

  • topics.list required: roadmapId, stageId

  • topics.info, topics.update, topics.delete required: id

Help center articles

  • articles.create required: title, text, collectionIds

  • articles.list

  • articles.info, articles.update, articles.publish, articles.unpublish, articles.archive, articles.revisions required: id

  • articles.restore required: id, revisionId

  • article-collections.create required: name

  • article-collections.list

  • article-collections.info, article-collections.update, article-collections.delete required: id

Subscribers, tags, and projects

  • subscribers.create required: email, name, password

  • subscribers.list, subscribers.count, subscribers.search

  • tags.create required: name

  • tags.list

  • projects.create required: name

  • projects.list

Use the matching .info, .update, and .delete actions with id where available.

Was this page helpful?