››

Project Creation and Collaboration System

Get Projects

GET /v2/projects/[project_id]

Optional Parameters

project_id - If omitted then a list of projects will be returned.
client_id - Filters by client
due_from - Due date from (yyyymmdd)
due_to - Due date to (yyyymmdd)
created_from - Created date from (yyyymmdd)
created_to - Created date to (yyyymmdd)
tag - Tag
status - Status (open, closed, templates, archived)
limit - Limit number of records returned. Maximum 1000 records
offset - Start position for fetching records
order - Sort order. Valid values are 'projectname', 'duedate', 'progress', 'billablehours', 'latest'

Sample Response - Single Project

{
"data": {
"project_id": "1",
"project_name": "Project 1",
"uri": "https://example.projectbubble.com/viewproject/",
"description": "My very first project",
"color": "",
"tags": "",
"notes": "",
"start_date": "2014-09-01 00:00:00",
"due_date": "2014-09-15 00:00:00",
"ongoing": "0",
"client_id": "1",
"client_name": "Client A",
"currency": "USD",
"billable_hours": "0",
"tracked_seconds": "198",
"estimated_hours": "0",
"hourly_rate": "0",
"fixed_price": "0",
"price": "0",
"project_order": null,
"public": "0",
"active": "0",
"important": "0",
"closed": "0",
"progress": "100",
"notifications": "1",
"recurring": "",
"template": "0",
"archived": "0",
"date_created": "2014-08-14 15:20:10",
"date_modified": "2014-09-23 17:12:26",
"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"
}
],
"teams": [
{
"team_id": "9876",
"team_name": "The A-Team"
}
]
}
}

Sample Response - Multiple Projects

{
"paging": {
"offset": 0,
"limit": 1000,
"total_records": 2
},
"data": [
{
"project_id": "1",
"project_name": "Project 1",
"uri": "https://example.projectbubble.com/viewproject/",
"description": "My very first project",
"color": "",
"tags": "",
"notes": "",
"start_date": "2014-09-01 00:00:00",
"due_date": "2014-09-15 00:00:00",
"ongoing": "0",
"client_id": "1",
"client_name": "Client A",
"currency": "USD",
"billable_hours": "0",
"tracked_seconds": "198",
"estimated_hours": "0",
"hourly_rate": "0",
"fixed_price": "0",
"price": "0",
"project_order": null,
"public": "0",
"active": "0",
"important": "0",
"closed": "0",
"progress": "100",
"notifications": "1",
"recurring": "",
"template": "0",
"archived": "0",
"date_created": "2014-08-14 15:20:10",
"date_modified": "2014-09-23 17:12:26",
"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"
}
],
"teams": [
{
"team_id": "9876",
"team_name": "The A-Team"
}
},
{
"project_id": "2",
"project_name": "Project 2",
"uri": "http://contentdog.projectbubble.dev/viewproject/",
"description": "Vivamus euismod urna. Nullam lobortis quam a felis ullamcorper viverra. Maecenas iaculis aliquet diam. Sed diam lorem, auctor quis,",
"color": "",
"tags": "",
"notes": "",
"start_date": "0000-00-00 00:00:00",
"due_date": "0000-00-00 00:00:00",
"ongoing": "1",
"client_id": "1",
"client_name": "Client A",
"currency": "USD",
"billable_hours": "3",
"tracked_seconds": "10800",
"estimated_hours": "0",
"hourly_rate": "0",
"fixed_price": "0",
"price": "0",
"project_order": null,
"public": "0",
"active": "0",
"important": "0",
"closed": "1",
"progress": "100",
"notifications": "1",
"recurring": "",
"template": "0",
"archived": "0",
"date_created": "2014-08-14 15:20:10",
"date_modified": "2014-09-23 17:14:20",
"user_id": "1234",
"users": [
{
"user_id": "1234",
"user_name": "John Doe"
},
{
"user_id": "1235",
"user_name": "Jane Doe"
},
{
"user_id": "1238",
"user_name": "Jessica Williams"
},
{
"user_id": "1239",
"user_name": "Kimberly Wright"
}
]
}
]
}

Example Calls

Single project

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

Simple list

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

Get 10 projects by due date

curl -X GET "https://api.projectbubble.com/v2/projects?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 projects.

Create Project

POST /v2/projects

Parameters

project_name - Required. Project name
description - Description
tags - Tags
notes - Notes
start_date - Start date (yyyymmdd)
due_date - Due date (yyyymmdd)
client_id - Client ID
currency - Currency
hourly_rate - Hourly rate
fixed_price - Fixed price?
price - Price
project_order - Project order
public - Public?
active - Active? (2 is amber)
important - Important?
closed - Closed?
notifications - Notifications?
recurring - Recurring project. Accepts the following string values:
- D - Daily
- W - Weekly
- M - Monthly
- Q - Quarterly
- S - Semi yearly (Every six months)
- Y - Yearly
template - Template?
user_id - Creator user ID
users - Assigned user IDs
- user_id - User ID
teams - Assigned team IDs
- team_id - Team ID

Sample Response

{
"data": {
"project_id": "10",
"project_name": "My new project",
"uri": "https://example.projectbubble.com/viewproject/",
"description": "Another project",
"color": "",
"tags": "",
"notes": "",
"start_date": "2014-09-01 00:00:00",
"due_date": "2014-09-15 00:00:00",
"ongoing": "0",
"client_id": "1",
"client_name": "Client A",
"currency": "USD",
"billable_hours": "0",
"tracked_seconds": "198",
"estimated_hours": "0",
"hourly_rate": "0",
"fixed_price": "0",
"price": "0",
"project_order": null,
"public": "0",
"active": "0",
"important": "0",
"closed": "0",
"progress": "100",
"notifications": "1",
"recurring": "",
"template": "0",
"archived": "0",
"date_created": "2014-08-14 15:20:10",
"date_modified": "2014-09-23 17:12:26",
"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

Simple Project

Complex example with assigned users and client

curl -X POST "https://api.projectbubble.com/v2/projects" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"\
-H "Content-Type: application/json" \
-d '{"project_name": "Cool new project", \
"description": "Another project", \
"client_id": "1", \
"client_name": "Client A", \
"users": ["1234","1235","1236","1237","1238","1239"]}'

Response Codes

201 - Project created
401 - Permission error. Validation error, see returned text.
400 - Error retrieving created project.

Update Project

PUT /v2/projects/[project_id]

Parameters

project_id - Required. Project ID
project_name - Project name
description - Description
tags - Tags
notes - Notes
start_date - Start date (yyyymmdd)
due_date - Due date (yyyymmdd)
client_id - Client ID
currency - Currency
hourly_rate - Hourly rate
fixed_price - Fixed price?
price - Price
project_order - Project order
public - Public?
active - Active? (2 is amber)
important - Important?
closed - Closed?
notifications - Notifications?
recurring - Recurring project. Accepts the following string values:
- D - Daily
- W - Weekly
- M - Monthly
- Q - Quarterly
- S - Semi yearly (Every six months)
- Y - Yearly
template - Template?
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

Example Call

Change project name

curl -X PUT "https://api.projectbubble.com/v2/projects/10" \
-H "domain: example.projectbubble.com" \
-H "key: 27838413e610417bd866352767fe322ca97d94c8"\
-H "Content-Type: application/json" \
-d '{"project_name": "Exciting new project"}'

Response Codes

200 - Project created
401 - Permission error. Validation error, see returned text.
400 - Error retrieving project.
404 - Project not found.

Delete Project

DELETE /v2/projects/[project_id]

Sample Response

[]

Example Call

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

Response Codes

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