Tasks List API


 

Get Tasks

GET /v2/tasks/[task_id]

Optional Parameters

  • task_id - If omitted then a list of tasks will be returned.
  • project_id - Filters by project
  • due_from - Due date from (yyyymmdd)
  • due_to - Due date to (yyyymmdd)
  • created_from - Created date from (yyyymmdd)
  • created_to - Created date to (yyyymmdd)
  • completed_from - Completed date from (yyyymmdd)
  • completed_to - Completed date to (yyyymmdd)
  • tag - Tag
  • status - Status (open, completed, active, onhold, inactive, archived)
  • limit - Limit number of records returned. Maximum 1000 records
  • offset - Start position for fetching records

Sample Response - Single Task

{
    "data": {
        "task_id": "1",
        "task_name": "Create project specification",
        "description": "My very first task",
        "color": "",
        "tags": "",
        "notes": "",
        "start_date": "2014-09-01 00:00:00",
        "due_date": "2014-09-15 00:00:00",
        "date_completed": "0000-00-00 00:00:00",
        "ongoing": "0",
        "project_id": "35",
        "project_name": "My first project",
        "billable_hours": 0,
        "tracked_seconds": null,
        "estimated_hours": "0",
        "estimated_cost": "0",
        "hourly_rate": "0",
        "fixed_price": "0",
        "price": "0",
        "task_order": "1415893855",
        "active": "1",
        "important": "0",
        "completed": "0",
        "progress": "0",
        "billed": 0,
        "notifications": "1",
        "recurring": "",
        "archived": "0",
        "date_created": "2014-11-13 15:50:55",
        "date_modified": "2014-11-13 16:54:01",
        "user_id": "1234",
        "users": [
            {
                "user_id": "1234",
                "user_name": "John Doe"
            },
            {
                "user_id": "1235",
                "user_name": "Jane Doe"
            },
            {
                "user_id": "1236",
                "user_name": "John Ross"
            }
        ]
    }
}

Sample Response - Multiple Tasks

{
    "paging": {
        "offset": 0,
        "limit": 1000,
        "total_records": 2
    },
    "data": [
        {
            "task_id": "1",
            "task_name": "Create project specification",
            "description": "My very first task",
            "color": "",
            "tags": "",
            "notes": "",
            "start_date": "2014-09-01 00:00:00",
            "due_date": "2014-09-15 00:00:00",
            "date_completed": "0000-00-00 00:00:00",
            "ongoing": "0",
            "project_id": "35",
            "project_name": "My first project",
            "billable_hours": 0,
            "tracked_seconds": null,
            "estimated_hours": "0",
            "estimated_cost": "0",
            "hourly_rate": "0",
            "fixed_price": "0",
            "price": "0",
            "task_order": "1415893855",
            "active": "1",
            "important": "0",
            "completed": "0",
            "progress": "0",
            "billed": 0,
            "notifications": "1",
            "recurring": "",
            "archived": "0",
            "date_created": "2014-11-13 15:50:55",
            "date_modified": "2014-11-13 16:54:01",
            "user_id": "1234",
            "users": [
                {
                    "user_id": "1234",
                    "user_name": "John Doe"
                },
                {
                    "user_id": "1235",
                    "user_name": "Jane Doe"
                },
                {
                    "user_id": "1236",
                    "user_name": "John Ross"
                }
            ]
        },
        {
            "task_id": "1",
            "task_name": "Create project specification",
            "description": "My very first task",
            "color": "",
            "tags": "",
            "notes": "",
            "start_date": "2014-09-01 00:00:00",
            "due_date": "2014-09-15 00:00:00",
            "date_completed": "0000-00-00 00:00:00",
            "ongoing": "0",
            "project_id": "35",
            "project_name": "My first project",
            "billable_hours": 0,
            "tracked_seconds": null,
            "estimated_hours": "0",
            "estimated_cost": "0",
            "hourly_rate": "0",
            "fixed_price": "0",
            "price": "0",
            "task_order": "1415893855",
            "active": "1",
            "important": "0",
            "completed": "0",
            "progress": "0",
            "billed": 0,
            "notifications": "1",
            "recurring": "",
            "archived": "0",
            "date_created": "2014-11-13 15:50:55",
            "date_modified": "2014-11-13 16:54:01",
            "user_id": "1234",
            "users": [
                {
                    "user_id": "1234",
                    "user_name": "John Doe"
                },
                {
                    "user_id": "1235",
                    "user_name": "Jane Doe"
                },
                {
                    "user_id": "1236",
                    "user_name": "John Ross"
                }
            ]
        }
    ]
}

Example Calls

Single Task

curl -X GET "https://api.projectbubble.com/v2/tasks/1" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"

Simple List

curl -X GET "https://api.projectbubble.com/v2/tasks" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"

Get 10 tasks by due date

