Tasks

List Tasks

Returns tasks for a project. Supports filtering by status, priority, tag, assignee, external ID, and date range.

get/api_v2/projects/{project_id}/tasks.json

Request

  • Base URL: https://www.bugherd.com
  • URL: https://www.bugherd.com/api_v2/projects/{project_id}/tasks.json
  • Auth: HTTP basic

Path parameters

project_idinteger required

Query parameters

updated_sincestring date-time

Return tasks updated after this timestamp

created_sincestring date-time

Return tasks created after this timestamp

statusstring

Filter by status name (e.g. todo, doing)

priority'not set' | 'critical' | 'important' | 'normal' | 'minor'
tagstring

Filter by tag name

assigned_to_idinteger
external_idstring
pageinteger

Response

List of tasks

Example response

{
  "tasks": [
    {
      "id": 98765,
      "local_task_id": 42,
      "project_id": 1000,
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z",
      "title": "Button not aligned on mobile",
      "description": "The submit button overlaps the footer on screens under 375px.",
      "status": "todo",
      "status_id": 1,
      "priority": "normal",
      "priority_id": 3,
      "site": "https://www.example.com",
      "url": "/checkout",
      "tag_names": [
        "ui",
        "mobile"
      ],
      "external_id": "JIRA-123",
      "requester_email": "reporter@example.com",
      "attachments": [],
      "screenshot_url": "https://bugherd.com/screenshots/abc.png",
      "secret_link": "https://bugherd.com/tasks/secret/abc123",
      "admin_link": "https://bugherd.com/projects/1000/tasks/42",
      "assigned_to": {
        "id": 4561,
        "email": "jane@example.com",
        "display_name": "Jane Smith",
        "avatar_url": "https://bugherd.com/avatars/jane.png"
      },
      "requester": {
        "id": 4561,
        "email": "jane@example.com",
        "display_name": "Jane Smith",
        "avatar_url": "https://bugherd.com/avatars/jane.png"
      },
      "project_name": "BugHerd",
      "assignee_ids": [],
      "assignees": [
        {
          "id": 4561,
          "email": "jane@example.com",
          "display_name": "Jane Smith",
          "avatar_url": "https://bugherd.com/avatars/jane.png"
        }
      ],
      "requester_id": 851,
      "updater": {
        "id": 4561,
        "email": "jane@example.com",
        "display_name": "Jane Smith",
        "avatar_url": "https://bugherd.com/avatars/jane.png"
      },
      "metadata": {
        "rails_page": "pages#home",
        "user_id": "851"
      },
      "screenshot_data": {
        "screenshot_width": 1214,
        "screenshot_height": 1214,
        "screenshot_pin_x": 633,
        "screenshot_pin_y": 514
      },
      "requester_os": "Mac",
      "requester_browser": "Chrome 26",
      "requester_browser_size": "1214 x 806 px",
      "requester_resolution": "1440 x 900 px",
      "selector_info": {
        "path": "html>body...",
        "html": "<img...>",
        "version": 2
      }
    }
  ],
  "meta": {
    "count": 42
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.