API Documentation

Retrieve all boards for your product.

{
  "data": [
    {
      "id": 1,
      "name": "Feature Requests",
      "description": "Ideas for new features",
      "color": "#4a6cf7",
      "visibility": "public",
      "open_feedbacks_count": 12,
      "created_at": "2026-01-15T10:30:00.000000Z",
      "updated_at": "2026-01-15T10:30:00.000000Z"
    }
  ]
}

Retrieve a single board by ID.

Create a new board.

Update an existing board. All fields are optional.

Delete a board. Returns 204 No Content.

List feedback with optional filtering. Returns paginated results.

GET /api/v2/feedback?status=new&board_id=1&per_page=10

Retrieve a single feedback item with its boards, tags, account, and account user.

Create a new feedback item.

curl -X POST https://usersloop.com/api/v2/feedback \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Add dark mode",
    "details": "Users have been requesting a dark mode option.",
    "status": "new",
    "board_ids": [1],
    "impact": 4
  }'

Update an existing feedback item. All fields are optional.

Delete a feedback item. Returns 204 No Content.

List roadmap items with optional filtering. Returns paginated results.

Retrieve a single roadmap item with its tags and linked feedback.

Create a new roadmap item.

Update an existing roadmap item. All fields are optional.

Delete a roadmap item. Returns 204 No Content.

List updates with optional filtering. Returns paginated results.

Retrieve a single update with its tags, linked feedback, and roadmap items.

Create a new update.

Update an existing update. All fields are optional.

Delete an update. Returns 204 No Content.

List all helpdesk categories with article counts.

{
  "data": [
    {
      "id": 1,
      "name": "Getting Started",
      "slug": "getting-started",
      "description": "Onboarding guides",
      "position": 1,
      "is_public": true,
      "articles_count": 5,
      "created_at": "2026-01-15T10:30:00.000000Z"
    }
  ]
}

Retrieve a single category.

Create a new helpdesk category.

Update an existing category.

Delete a category. Returns 204 No Content.

List articles with optional filtering. Returns paginated results.

Retrieve a single article with its category and tags.

Create a new helpdesk article.

Update an existing article. All fields are optional.

Delete an article. Returns 204 No Content.