curl -X GET "https://api.projectbubble.com/v2/tasks?limit=10&order=duedate" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"

Response Codes

200 - OK or "No records found"
401 - Permission error. Your user account (API Key) does not have permission to access tasks.

Create Task

POST /v2/tasks/[project_id]

Parameters

  • project_id - Required. Project ID
  • task_name - Required. Task name
  • description - Description
  • tags - Tags
  • notes - Notes
  • start_date - Start date (yyyymmdd)
  • due_date - Due date (yyyymmdd)
  • estimated_hours - Estimated hours
  • estimated_cost - Cost
  • hourly_rate - Hourly rate
  • fixed_price - Fixed price?
  • price - Price
  • task_order - Task order
  • active - Active? (2 is amber)
  • important - Important?
  • billed = Billed for?
  • notifications - Notifications?
  • recurring - Recurring task. Accepts the following string values:
    • D - Daily
    • W - Weekly
    • M - Monthly
    • Q - Quarterly
    • S - Semi yearly (Every six months)
    • Y - Yearly
  • archived - Archived?
  • user_id - Creator user ID
  • users - Assigned user IDs
    • user_id - User ID
  • teams - Assigned team IDs
    • team_id - Team ID

Sample Response

{
    "data": {
        "task_id": "1",
        "task_name": "Create project specification",
        "description": "My very first task",
        "color": "",
        "tags": "",
        "notes": "",
        "start_date": "2014-09-01 00:00:00",
        "due_date": "2014-09-15 00:00:00",
        "date_completed": "0000-00-00 00:00:00",
        "ongoing": "0",
        "project_id": "35",
        "project_name": "My first project",
        "billable_hours": 0,
        "tracked_seconds": null,
        "estimated_hours": "0",
        "estimated_cost": "0",
        "hourly_rate": "0",
        "fixed_price": "0",
        "price": "0",
        "task_order": "1415893855",
        "active": "1",
        "important": "0",
        "completed": "0",
        "progress": "0",
        "billed": 0,
        "notifications": "1",
        "recurring": "",
        "archived": "0",
        "date_created": "2014-11-13 15:50:55",
        "date_modified": "2014-11-13 16:54:01",
        "user_id": "1234",
        "users": [
            {
                "user_id": "1234",
                "user_name": "John Doe"
            },
            {
                "user_id": "1235",
                "user_name": "Jane Doe"
            },
            {
                "user_id": "1236",
                "user_name": "John Ross"
            }
        ]
    }
}

Example Call

curl -X POST "https://api.projectbubble.com/v2/tasks/35" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"\
-d '{"task_name": "Create project specification", \
"description": "My very first task", \
"users": ["1234","1235","1236"]}'

Response Codes

201 - Task created
400 - Validation error, see returned text.
401 - Permission error. Your user account (API Key) does not have permission to access tasks.
404 - Task not found

Update Task

PUT /v2/tasks/[task_id]

Parameters

  • task_name - Task name
  • description - Description
  • tags - Tags
  • notes - Notes
  • start_date - Start date (yyyymmdd)
  • due_date - Due date (yyyymmdd)
  • date_completed - Date completed (yyyymmdd)
  • project_id - Project ID
  • minutes - Total minutes tracked
  • hours - Hours (for non-autobill)
  • days - Days (for non-autobill)
  • estimated_hours - Estimated hours
  • estimated_cost - Cost
  • hourly_rate - Hourly rate
  • fixed_price - Fixed price?
  • price - Price
  • task_order - Task order
  • sharing - Sharing?
  • active - Active? (2 is amber)
  • important - Important?
  • completed - !!important!! - All other params are ignored if this is set. See Complete Task
  • resume - !!important!! - All other params are ignored if this is set. See Resume Task
  • progress - Progress (0/100)
  • billed = Billed for?
  • notifications - Notifications?
  • recurring - Recurring task. Accepts the following string values:
    • D - Daily
    • W - Weekly
    • M - Monthly
    • Q - Quarterly
    • S - Semi yearly (Every six months)
    • Y - Yearly
  • archived - Archived?
  • user_id - Creator user ID
  • users - Assigned user IDs
    • user_id - User ID
  • teams - Assigned team IDs
    • team_id - Team ID

Sample Response

{
    "data": {
        "task_id": "1",
        "task_name": "Create project specification",
        "description": "My updated task",
        "color": "",
        "tags": "",
        "notes": "",
        "start_date": "2014-09-01 00:00:00",
        "due_date": "2014-09-15 00:00:00",
        "date_completed": "0000-00-00 00:00:00",
        "ongoing": "0",
        "project_id": "35",
        "project_name": "My first project",
        "billable_hours": 0,
        "tracked_seconds": null,
        "estimated_hours": "0",
        "estimated_cost": "0",
        "hourly_rate": "0",
        "fixed_price": "0",
        "price": "0",
        "task_order": "1415893855",
        "active": "1",
        "important": "0",
        "completed": "0",
        "progress": "0",
        "billed": 0,
        "notifications": "1",
        "recurring": "",
        "archived": "0",
        "date_created": "2014-11-13 15:50:55",
        "date_modified": "2014-11-13 16:54:01",
        "user_id": "1234",
        "users": [
            {
                "user_id": "1234",
                "user_name": "John Doe"
            },
            {
                "user_id": "1235",
                "user_name": "Jane Doe"
            },
            {
                "user_id": "1236",
                "user_name": "John Ross"
            }
        ]
    }
}

Example Call

curl -X PUT "https://api.projectbubble.com/v2/tasks/1" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"\
-d '{"description": "My updated task"}'

Response Codes

200 - Task Updated
400 - Validation error, see returned text.
401 - Permission error. Your user account (API Key) does not have permission to access tasks.
404 - Task not found

Delete Task

DELETE /v2/tasks/[task_id]

Sample Response

[]

Example Call

curl -X DELETE "https://api.projectbubble.com/v2/tasks/1" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"

Response Codes

200 - Task deleted
400/401 - Permission error. Validation error, see returned text.
404 - Task not found.

Complete Task

Completing a task also completes all subtasks.

PUT /v2/tasks/[task_id]/

Required Parameters

  • completed - 1 = complete task

Sample Response

{
    "data": {
        "task_id": "1",
        "task_name": "Create project specification",
        "description": "My updated task",
        "color": "",
        "tags": "",
        "notes": "",
        "start_date": "2014-09-01 00:00:00",
        "due_date": "2014-09-15 00:00:00",
        "date_completed": "0000-00-00 00:00:00",
        "ongoing": "0",
        "project_id": "35",
        "project_name": "My first project",
        "billable_hours": 0,
        "tracked_seconds": null,
        "estimated_hours": "0",
        "estimated_cost": "0",
        "hourly_rate": "0",
        "fixed_price": "0",
        "price": "0",
        "task_order": "1415893855",
        "active": "0",
        "important": "0",
        "completed": "1",
        "progress": "100",
        "billed": 0,
        "notifications": "1",
        "recurring": "",
        "archived": "0",
        "date_created": "2014-11-13 15:50:55",
        "date_modified": "2014-11-13 16:54:01",
        "user_id": "1234",
        "users": [
            {
                "user_id": "1234",
                "user_name": "John Doe"
            },
            {
                "user_id": "1235",
                "user_name": "Jane Doe"
            },
            {
                "user_id": "1236",
                "user_name": "John Ross"
            }
        ]
    }
}

Example Call

curl -X POST "https://api.projectbubble.com/v2/tasks/1" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"\
-d '{"complete": 1}'

Response Codes

200 - Task Updated
400 - Validation error, see returned text.
401 - Permission error. Your user account (API Key) does not have permission to access tasks.
404 - Task not found

Resume Task

Resuming a task does not change the status of subtasks.

PUT /v2/tasks/[task_id]

Required Parameters

  • resume - 1 = resume task

Sample Response

{
    "data": {
        "task_id": "1",
        "task_name": "Create project specification",
        "description": "My updated task",
        "color": "",
        "tags": "",
        "notes": "",
        "start_date": "2014-09-01 00:00:00",
        "due_date": "2014-09-15 00:00:00",
        "date_completed": "0000-00-00 00:00:00",
        "ongoing": "0",
        "project_id": "35",
        "project_name": "My first project",
        "billable_hours": 0,
        "tracked_seconds": null,
        "estimated_hours": "0",
        "estimated_cost": "0",
        "hourly_rate": "0",
        "fixed_price": "0",
        "price": "0",
        "task_order": "1415893855",
        "active": "1",
        "important": "0",
        "completed": "0",
        "progress": "0",
        "billed": 0,
        "notifications": "1",
        "recurring": "",
        "archived": "0",
        "date_created": "2014-11-13 15:50:55",
        "date_modified": "2014-11-13 16:54:01",
        "user_id": "1234",
        "users": [
            {
                "user_id": "1234",
                "user_name": "John Doe"
            },
            {
                "user_id": "1235",
                "user_name": "Jane Doe"
            },
            {
                "user_id": "1236",
                "user_name": "John Ross"
            }
        ]
    }
}

Example Call

curl -X POST "https://api.projectbubble.com/v2/tasks/1" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"\
-d '{"resume": 1}'

Response Codes

200 - Task Updated
400 - Validation error, see returned text.
401 - Permission error. Your user account (API Key) does not have permission to access tasks.
404 - Task not found
Was this information helpful?
Thankyou. Do you want to add anything else?
Thank you.How can we improve this document?
save

The page cannot be found

The page you are looking for might have been removed, had its name changed, or is temporarily unavailable. Please make sure you spelled the page name correctly or use the search box.