Developers | Runrun.it

Checklist Items

GET

/api/v1.0/checklists/:checklist_id/items

List checklist items

Request

Route

GET /api/v1.0/checklists/1/items

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/checklists/1/items" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 120

Body

[
  {
    "id": 1,
    "description": "Paper clips",
    "position": 1,
    "checked": false,
    "checker_id": null,
    "checked_at": null,
    "checklist_id": 1
  }
]

POST

/api/v1.0/checklists/:checklist_id/items

Create a checklist item

Create a new item on a given checklist

Request

Route

POST /api/v1.0/checklists/1/items

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "checklist_item": {
    "description": "Buy more pencils"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/checklists/1/items" -d '{"checklist_item":{"description":"Buy more pencils"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 123

Body

{
  "id": 1,
  "description": "Buy more pencils",
  "position": 1,
  "checked": false,
  "checker_id": null,
  "checked_at": null,
  "checklist_id": 1
}

GET

/api/v1.0/checklists/:checklist_id/items/:id

Show a checklist item

Request

Route

GET /api/v1.0/checklists/1/items/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/checklists/1/items/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 118

Body

{
  "id": 1,
  "description": "Paper clips",
  "position": 1,
  "checked": false,
  "checker_id": null,
  "checked_at": null,
  "checklist_id": 1
}

PUT

/api/v1.0/checklists/:checklist_id/items/:id

Update a checklist item

Update a item on a given checklist

Request

Route

PUT /api/v1.0/checklists/1/items/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "checklist_item": {
    "description": "Buy beer"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/checklists/1/items/1" -d '{"checklist_item":{"description":"Buy beer"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 115

Body

{
  "id": 1,
  "description": "Buy beer",
  "position": 1,
  "checked": false,
  "checker_id": null,
  "checked_at": null,
  "checklist_id": 1
}

DELETE

/api/v1.0/checklists/:checklist_id/items/:id

Destroy a checklist item

Request

Route

DELETE /api/v1.0/checklists/1/items/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/checklists/1/items/1" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Checklists

GET

/api/v1.0/tasks/:task_id/checklist

Show a checklist from a task

Request

Route

GET /api/v1.0/tasks/8/checklist

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/8/checklist" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 95

Body

{
  "id": 1,
  "title": "Office Supplies",
  "creator_id": "coyote-15",
  "task_id": 8,
  "checklist_item_ids": [

  ]
}

PUT

/api/v1.0/tasks/:task_id/checklist

Update a checklist from a task

Request

Route

PUT /api/v1.0/tasks/10/checklist

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "checklist": {
    "title": "Kitchen supplies"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/10/checklist" -d '{"checklist":{"title":"Kitchen supplies"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 97

Body

{
  "id": 1,
  "title": "Kitchen supplies",
  "creator_id": "coyote-19",
  "task_id": 10,
  "checklist_item_ids": [

  ]
}

DELETE

/api/v1.0/tasks/:task_id/checklist

Destroy a checklist from a task

Request

Route

DELETE /api/v1.0/tasks/12/checklist

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/12/checklist" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

GET

/api/v1.0/task_templates/:task_template_id/checklist

Show a checklist from a task template

Request

Route

GET /api/v1.0/task_templates/3/checklist

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/task_templates/3/checklist" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 113

Body

{
  "id": 1,
  "title": "Office Supplies Template",
  "creator_id": "coyote-31",
  "task_template_id": 3,
  "checklist_item_ids": [

  ]
}

PUT

/api/v1.0/task_templates/:task_template_id/checklist

Update a checklist from a task template

Request

Route

PUT /api/v1.0/task_templates/5/checklist

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "checklist": {
    "title": "Kitchen supplies"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/task_templates/5/checklist" -d '{"checklist":{"title":"Kitchen supplies"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 105

Body

{
  "id": 1,
  "title": "Kitchen supplies",
  "creator_id": "coyote-35",
  "task_template_id": 5,
  "checklist_item_ids": [

  ]
}

DELETE

/api/v1.0/task_templates/:task_template_id/checklist

Destroy a checklist from a task_template

Request

Route

DELETE /api/v1.0/task_templates/7/checklist

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/task_templates/7/checklist" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Clients

GET

/api/v1.0/clients

List all clients

Request

Route

GET /api/v1.0/clients

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/clients" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 2

Body

[

]

GET

/api/v1.0/clients/:id

Show a Client

Request

Route

GET /api/v1.0/clients/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	Client ID	integer
name	Client's name	string
is_visible	Client is currently visible to be used	boolean
budgeted_hours_month	Budgeted hours per month	integer
budgeted_cost_month	Budgeted cost per month	decimal
project_groups	[DEPRECATED] Project groups	array

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 138

Body

{
  "id": 1,
  "name": "Test client 22",
  "is_visible": true,
  "budgeted_hours_month": 0,
  "budgeted_cost_month": 0.0,
  "project_groups": [

  ],
  "project_ids": [

  ]
}

POST

/api/v1.0/clients

Create a Client

Parameters

Name	Description	type
clients[name] required	Client's name	string
clients[is_visible] required	Client is currently visible to be used	boolean
clients[budgeted_hours_month] required	Total hours budgeted per month for this client's projects	integer
clients[budgeted_cost_month] required	Total cost budgeted per month for hours spend on this client's projects	decimal

Request

Route

POST /api/v1.0/clients

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "client": {
    "budgeted_cost_month": "0.0",
    "budgeted_hours_month": 0,
    "is_visible": true,
    "name": "Test client 23"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/clients" -d '{"client":{"budgeted_cost_month":"0.0","budgeted_hours_month":0,"is_visible":true,"name":"Test client 23"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 138

Body

{
  "id": 1,
  "name": "Test client 23",
  "is_visible": true,
  "budgeted_hours_month": 0,
  "budgeted_cost_month": 0.0,
  "project_groups": [

  ],
  "project_ids": [

  ]
}

PUT

/api/v1.0/clients/:id

Update a Client

Parameters

Name	Description	type
clients[name] required	Client's name	string
clients[is_visible] required	Client is currently visible to be used	boolean
clients[budgeted_hours_month] required	Total hours budgeted per month for this client's projects	integer
clients[budgeted_cost_month] required	Total cost budgeted per month for hours spend on this client's projects	decimal

Request

Route

PUT /api/v1.0/clients/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "client": {
    "name": "Widgets Inc"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1" -d '{"client":{"name":"Widgets Inc"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 135

Body

{
  "id": 1,
  "name": "Widgets Inc",
  "is_visible": true,
  "budgeted_hours_month": 0,
  "budgeted_cost_month": 0.0,
  "project_groups": [

  ],
  "project_ids": [

  ]
}

Comments

GET

/api/v1.0/tasks/:task_id/comments

List comments on a task

Request

Route

GET /api/v1.0/tasks/22/comments

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/22/comments" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 301

Body

[
  {
    "id": 1,
    "user_id": "coyote-97",
    "is_system_message": false,
    "text": "Comment text",
    "commenter_name": "Coyote 97",
    "children_count": 1,
    "commentable_id": 22,
    "commentable_type": "Task",
    "created_at": "2017-01-17T18:03:14-02:00",
    "task_id": 22,
    "comment_id": null,
    "team_id": null,
    "enterprise_id": null,
    "document_id": null
  }
]

GET

/api/v1.0/comments/:id

Show a specific comment

Request

Route

GET /api/v1.0/comments/2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/comments/2" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 302

Body

{
  "id": 2,
  "user_id": "coyote-101",
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 101",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Comment",
  "created_at": "2017-01-17T18:03:18-02:00",
  "task_id": null,
  "comment_id": 1,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null
}

GET

/api/v1.0/comments/:id/love

Love a specific comment

Request

Route

GET /api/v1.0/comments/1/love

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/comments/1/love" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 348

Body

{
  "id": 1,
  "user_id": "coyote-103",
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 103",
  "children_count": 0,
  "commentable_id": "acme-55",
  "commentable_type": "Enterprise",
  "created_at": "2017-01-17T18:03:20-02:00",
  "task_id": null,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": "acme-55",
  "document_id": null,
  "lover_ids": [
    "coyote-104"
  ]
}

GET

/api/v1.0/comments/:id/unlove

unLove a specific comment

Request

Route

GET /api/v1.0/comments/1/unlove

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/comments/1/unlove" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 336

Body

{
  "id": 1,
  "user_id": "coyote-105",
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 105",
  "children_count": 0,
  "commentable_id": "acme-56",
  "commentable_type": "Enterprise",
  "created_at": "2017-01-17T18:03:21-02:00",
  "task_id": null,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": "acme-56",
  "document_id": null,
  "lover_ids": [

  ]
}

POST

/api/v1.0/tasks/:task_id/comments

Create a new comment

Request

Route

POST /api/v1.0/tasks/24/comments

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "text": "Comment text"
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/24/comments" -d '{"text":"Comment text"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 301

Body

{
  "id": 1,
  "user_id": "coyote-108",
  "is_system_message": false,
  "text": "Comment text",
  "commenter_name": "Coyote 108",
  "children_count": 0,
  "commentable_id": 24,
  "commentable_type": "Task",
  "created_at": "2017-01-17T18:03:24-02:00",
  "task_id": 24,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": null,
  "document_id": null
}

DELETE

/api/v1.0/comments/:id

Destroy a comment

Request

Route

DELETE /api/v1.0/comments/2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/comments/2" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Demanders

GET

/api/v1.0/users/:user_id/demanders

List all demanders of user

Return a list all demanders of user.

Parameters

Name	Description	type
user_id required	User's ID	string

Request

Route

GET /api/v1.0/users/coyote-111/demanders

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/users/coyote-111/demanders" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	User's ID	string
name	User's full name	string
email	User's email	string
avatar_url	User's chosen profile photo	url
avatar_large_url	User's chosen profile photo	url
super_compact_view	internal usage	boolean
compact_side_menu	internal usage	boolean
cost_hour	Current user cost per hour	decimal
is_master	User is an administrator	boolean
is_manager	User is a manager	boolean
can_create_client_project_and_task_types	User has permission to create client, projects and task types	boolean
time_zone	IANA Time Zone Database zone name	string
position	Job position in company	string
on_vacation	User currently on vacation	boolean
birthday	User's birthday	date
phone	User phone	string
gender	User gender	string
marital_status	User marital status	string
in_company_since	Joining date in company	date
is_certified	Whether the user has passed Runrun.it certification	boolean
language	User preference language	string
oid	Constant size ID (internal use only)	string
see_archived_clients_and_projects	Admin decides either to see or not archived clients and projects	boolean
budget_manager	Can edit project extra costs	boolean
shifts	User shifts	array
is_mensurable	Can process RR Ratings?	boolean

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1591

Body

[
  {
    "id": "coyote-111",
    "name": "Coyote 111",
    "email": "coyote111@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_2.png",
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "can_create_client_project_and_task_types": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "49537adb9",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true
  }
]

POST

/api/v1.0/users/:user_id/demanders

Adds a demander to a user

Adds the user represented by demander_id as demander of the user_id

Parameters

Name	Description	type
user_id required	User's ID	string

Request

Route

POST /api/v1.0/users/coyote-113/demanders

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "demander_id": "coyote-114"
}

cURL

curl "https://secure.runrun.it/api/v1.0/users/coyote-113/demanders" -d '{"demander_id":"coyote-114"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1

Body

DELETE

/api/v1.0/users/:user_id/demanders/:id

Destroys a demander of a user

Parameters

Name	Description	type
user_id required	User's ID	string

Request

Route

DELETE /api/v1.0/users/coyote-116/demanders/coyote-115

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/users/coyote-116/demanders/coyote-115" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Description

GET

/api/v1.0/descriptions

Query Multiple Descriptions

Parameters

Name	Description
task_template_ids	IDs of Task Templates if belongs
project_ids	IDs of Projects if belongs

Request

Route

GET /api/v1.0/descriptions?project_ids=1%2C2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

project_ids=1,2

cURL

curl "https://secure.runrun.it/api/v1.0/descriptions?project_ids=1%2C2" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 98

Body

[
  {
    "project_id": 1,
    "description": "Cool Project"
  },
  {
    "project_id": 2,
    "description": "Expensive Project"
  }
]

GET

/api/v1.0/descriptions

Query Single Project Description

Parameters

Name	Description	type
task_template_id	ID of Task Template if belongs to one	integer
project_id	ID of Project if belongs to one	integer

Request

Route

GET /api/v1.0/descriptions?project_id=1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

project_id=1

cURL

curl "https://secure.runrun.it/api/v1.0/descriptions?project_id=1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 45

Body

{
  "project_id": 1,
  "description": "Cool Project"
}

GET

/api/v1.0/descriptions

Query Single Task Template Description

Parameters

Name	Description	type
task_template_id	ID of Task Template if belongs to one	integer
project_id	ID of Project if belongs to one	integer

Request

Route

GET /api/v1.0/descriptions?task_template_id=15

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

task_template_id=15

cURL

curl "https://secure.runrun.it/api/v1.0/descriptions?task_template_id=15" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 52

Body

{
  "task_template_id": 15,
  "description": "Awesome Task"
}

PUT

/api/v1.0/descriptions

Update Project Description

Parameters

Name	Description	type
description[description] required	The text of the description	text

Request

Route

PUT /api/v1.0/descriptions

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "description": {
    "project_id": 1,
    "description": "Another Awesome Project Description"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/descriptions" -d '{"description":{"project_id":1,"description":"Another Awesome Project Description"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 68

Body

{
  "project_id": 1,
  "description": "Another Awesome Project Description"
}

PUT

/api/v1.0/descriptions

Update Task Template Description

Parameters

Name	Description	type
description[description] required	The text of the description	text

Request

Route

PUT /api/v1.0/descriptions

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "description": {
    "task_template_id": 16,
    "description": "Another Awesome Project Description"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/descriptions" -d '{"description":{"task_template_id":16,"description":"Another Awesome Project Description"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 75

Body

{
  "task_template_id": 16,
  "description": "Another Awesome Project Description"
}

Documents

GET

/api/v1.0/tasks/:task_id/documents

List all documents uploaded to a task

Only includes files which have been successfully uploaded. Any files still in the process of being uploaded will not be returned

Request

Route

GET /api/v1.0/tasks/26/documents

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/26/documents" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 210

Body

[
  {
    "id": 1,
    "data_file_name": "arquivo.txt",
    "data_file_size": 10,
    "data_content_type": "text/plain",
    "data_updated_at": "2017-01-17T18:03:46-02:00",
    "uploader_id": null,
    "uploader_name": "João da Silva",
    "transfered": true
  }
]

GET

/api/v1.0/documents/:id

Show a document

Request

Route

GET /api/v1.0/documents/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/documents/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID of document	integer
data_file_name	Name of the document	string
data_file_size	Size in bytes	integer
data_content_type	MIME type of file	string
data_updated_at	When the file was uploaded	datetime
uploader_id	ID of user who uploaded the file	string
uploader_name	Name of user who uploaded the file	string
transfered	Whether the file has be successfully uploaded to the cloud	boolean

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 212

Body

{
  "id": 1,
  "data_file_name": "arquivo.txt",
  "data_file_size": 10,
  "data_content_type": "text/plain",
  "data_updated_at": "2017-01-17T18:03:48-02:00",
  "uploader_id": "coyote-130",
  "uploader_name": "Coyote 130",
  "transfered": true
}

DELETE

/api/v1.0/documents/:id

Destroy a document

Deleting a document is only possible by the original creator and may only be an option for a limited amount of time. Deleting a document will also delete the file from the cloud storage. It is NOT recoverable.

Request

Route

DELETE /api/v1.0/documents/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/documents/1" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

GET

/api/v1.0/documents/download_zip

Download multiple documents as zip

This endpoint will generate a temporary key and redirect you to the download service's URL.

Parameters

Name	Description
ids	List of document's ids to download

Request

Route

GET /api/v1.0/documents/download_zip?ids=1%2C2%2C3

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

ids=1,2,3

cURL

curl "https://secure.runrun.it/api/v1.0/documents/download_zip?ids=1%2C2%2C3" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: text/html; charset=utf-8
Content-Length: 174

Body

<html><body>You are being <a href="https://runrunit-zipper-stg.herokuapp.com?ref=d7934109-272c-4685-b496-0a58c8719422&amp;downloadas=anexos.zip">redirected</a>.</body></html>

Enterprises

GET

/api/v1.0/enterprises/:id

Show details for requesting user's enterprise

Request

Route

GET /api/v1.0/enterprises/acme-77

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/enterprises/acme-77" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID of enterprise	string
name	Name of enterprise	string
phone	Enterprise phone	string
country	Enterprise country	string
company_size	Enterprise size	string
company_sector	Enterprise sector	string
attachments_sum	Total size of all stored documents in bytes	float
remaining_attachment_space	Total space remaining for documents in bytes	float
logo_url	Logo of enterprise	string
alt_id	Constant size ID (internal use only)	string
oid	Constant size ID (internal use only)	string
support_phone	Call this number to contact Runrun.it	string
trial_days_left	Days left to the date of trial period end, if it's a trial plan	date
disabled_reason	Why account is disabled	string
currency_symbol	Currency symbol (ISO 4217)	string
created_at	Enterprise creation date	datetime
master_user_id	ID of the account creator	string
using_temporary_edition	Is enterprise using a temporary edition in subscription?	boolean
temporary_edition_expiration	Date when the temporary edition will expire	datetime
signup_completed	True if signup completed	boolean
time_zone	Enterprise time zone	string
plan[id]	ID of plan	integer
plan[name_pt]	Plan name in Portuguese	string
plan[name_en]	Plan name in English	string
plan[max_storage]	Total available size for documents in bytes	float
plan[max_users]	Total number of users which can be active	integer
plan[is_free]	Is a free plan?	boolean
plan[is_trial]	Is a trial plan?	boolean
plan[can_use_mobile]	Can use mobile?	boolean

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 716

Body

{
  "id": "acme-77",
  "name": "Acme 77",
  "phone": null,
  "country": null,
  "company_size": null,
  "company_sector": "technology",
  "attachments_sum": 0.0,
  "remaining_attachment_space": 524288000.0,
  "logo_url": "/logos/small/missing.png",
  "alt_id": "c36665805a2343c2fe25183ce2afbc15",
  "oid": "49537adb9",
  "support_phone": "+55 11 2769-9713",
  "trial_days_left": null,
  "disabled_reason": null,
  "currency_symbol": "USD",
  "created_at": "2017-01-17T18:03:57-02:00",
  "master_user_id": null,
  "using_temporary_edition": true,
  "temporary_edition_expiration": null,
  "signup_completed": true,
  "time_zone": "America/Sao_Paulo",
  "plan": {
    "id": 1,
    "name_pt": "Plano 5",
    "name_en": "Plan 5",
    "max_storage": 524288000.0,
    "max_users": 5,
    "is_free": true,
    "is_trial": false,
    "can_use_mobile": false
  }
}

GET

/api/v1.0/enterprises/:id

Show details for requesting user's enterprise

Request

Route

GET /api/v1.0/enterprises/acme-77

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/enterprises/acme-77" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID of enterprise	string
name	Name of enterprise	string
phone	Enterprise phone	string
country	Enterprise country	string
company_size	Enterprise size	string
company_sector	Enterprise sector	string
attachments_sum	Total size of all stored documents in bytes	float
remaining_attachment_space	Total space remaining for documents in bytes	float
logo_url	Logo of enterprise	string
alt_id	Constant size ID (internal use only)	string
oid	Constant size ID (internal use only)	string
support_phone	Call this number to contact Runrun.it	string
trial_days_left	Days left to the date of trial period end, if it's a trial plan	date
disabled_reason	Why account is disabled	string
currency_symbol	Currency symbol (ISO 4217)	string
created_at	Enterprise creation date	datetime
master_user_id	ID of the account creator	string
using_temporary_edition	Is enterprise using a temporary edition in subscription?	boolean
temporary_edition_expiration	Date when the temporary edition will expire	datetime
signup_completed	True if signup completed	boolean
time_zone	Enterprise time zone	string
plan[id]	ID of plan	integer
plan[name_pt]	Plan name in Portuguese	string
plan[name_en]	Plan name in English	string
plan[max_storage]	Total available size for documents in bytes	float
plan[max_users]	Total number of users which can be active	integer
plan[is_free]	Is a free plan?	boolean
plan[is_trial]	Is a trial plan?	boolean
plan[can_use_mobile]	Can use mobile?	boolean

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 716

Body

{
  "id": "acme-77",
  "name": "Acme 77",
  "phone": null,
  "country": null,
  "company_size": null,
  "company_sector": "technology",
  "attachments_sum": 0.0,
  "remaining_attachment_space": 524288000.0,
  "logo_url": "/logos/small/missing.png",
  "alt_id": "c36665805a2343c2fe25183ce2afbc15",
  "oid": "49537adb9",
  "support_phone": "+55 11 2769-9713",
  "trial_days_left": null,
  "disabled_reason": null,
  "currency_symbol": "USD",
  "created_at": "2017-01-17T18:03:57-02:00",
  "master_user_id": null,
  "using_temporary_edition": true,
  "temporary_edition_expiration": null,
  "signup_completed": true,
  "time_zone": "America/Sao_Paulo",
  "plan": {
    "id": 1,
    "name_pt": "Plano 5",
    "name_en": "Plan 5",
    "max_storage": 524288000.0,
    "max_users": 5,
    "is_free": true,
    "is_trial": false,
    "can_use_mobile": false
  }
}

PUT

/api/v1.0/enterprises/:id

Update enterprise

Parameters

Name	Description	type
enterprise[id] required	ID of enterprise	string

Request

Route

PUT /api/v1.0/enterprises/acme-78

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "enterprise": {
    "name": "New name"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/enterprises/acme-78" -d '{"enterprise":{"name":"New name"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 717

Body

{
  "id": "acme-78",
  "name": "New name",
  "phone": null,
  "country": null,
  "company_size": null,
  "company_sector": "technology",
  "attachments_sum": 0.0,
  "remaining_attachment_space": 524288000.0,
  "logo_url": "/logos/small/missing.png",
  "alt_id": "04361f7a0a8480fb35997dcb5f6bd3e0",
  "oid": "49537adb9",
  "support_phone": "+55 11 2769-9713",
  "trial_days_left": null,
  "disabled_reason": null,
  "currency_symbol": "USD",
  "created_at": "2017-01-17T18:03:59-02:00",
  "master_user_id": null,
  "using_temporary_edition": true,
  "temporary_edition_expiration": null,
  "signup_completed": true,
  "time_zone": "America/Sao_Paulo",
  "plan": {
    "id": 1,
    "name_pt": "Plano 5",
    "name_en": "Plan 5",
    "max_storage": 524288000.0,
    "max_users": 5,
    "is_free": true,
    "is_trial": false,
    "can_use_mobile": false
  }
}

Estimates

GET

/api/v1.0/tasks/:task_id/estimates

Show all the estimatives for a task.

"Show the all the estimatives for a task."

Request

Route

GET /api/v1.0/tasks/1/estimates

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/1/estimates" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 306

Body

[
  {
    "id": 1,
    "task_id": 1,
    "work_seconds": 9420,
    "created_at": "2017-01-17T18:04:01-02:00",
    "is_standard": true
  },
  {
    "id": 2,
    "task_id": 1,
    "work_seconds": 3600,
    "created_at": "2017-01-17T18:04:01-02:00",
    "is_standard": false
  },
  {
    "id": 3,
    "task_id": 1,
    "work_seconds": 7200,
    "created_at": "2017-01-17T18:04:01-02:00",
    "is_standard": false
  }
]

POST

/api/v1.0/tasks/:task_id/estimates

Create a estimative for a task.

"Create a estimate for a task."

Request

Route

POST /api/v1.0/tasks/1/estimates

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "estimate": {
    "task_id": 1,
    "work_seconds": "9000"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/1/estimates" -d '{"estimate":{"task_id":1,"work_seconds":"9000"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 101

Body

{
  "id": 3,
  "task_id": 1,
  "work_seconds": 9000,
  "created_at": "2017-01-17T18:04:04-02:00",
  "is_standard": false
}

Filters

GET

/api/v1.0/projects/filters

List all projects filters

List all projects filters that the current user can view.

Request

Route

GET /api/v1.0/projects/filters

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/projects/filters" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 834

Body

[
  {
    "id": "all",
    "name": "all",
    "status": "all",
    "conditions": [

    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": true,
    "preset": true
  },
  {
    "id": "open",
    "name": "open",
    "status": "open",
    "conditions": [

    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "closed",
    "name": "closed",
    "status": "closed",
    "conditions": [

    ],
    "sort": {
      "column_id": "close_date",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": 1,
    "name": "Amazing Projects",
    "status": "closed",
    "conditions": [
      {
        "column_id": "desired_date",
        "operator": "up_to",
        "value": "2016-10-02",
        "valid": true
      },
      {
        "column_id": "budgeted_cost",
        "operator": "greater_than",
        "value": "1000",
        "valid": false
      }
    ],
    "sort": {
      "column_id": "desired_date",
      "dir": "desc",
      "valid": true
    },
    "valid": false,
    "default": false,
    "preset": false
  }
]

GET

/api/v1.0/projects/filters/:id

Show a project filter

Request

Route

GET /api/v1.0/projects/filters/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/projects/filters/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 341

Body

{
  "id": 1,
  "name": "Amazing Projects",
  "status": "closed",
  "conditions": [
    {
      "column_id": "desired_date",
      "operator": "up_to",
      "value": "2016-10-02",
      "valid": true
    },
    {
      "column_id": "budgeted_cost",
      "operator": "greater_than",
      "value": "1000",
      "valid": false
    }
  ],
  "sort": {
    "column_id": "desired_date",
    "dir": "desc",
    "valid": true
  },
  "valid": false,
  "default": false,
  "preset": false
}

POST

/api/v1.0/projects/filters

Create a project filter

Create a new filter record.

Parameters

Name	Description	type
filter[name] required	Filter name	string

Request

Route

POST /api/v1.0/projects/filters

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "filter": {
    "name": "Failing projects",
    "status": "closed",
    "conditions": [
      {
        "column_id": "start_date",
        "operator": "up_to",
        "value": "2016-10-02"
      },
      {
        "column_id": "tasks_count",
        "operator": "greater_than",
        "value": "2"
      }
    ]
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/projects/filters" -d '{"filter":{"name":"Failing projects","status":"closed","conditions":[{"column_id":"start_date","operator":"up_to","value":"2016-10-02"},{"column_id":"tasks_count","operator":"greater_than","value":"2"}]}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 294

Body

{
  "id": 1,
  "name": "Failing projects",
  "status": "closed",
  "conditions": [
    {
      "column_id": "start_date",
      "operator": "up_to",
      "value": "2016-10-02",
      "valid": true
    },
    {
      "column_id": "tasks_count",
      "operator": "greater_than",
      "value": "2",
      "valid": true
    }
  ],
  "sort": {
    "valid": false
  },
  "valid": false,
  "default": false,
  "preset": false
}

PUT

/api/v1.0/projects/filters/:id

Update a project filter

Update a filter record.

Request

Route

PUT /api/v1.0/projects/filters/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "filter": {
    "name": "Another name"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/projects/filters/1" -d '{"filter":{"name":"Another name"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 337

Body

{
  "id": 1,
  "name": "Another name",
  "status": "closed",
  "conditions": [
    {
      "column_id": "desired_date",
      "operator": "up_to",
      "value": "2016-10-02",
      "valid": true
    },
    {
      "column_id": "budgeted_cost",
      "operator": "greater_than",
      "value": "1000",
      "valid": false
    }
  ],
  "sort": {
    "column_id": "desired_date",
    "dir": "desc",
    "valid": true
  },
  "valid": false,
  "default": false,
  "preset": false
}

DELETE

/api/v1.0/projects/filters/:id

Destroy a project filter

Destroy a filter record.

Request

Route

DELETE /api/v1.0/projects/filters/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/projects/filters/1" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

GET

/api/v1.0/tasks/filters

List all tasks filters

List all tasks filters that the current user can view.

Request

Route

GET /api/v1.0/tasks/filters

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/filters" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1697

Body

[
  {
    "id": "all",
    "name": "all",
    "status": "all",
    "conditions": [

    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": true,
    "preset": true
  },
  {
    "id": "delivered_in_the_last_7_days",
    "name": "delivered_in_the_last_7_days",
    "status": "all",
    "conditions": [
      {
        "column_id": "close_date",
        "operator": "in_the_last",
        "value": "seven_days",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is",
        "value": "closed",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "close_date",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "estimated_delivery_in_the_next_7_days",
    "name": "estimated_delivery_in_the_next_7_days",
    "status": "all",
    "conditions": [
      {
        "column_id": "close_date",
        "operator": "in_the_next",
        "value": "seven_days",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is_not",
        "value": "closed",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "working_on",
    "name": "working_on",
    "status": "all",
    "conditions": [
      {
        "column_id": "state",
        "operator": "is",
        "value": "working_on",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "activities",
      "dir": "desc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": "overdue",
    "name": "overdue",
    "status": "all",
    "conditions": [
      {
        "column_id": "overdue",
        "operator": "is",
        "value": "hard_overdue",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "desired_date",
      "dir": "asc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": true
  },
  {
    "id": 1,
    "name": "Amazing Tasks",
    "status": "all",
    "conditions": [
      {
        "column_id": "title",
        "operator": "contains",
        "value": "Test",
        "valid": true
      },
      {
        "column_id": "state",
        "operator": "is",
        "value": "queued",
        "valid": true
      }
    ],
    "sort": {
      "column_id": "title",
      "dir": "asc",
      "valid": true
    },
    "valid": true,
    "default": false,
    "preset": false
  }
]

GET

/api/v1.0/tasks/filters/:id

Show a task filter

Request

Route

GET /api/v1.0/tasks/filters/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/filters/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 299

Body

{
  "id": 1,
  "name": "Amazing Tasks",
  "status": "all",
  "conditions": [
    {
      "column_id": "title",
      "operator": "contains",
      "value": "Test",
      "valid": true
    },
    {
      "column_id": "state",
      "operator": "is",
      "value": "queued",
      "valid": true
    }
  ],
  "sort": {
    "column_id": "title",
    "dir": "asc",
    "valid": true
  },
  "valid": true,
  "default": false,
  "preset": false
}

POST

/api/v1.0/tasks/filters

Create a task filter

Create a new filter record.

Parameters

Name	Description	type
filter[name] required	Filter name	string

Request

Route

POST /api/v1.0/tasks/filters

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "filter": {
    "name": "Test tasks",
    "status": "all",
    "conditions": [
      {
        "column_id": "title",
        "operator": "contains",
        "value": "Teste"
      }
    ],
    "sort": {
      "column_id": "title",
      "dir": "desc"
    }
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/filters" -d '{"filter":{"name":"Test tasks","status":"all","conditions":[{"column_id":"title","operator":"contains","value":"Teste"}],"sort":{"column_id":"title","dir":"desc"}}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 230

Body

{
  "id": 1,
  "name": "Test tasks",
  "status": "all",
  "conditions": [
    {
      "column_id": "title",
      "operator": "contains",
      "value": "Teste",
      "valid": true
    }
  ],
  "sort": {
    "column_id": "title",
    "dir": "desc",
    "valid": true
  },
  "valid": true,
  "default": false,
  "preset": false
}

PUT

/api/v1.0/tasks/filters/:id

Update a task filter

Update a filter record.

Request

Route

PUT /api/v1.0/tasks/filters/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "filter": {
    "name": "Another name"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/filters/1" -d '{"filter":{"name":"Another name"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 298

Body

{
  "id": 1,
  "name": "Another name",
  "status": "all",
  "conditions": [
    {
      "column_id": "title",
      "operator": "contains",
      "value": "Test",
      "valid": true
    },
    {
      "column_id": "state",
      "operator": "is",
      "value": "queued",
      "valid": true
    }
  ],
  "sort": {
    "column_id": "title",
    "dir": "asc",
    "valid": true
  },
  "valid": true,
  "default": false,
  "preset": false
}

DELETE

/api/v1.0/tasks/filters/:id

Destroy a task filter

Destroy a filter record.

Request

Route

DELETE /api/v1.0/tasks/filters/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/filters/1" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Manual Work Periods

GET

/api/v1.0/manual_work_periods

List all manual work periods

List all manual work periods. If a user_id and/or task_id is supplied, only work periods for the given user and/or task will be returned. from and before can be used to specify a date window, in this resource, the time and timezone if provided, will be ignored. The default period is 1 month if not specified.

Parameters

Name	Description	type
manual_work_period[task_id]	ID of related task	integer
manual_work_period[user_id]	ID of user who did the work	string
manual_work_period[from]
manual_work_period[before]

Request

Route

GET /api/v1.0/manual_work_periods?task_id=32

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

task_id=32

cURL

curl "https://secure.runrun.it/api/v1.0/manual_work_periods?task_id=32" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 153

Body

[
  {
    "id": 1,
    "task_id": 32,
    "seconds": 1000,
    "date_to_apply": "2017-01-17",
    "worker_name": "Coyote 155",
    "user_id": "coyote-155",
    "team_id": null,
    "task_state_id": null
  }
]

GET

/api/v1.0/manual_work_periods/:id

Show a Manual Work Period

Request

Route

GET /api/v1.0/manual_work_periods/1?task_id=33

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

task_id=33

cURL

curl "https://secure.runrun.it/api/v1.0/manual_work_periods/1?task_id=33" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID	integer
task_id	ID of related task	integer
seconds	Time added in seconds	integer
date_to_apply	Date time was worked	date
worker_name	Name of user who did the work	string
user_id	ID of user who did the work	string
team_id	ID of team associated to user who did the work	integer
task_state_id	ID of state associated to the manual work period	integer

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 151

Body

{
  "id": 1,
  "task_id": 33,
  "seconds": 1000,
  "date_to_apply": "2017-01-17",
  "worker_name": "Coyote 157",
  "user_id": "coyote-157",
  "team_id": null,
  "task_state_id": null
}

POST

/api/v1.0/manual_work_periods

Create a Manual Work Period

Create a record that additional time was worked on a given task, by a given user on a specific team and task state, on a specific day.

Parameters

Name	Description	type
manual_work_period[task_id] required	ID of related task	integer
manual_work_period[user_id] required	ID of user who did the work	string
manual_work_period[team_id] required	ID of team associated to user who did the work	integer
manual_work_period[task_state_id] required	ID of state associated to the manual work period	integer
manual_work_period[date_to_apply] required	Date time was worked	date
manual_work_period[seconds] required	Time added in seconds	integer

Request

Route

POST /api/v1.0/manual_work_periods

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "manual_work_period": {
    "date_to_apply": "2017-01-17",
    "seconds": 3600,
    "task_id": 34,
    "task_state_id": null,
    "team_id": null,
    "user_id": 1
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/manual_work_periods" -d '{"manual_work_period":{"date_to_apply":"2017-01-17","seconds":3600,"task_id":34,"task_state_id":null,"team_id":null,"user_id":1}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 151

Body

{
  "id": 1,
  "task_id": 34,
  "seconds": 3600,
  "date_to_apply": "2017-01-17",
  "worker_name": "Coyote 159",
  "user_id": "coyote-159",
  "team_id": null,
  "task_state_id": null
}

PUT

/api/v1.0/manual_work_periods/:id

Update a Manual Work Period

After creation the only updateable field is seconds. In general, it is better to delete and create a new Manual Work Period rather than update an existing one.

Parameters

Name	Description	type
manual_work_period[seconds] required	Time added in seconds	integer

Request

Route

PUT /api/v1.0/manual_work_periods/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_id": 35,
  "manual_work_periods": {
    "seconds": 2000
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/manual_work_periods/1" -d '{"task_id":35,"manual_work_periods":{"seconds":2000}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 151

Body

{
  "id": 1,
  "task_id": 35,
  "seconds": 2000,
  "date_to_apply": "2017-01-17",
  "worker_name": "Coyote 161",
  "user_id": "coyote-161",
  "team_id": null,
  "task_state_id": null
}

DELETE

/api/v1.0/manual_work_periods/:id

Destroy a Manual Work Period

Request

Route

DELETE /api/v1.0/manual_work_periods/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_id": 36
}

cURL

curl "https://secure.runrun.it/api/v1.0/manual_work_periods/1" -d '{"task_id":36}' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Holidays

GET

/api/v1.0/off_days

List all Holidays

Request

Route

GET /api/v1.0/off_days

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/off_days" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 117

Body

[
  {
    "id": 1,
    "day": "2017-01-18",
    "description": "Developer Day"
  },
  {
    "id": 2,
    "day": "2017-01-19",
    "description": "Ice Cream Day"
  }
]

GET

/api/v1.0/off_days/:id

Show a Holiday

Request

Route

GET /api/v1.0/off_days/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/off_days/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID of the holiday	integer
day	Date the holiday occurs on	date
description	Name/description of holiday	string

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 58

Body

{
  "id": 1,
  "day": "2017-01-20",
  "description": "City holiday 1"
}

POST

/api/v1.0/off_days

Create a Holiday

Create a holiday. Holidays occurring in the past cannot be created (i.e. holidays where day is before today). Only account admininstrators can create holidays.

Parameters

Name	Description	type
off_day[day] required	Date the holiday occurs on	date
off_day[description] required	Name/description of holiday	string

Request

Route

POST /api/v1.0/off_days

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "off_day": {
    "day": "2017-01-21",
    "description": "City holiday 2"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/off_days" -d '{"off_day":{"day":"2017-01-21","description":"City holiday 2"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 58

Body

{
  "id": 1,
  "day": "2017-01-21",
  "description": "City holiday 2"
}

PUT

/api/v1.0/off_days/:id

Update a Holiday

Update a holiday. Updating the day value is best done as a destroy followed by a create. Only account administrators can perform this action.

Parameters

Name	Description	type
off_days[description]	Name/description of holiday	string

Request

Route

PUT /api/v1.0/off_days/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "off_day": {
    "description": "Developer Day"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/off_days/1" -d '{"off_day":{"description":"Developer Day"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 57

Body

{
  "id": 1,
  "day": "2017-01-22",
  "description": "Developer Day"
}

DELETE

/api/v1.0/off_days/:id

Destroy a Holiday

Destroy a holiday. Only account administrators can perform this action.

Request

Route

DELETE /api/v1.0/off_days/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/off_days/1" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Partners

GET

/api/v1.0/users/:user_id/partners

List all partners of user

Return a list of all partners of user. Partners of a user are users that the user can assign tasks to.

Parameters

Name	Description	type
user_id required	User's ID	string

Request

Route

GET /api/v1.0/users/coyote-188/partners

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/users/coyote-188/partners" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	User's ID	string
name	User's full name	string
email	User's email	string
avatar_url	User's chosen profile photo	url
avatar_large_url	User's chosen profile photo	url
super_compact_view	internal usage	boolean
compact_side_menu	internal usage	boolean
cost_hour	Current user cost per hour	decimal
is_master	User is an administrator	boolean
is_manager	User is a manager	boolean
can_create_client_project_and_task_types	User has permission to create client, projects and task types	boolean
time_zone	IANA Time Zone Database zone name	string
position	Job position in company	string
on_vacation	User currently on vacation	boolean
birthday	User's birthday	date
phone	User phone	string
gender	User gender	string
marital_status	User marital status	string
in_company_since	Joining date in company	date
is_certified	Whether the user has passed Runrun.it certification	boolean
language	User preference language	string
oid	Constant size ID (internal use only)	string
see_archived_clients_and_projects	Admin decides either to see or not archived clients and projects	boolean
budget_manager	Can edit project extra costs	boolean
shifts	User shifts	array
is_mensurable	Can process RR Ratings?	boolean

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1591

Body

[
  {
    "id": "coyote-188",
    "name": "Coyote 188",
    "email": "coyote175@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_2.png",
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "can_create_client_project_and_task_types": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "49537adb9",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true
  }
]

POST

/api/v1.0/users/:user_id/partners

Adds a partner to a user

Adds the user represented by partner_id as partner of the user_id

Parameters

Name	Description	type
user_id required	User's ID	string

Request

Route

POST /api/v1.0/users/coyote-190/partners

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "partner_id": "coyote-191"
}

cURL

curl "https://secure.runrun.it/api/v1.0/users/coyote-190/partners" -d '{"partner_id":"coyote-191"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1

Body

DELETE

/api/v1.0/users/:user_id/partners/:id

Destroy a partner of a user

Parameters

Name	Description	type
user_id required	User's ID	string

Request

Route

DELETE /api/v1.0/users/coyote-192/partners/coyote-193

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/users/coyote-192/partners/coyote-193" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Posts

GET

/api/v1.0/posts/unseen_activities

Get unseen post activities

This endpoint will return a data representation for each bulletin board containing the ID of the team, and the number of unread items. The only exception is the enterprise board where the id string: "enterprise".

Request

Route

GET /api/v1.0/posts/unseen_activities

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/posts/unseen_activities" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID of item	integer
count	Amount of unread items	integer

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 31

Body

[
  {
    "id": "enterprise",
    "count": 0
  }
]

GET

/api/v1.0/posts/enterprise

Get all posts for a enterprise

Request

Route

GET /api/v1.0/posts/enterprise

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/posts/enterprise" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	Id of the comment	integer
user_id	Id of the comment creator	string
is_system_message	Flag saying if it is a system comment	boolean
text	The actual text of the comment	text
commenter_name	The name of the creator	string
children_count	Amount of replies in this comment	integer
commentable_id	[Deprecated] The commentable id	string
commentable_type	[Deprecated] To which resource type does this comment belongs	string
created_at	Datetime the comment has been made	datetime
task_id	Id of task which the comment belong to	string
comment_id	Id of comment which the comment belong to	integer
team_id	Id of team which the comment belong to	integer
enterprise_id	Id of enterprise which the comment belong to	string
document_id	Id of referenced document (used by system messages)	integer

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 345

Body

[
  {
    "id": 1,
    "user_id": "coyote-195",
    "is_system_message": false,
    "text": "A enterprise post",
    "commenter_name": "Coyote 195",
    "children_count": 0,
    "commentable_id": "acme-126",
    "commentable_type": "Enterprise",
    "created_at": "2017-01-17T18:05:20-02:00",
    "task_id": null,
    "comment_id": null,
    "team_id": null,
    "enterprise_id": "acme-126",
    "document_id": null,
    "lover_ids": [

    ]
  }
]

POST

/api/v1.0/posts/enterprise

Create a new post for a enterprise

Parameters

Name	Description	type
text required	The text you want to post	text

Request

Route

POST /api/v1.0/posts/enterprise

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "text": "A message"
}

cURL

curl "https://secure.runrun.it/api/v1.0/posts/enterprise" -d '{"text":"A message"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 335

Body

{
  "id": 1,
  "user_id": "coyote-197",
  "is_system_message": false,
  "text": "A message",
  "commenter_name": "Coyote 197",
  "children_count": 0,
  "commentable_id": "acme-127",
  "commentable_type": "Enterprise",
  "created_at": "2017-01-17T18:05:22-02:00",
  "task_id": null,
  "comment_id": null,
  "team_id": null,
  "enterprise_id": "acme-127",
  "document_id": null,
  "lover_ids": [

  ]
}

GET

/api/v1.0/posts/teams/:team_id

Get all posts for a team

Parameters

Name	Description	type
team_id required	The desired team_id	integer
text required	The text you want to post	text

Request

Route

GET /api/v1.0/posts/teams/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/posts/teams/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	Id of the comment	integer
user_id	Id of the comment creator	string
is_system_message	Flag saying if it is a system comment	boolean
text	The actual text of the comment	text
commenter_name	The name of the creator	string
children_count	Amount of replies in this comment	integer
commentable_id	[Deprecated] The commentable id	string
commentable_type	[Deprecated] To which resource type does this comment belongs	string
created_at	Datetime the comment has been made	datetime
task_id	Id of task which the comment belong to	string
comment_id	Id of comment which the comment belong to	integer
team_id	Id of team which the comment belong to	integer
enterprise_id	Id of enterprise which the comment belong to	string
document_id	Id of referenced document (used by system messages)	integer

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 315

Body

[
  {
    "id": 1,
    "user_id": "coyote-198",
    "is_system_message": false,
    "text": "A team post",
    "commenter_name": "Coyote 198",
    "children_count": 0,
    "commentable_id": 1,
    "commentable_type": "Team",
    "created_at": "2017-01-17T18:05:24-02:00",
    "task_id": null,
    "comment_id": null,
    "team_id": 1,
    "enterprise_id": null,
    "document_id": null,
    "lover_ids": [

    ]
  }
]

POST

/api/v1.0/posts/teams/:team_id

Create a new post for a team

Parameters

Name	Description	type
team_id required	The desired team_id	integer
text required	The text you want to post	text

Request

Route

POST /api/v1.0/posts/teams/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "text": "A message"
}

cURL

curl "https://secure.runrun.it/api/v1.0/posts/teams/1" -d '{"text":"A message"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	Id of the comment	integer
user_id	Id of the comment creator	string
is_system_message	Flag saying if it is a system comment	boolean
text	The actual text of the comment	text
commenter_name	The name of the creator	string
children_count	Amount of replies in this comment	integer
commentable_id	[Deprecated] The commentable id	string
commentable_type	[Deprecated] To which resource type does this comment belongs	string
created_at	Datetime the comment has been made	datetime
task_id	Id of task which the comment belong to	string
comment_id	Id of comment which the comment belong to	integer
team_id	Id of team which the comment belong to	integer
enterprise_id	Id of enterprise which the comment belong to	string
document_id	Id of referenced document (used by system messages)	integer

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 311

Body

{
  "id": 1,
  "user_id": "coyote-201",
  "is_system_message": false,
  "text": "A message",
  "commenter_name": "Coyote 201",
  "children_count": 0,
  "commentable_id": 1,
  "commentable_type": "Team",
  "created_at": "2017-01-17T18:05:26-02:00",
  "task_id": null,
  "comment_id": null,
  "team_id": 1,
  "enterprise_id": null,
  "document_id": null,
  "lover_ids": [

  ]
}

Prerequisites

GET

/api/v1.0/tasks/:task_id/prerequisites

List all task prerequisites from a task

Parameters

Name	Description	type
task_id required	ID of the task	integer

Request

Route

GET /api/v1.0/tasks/37/prerequisites

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/37/prerequisites" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1248

Body

[
  {
    "id": 38,
    "uid": 38,
    "_permission_": true,
    "title": "Bla",
    "is_working_on": false,
    "responsible_id": "coyote-212",
    "user_id": "coyote-214",
    "type_id": 7,
    "project_id": 2,
    "desired_date": null,
    "desired_date_with_time": null,
    "estimated_start_date": null,
    "estimated_delivery_date": null,
    "close_date": null,
    "priority": 2,
    "task_state_id": null,
    "was_reopened": false,
    "is_closed": false,
    "on_going": false,
    "team_id": null,
    "tag_list": "",
    "estimated_delivery_date_updated": false,
    "queue_position": 2,
    "scheduled_start_time": null,
    "created_at": "2017-03-21T17:33:40-03:00",
    "start_date": null,
    "current_estimate_seconds": 3600,
    "current_worked_time": 0,
    "current_evaluator_id": null,
    "approved": null,
    "attachments_count": 0,
    "client_name": "Test client 49",
    "project_name": "Test project 46",
    "type_name": "Type 68",
    "user_name": "Coyote 214",
    "responsible_name": "Coyote 212",
    "team_name": null,
    "task_state_name": null,
    "state": "queued",
    "overdue": "on_schedule",
    "time_worked": 0,
    "time_pending": 3600,
    "time_total": 3600,
    "time_progress": 0.0,
    "activities_7_days_ago": 0,
    "activities_6_days_ago": 0,
    "activities_5_days_ago": 0,
    "activities_4_days_ago": 0,
    "activities_3_days_ago": 0,
    "activities_2_days_ago": 0,
    "activities_1_days_ago": 0,
    "activities": 0,
    "follower_ids": [

    ],
    "workflow_id": null,
    "repetition_rule_id": null,
    "checklist_id": null
  }
]

POST

/api/v1.0/tasks/:task_id/prerequisites

Add a task prerequisite to a task

Parameters

Name	Description	type
task_id required	ID of the task	integer

Request

Route

POST /api/v1.0/tasks/39/prerequisites

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "prerequisite": {
    "id": 40
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/39/prerequisites" -d '{"prerequisite":{"id":40}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1246

Body

{
  "id": 40,
  "uid": 40,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-215",
  "user_id": "coyote-217",
  "type_id": 7,
  "project_id": 2,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "close_date": null,
  "priority": 2,
  "task_state_id": null,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": false,
  "queue_position": 2,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:33:42-03:00",
  "start_date": null,
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 51",
  "project_name": "Test project 48",
  "type_name": "Type 70",
  "user_name": "Coyote 217",
  "responsible_name": "Coyote 215",
  "team_name": null,
  "task_state_name": null,
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

DELETE

/api/v1.0/tasks/:task_id/prerequisites/:id

Remove a task prerequisite from a task

Parameters

Name	Description	type
task_id required	ID of the task	integer
id required	ID of the task prerequisite	integer

Request

Route

DELETE /api/v1.0/tasks/43/prerequisites/44

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/43/prerequisites/44" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

GET

/api/v1.0/task_templates/:task_template_id/prerequisites

List all task template prerequisites from a task template

Parameters

Name	Description	type
task_template_id required	ID of the task template	integer

Request

Route

GET /api/v1.0/task_templates/17/prerequisites

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/task_templates/17/prerequisites" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 250

Body

[
  {
    "id": 18,
    "title": "Task Template",
    "responsible_id": "coyote-216",
    "user_id": "coyote-216",
    "type_id": 7,
    "queue_position": 1,
    "project_template_id": 1,
    "team_id": null,
    "tag_list": "",
    "created_at": "2017-01-17T18:05:42-02:00",
    "follower_ids": [

    ],
    "workflow_id": null
  }
]

POST

/api/v1.0/task_templates/:task_template_id/prerequisites

Add a task template prerequisite to a task template

Parameters

Name	Description	type
task_template_id required	ID of the task template	integer

Request

Route

POST /api/v1.0/task_templates/19/prerequisites

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "prerequisite": {
    "id": 20
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/task_templates/19/prerequisites" -d '{"prerequisite":{"id":20}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 251

Body

{
  "id": 20,
  "title": "Task Template",
  "responsible_id": "coyote-219",
  "user_id": "coyote-219",
  "type_id": 7,
  "queue_position": null,
  "project_template_id": 1,
  "team_id": null,
  "tag_list": "",
  "created_at": "2017-01-17T18:05:44-02:00",
  "follower_ids": [

  ],
  "workflow_id": null
}

DELETE

/api/v1.0/task_templates/:task_template_id/prerequisites/:id

Remove a task template prerequisite from a task template

Parameters

Name	Description	type
task_template_id required	ID of the task template	integer
id required	ID of the task template prerequisite	integer

Request

Route

DELETE /api/v1.0/task_templates/23/prerequisites/24

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/task_templates/23/prerequisites/24" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

ProjectExtraCost

GET

/api/v1.0/projects/:project_id/extra_costs

List all extra costs of a project

Request

Route

GET /api/v1.0/projects/1/extra_costs

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/projects/1/extra_costs" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 213

Body

[
  {
    "id": 1,
    "description": "Cost 1",
    "date": "2017-01-17",
    "amount": 1000.0,
    "project_id": 1,
    "author_name": "Coyote 226",
    "author_avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png"
  }
]

GET

/api/v1.0/projects/:project_id/extra_costs/:id

Show a extra cost of a project

Request

Route

GET /api/v1.0/projects/1/extra_costs/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/projects/1/extra_costs/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID of project extra cost	integer
description	Description about the project extra cost	string
date	When project extra cost was created	date
amount	Project extra cost value	decimal
project_id	Project extra cost associated project ID	integer
author_name	User's name that created the project extra cost	string
author_avatar_url	User's avatar that created the project extra cost	string

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 211

Body

{
  "id": 1,
  "description": "Cost 2",
  "date": "2017-01-17",
  "amount": 1000.0,
  "project_id": 1,
  "author_name": "Coyote 228",
  "author_avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png"
}

POST

/api/v1.0/projects/:project_id/extra_costs

Create a new Project Extra Cost

Parameters

Name	Description	type
project_extra_cost[description] required	Description about the project extra cost	string
project_extra_cost[date] required	When project extra cost was created	date
project_extra_cost[amount] required	Project extra cost value	decimal

Request

Route

POST /api/v1.0/projects/1/extra_costs

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "project_extra_cost": {
    "amount": "1000.0",
    "date": "2017-01-17",
    "description": "Cost 3"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/projects/1/extra_costs" -d '{"project_extra_cost":{"amount":"1000.0","date":"2017-01-17","description":"Cost 3"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 211

Body

{
  "id": 1,
  "description": "Cost 3",
  "date": "2017-01-17",
  "amount": 1000.0,
  "project_id": 1,
  "author_name": "Coyote 231",
  "author_avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_3.png"
}

Project Groups

GET

/api/v1.0/clients/:client_id/project_groups

List all Project Groups

Request

Route

GET /api/v1.0/clients/1/project_groups

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1/project_groups" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 85

Body

[
  {
    "id": 1,
    "name": "Sem grupo",
    "is_default": true,
    "client_id": 1,
    "project_sub_groups": [

    ]
  }
]

GET

/api/v1.0/clients/:client_id/project_groups/:id

Show a Project Group

Request

Route

GET /api/v1.0/clients/1/project_groups/2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1/project_groups/2" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 90

Body

{
  "id": 2,
  "name": "Project Group 1",
  "is_default": false,
  "client_id": 1,
  "project_sub_groups": [

  ]
}

POST

/api/v1.0/clients/:client_id/project_groups

Create a Project Group

When creating a project group the name must be unique among clients belonging to the same enterprise.

Parameters

Name	Description	type
name required	Name of project group	string
is_default required	Project group is default for that client?	boolean

Request

Route

POST /api/v1.0/clients/1/project_groups

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "project_group": {
    "is_default": false,
    "name": "Project Group 2"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1/project_groups" -d '{"project_group":{"is_default":false,"name":"Project Group 2"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 90

Body

{
  "id": 2,
  "name": "Project Group 2",
  "is_default": false,
  "client_id": 1,
  "project_sub_groups": [

  ]
}

PUT

/api/v1.0/clients/:client_id/project_groups/:id

Update a Project Group

When updating a project group the name must be unique among clients belonging to the same enterprise.

Request

Route

PUT /api/v1.0/clients/1/project_groups/2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "project_group": {
    "name": "New Name"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1/project_groups/2" -d '{"project_group":{"name":"New Name"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 83

Body

{
  "id": 2,
  "name": "New Name",
  "is_default": false,
  "client_id": 1,
  "project_sub_groups": [

  ]
}

DELETE

/api/v1.0/clients/:client_id/project_groups/:id

Destroy a Project Group

Request

Route

DELETE /api/v1.0/clients/1/project_groups/2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1/project_groups/2" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Project Sub Groups

GET

/api/v1.0/project_groups/:project_group_id/project_sub_groups

List all Project Sub Groups using Project Group id

Request

Route

GET /api/v1.0/project_groups/2/project_sub_groups?sort_dir=desc&search_term=Project+Sub+Group+1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

sort_dir=desc
search_term=Project Sub Group 1

cURL

curl "https://secure.runrun.it/api/v1.0/project_groups/2/project_sub_groups?sort_dir=desc&search_term=Project+Sub+Group+1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 79

Body

[
  {
    "id": 3,
    "name": "Project Sub Group 1",
    "is_default": false,
    "project_group_id": 2
  }
]

GET

/api/v1.0/clients/:client_id/project_sub_groups

List all Project Sub Groups using Client id

Request

Route

GET /api/v1.0/clients/1/project_sub_groups?sort_dir=desc&search_term=Project+Sub+Group+2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

sort_dir=desc
search_term=Project Sub Group 2

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1/project_sub_groups?sort_dir=desc&search_term=Project+Sub+Group+2" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 79

Body

[
  {
    "id": 3,
    "name": "Project Sub Group 2",
    "is_default": false,
    "project_group_id": 2
  }
]

GET

/api/v1.0/project_groups/:project_group_id/project_sub_groups/:id

Show a Project Sub Group

Request

Route

GET /api/v1.0/project_groups/2/project_sub_groups/3

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/project_groups/2/project_sub_groups/3" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 77

Body

{
  "id": 3,
  "name": "Project Sub Group 2",
  "is_default": false,
  "project_group_id": 2
}

POST

/api/v1.0/project_groups/:project_group_id/project_sub_groups

Create a Project Sub Group

When creating a project sub group the name must be unique among project groups belonging to the same client.

Parameters

Name	Description	type
name required	Name of project group	string
is_default required	Project group is default for that client?	boolean

Request

Route

POST /api/v1.0/project_groups/2/project_sub_groups

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "project_sub_group": {
    "is_default": false,
    "name": "Project Sub Group 3"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/project_groups/2/project_sub_groups" -d '{"project_sub_group":{"is_default":false,"name":"Project Sub Group 3"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 77

Body

{
  "id": 3,
  "name": "Project Sub Group 3",
  "is_default": false,
  "project_group_id": 2
}

PUT

/api/v1.0/project_groups/:project_group_id/project_sub_groups/:id

Update a Project Sub Group

When updating a project sub group the name must be unique among project groups belonging to the same client.

Request

Route

PUT /api/v1.0/project_groups/2/project_sub_groups/3

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "project_sub_group": {
    "name": "New Name"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/project_groups/2/project_sub_groups/3" -d '{"project_sub_group":{"name":"New Name"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 66

Body

{
  "id": 3,
  "name": "New Name",
  "is_default": false,
  "project_group_id": 2
}

DELETE

/api/v1.0/project_groups/:project_group_id/project_sub_groups/:id

Destroy a Project Sub Group

Request

Route

DELETE /api/v1.0/project_groups/2/project_sub_groups/3

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/project_groups/2/project_sub_groups/3" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Project Templates

GET

/api/v1.0/project_templates

List all Project Templates

Request

Route

GET /api/v1.0/project_templates

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/project_templates" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 2

Body

[

]

GET

/api/v1.0/project_templates/:id

Show a Project Template

Request

Route

GET /api/v1.0/project_templates/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/project_templates/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 42

Body

{
  "id": 1,
  "name": "Test project template 32"
}

POST

/api/v1.0/project_templates/

Create a Project Template

When creating a project template the name must be unique among projects belonging to the same client.

Parameters

Name	Description	type
name required	Name of project template	string

Request

Route

POST /api/v1.0/project_templates/

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "project_template": {
    "name": "Test project template 33"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/project_templates/" -d '{"project_template":{"name":"Test project template 33"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 42

Body

{
  "id": 1,
  "name": "Test project template 33"
}

PUT

/api/v1.0/project_templates/:id

Update a Project Template

When updating a project template the name must be unique among projects belonging to the same client.

Request

Route

PUT /api/v1.0/project_templates/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "project_template": {
    "name": "New Name"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/project_templates/1" -d '{"project_template":{"name":"New Name"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 26

Body

{
  "id": 1,
  "name": "New Name"
}

DELETE

/api/v1.0/project_templates/:id

Destroy a Project Template

Request

Route

DELETE /api/v1.0/project_templates/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/project_templates/1" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Projects

GET

/api/v1.0/projects

List all projects

Request

Route

GET /api/v1.0/projects

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/projects" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 717

Body

[
  {
    "id": 1,
    "name": "Test project 56",
    "is_active": true,
    "client_id": 1,
    "budgeted_cost": 0.0,
    "desired_date": null,
    "created_at": "2017-01-17T18:06:40-02:00",
    "client_name": "Test client 73",
    "start_date": null,
    "close_date": null,
    "tasks_count": 0,
    "tasks_count_progress": 0.0,
    "tasks_queued_count": 0,
    "tasks_working_on_count": 0,
    "tasks_closed_count": 0,
    "time_worked": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.0,
    "overdue": "on_schedule",
    "cost_worked": 0.0,
    "cost_pending": 0.0,
    "extra_costs": 0.0,
    "cost_total": 0.0,
    "over_budget": "on_budget",
    "activities_7_days_ago": 0,
    "activities_6_days_ago": 0,
    "activities_5_days_ago": 0,
    "activities_4_days_ago": 0,
    "activities_3_days_ago": 0,
    "activities_2_days_ago": 0,
    "activities_1_days_ago": 0,
    "activities": 0
  }
]

GET

/api/v1.0/projects/:id

Show a Project

Request

Route

GET /api/v1.0/projects/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/projects/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 715

Body

{
  "id": 1,
  "name": "Test project 61",
  "is_active": true,
  "client_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2017-01-17T18:06:50-02:00",
  "client_name": "Test client 77",
  "start_date": null,
  "close_date": null,
  "tasks_count": 0,
  "tasks_count_progress": 0.0,
  "tasks_queued_count": 0,
  "tasks_working_on_count": 0,
  "tasks_closed_count": 0,
  "time_worked": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "overdue": "on_schedule",
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "extra_costs": 0.0,
  "cost_total": 0.0,
  "over_budget": "on_budget",
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0
}

POST

/api/v1.0/projects/

Create a Project

Request

Route

POST /api/v1.0/projects/

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "project": {
    "name": "New Project",
    "client_id": 1
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/projects/" -d '{"project":{"name":"New Project","client_id":1}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 711

Body

{
  "id": 1,
  "name": "New Project",
  "is_active": true,
  "client_id": 1,
  "budgeted_cost": 0.0,
  "desired_date": null,
  "created_at": "2017-01-17T18:06:53-02:00",
  "client_name": "Test client 78",
  "start_date": null,
  "close_date": null,
  "tasks_count": 0,
  "tasks_count_progress": 0.0,
  "tasks_queued_count": 0,
  "tasks_working_on_count": 0,
  "tasks_closed_count": 0,
  "time_worked": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "overdue": "on_schedule",
  "cost_worked": 0.0,
  "cost_pending": 0.0,
  "extra_costs": 0.0,
  "cost_total": 0.0,
  "over_budget": "on_budget",
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0
}

GET

/api/v1.0/projects/:id/involved_users

List users involved in a project

Involved users:

responsible
owners
followers

Parameters

Name	Description	type
id required	ID of project	integer

Request

Route

GET /api/v1.0/projects/1/involved_users

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/projects/1/involved_users" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1591

Body

[
  {
    "id": "coyote-261",
    "name": "Coyote 261",
    "email": "coyote248@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_2.png",
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "can_create_client_project_and_task_types": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "49537adb9",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true
  }
]

Parameters

Name	Description	type	default
term required	Search term for tag name. For a given term will be return a list of tags that match fully or partially with tag name. The term MUST be at least 3 characters.	string
limit	Number of record to return. The value must be between 1 and 100.	integer	100

Request

Route

GET /api/v1.0/tags?term=tag

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

term=tag

cURL

curl "https://secure.runrun.it/api/v1.0/tags?term=tag" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 70

Body

[
  {
    "id": 3,
    "name": "tag3"
  },
  {
    "id": 2,
    "name": "tag2"
  },
  {
    "id": 1,
    "name": "tag1"
  }
]

Task Description

GET

/api/v1.0/tasks/:task_id/description

Show the task description

Show the task description.

Request

Route

GET /api/v1.0/tasks/1/description

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/1/description" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 53

Body

{
  "id": 1,
  "_permission_": true,
  "description": "Awesome!"
}

PUT

/api/v1.0/tasks/:task_id/description

Update the task description

Update a task description.

Parameters

Name	Description	type
description required	Longer description of task scope	text
_permission_	Requestor has full-view access	boolean

Request

Route

PUT /api/v1.0/tasks/1/description

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_description": {
    "created_at": null,
    "description": "Gorgeous!",
    "id": null,
    "task_id": 1,
    "updated_at": null
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/1/description" -d '{"task_description":{"created_at":null,"description":"Gorgeous!","id":null,"task_id":1,"updated_at":null}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 54

Body

{
  "id": 1,
  "_permission_": true,
  "description": "Gorgeous!"
}

Task States

GET

/api/v1.0/task_states

List all Task States

Request

Route

GET /api/v1.0/task_states

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/task_states" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 141

Body

[
  {
    "id": 1,
    "name": "Entregue",
    "is_working_on": false,
    "is_delivered": true
  },
  {
    "id": 2,
    "name": "Avaliando",
    "is_working_on": false,
    "is_delivered": false
  }
]

GET

/api/v1.0/task_states/:id

Show a Task State

Request

Route

GET /api/v1.0/task_states/3

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/task_states/3" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID of Task State	integer
name	Display name of Task State	string
is_working_on	[Deprecated] Is system state for working on	boolean
is_delivered	Is system state for delivered	boolean

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 73

Body

{
  "id": 3,
  "name": "Task State 4",
  "is_working_on": false,
  "is_delivered": false
}

POST

/api/v1.0/task_states

Create a Task State

Create a task state. The is_working_on and is_delivered fields are reserved for use by the system and cannot be set. Only account administrators can perform this action.

Parameters

Name	Description	type
task_state[name] required	Display name of Task State	string

Request

Route

POST /api/v1.0/task_states

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_state": {
    "name": "Task State 5"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/task_states" -d '{"task_state":{"name":"Task State 5"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 73

Body

{
  "id": 3,
  "name": "Task State 5",
  "is_working_on": false,
  "is_delivered": false
}

PUT

/api/v1.0/task_states/:id

Update a Task State

Update a task state. Only account administrators can perform this action.

Parameters

Name	Description	type
task_states[name]	Display name of Task State	string

Request

Route

PUT /api/v1.0/task_states/3

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_state": {
    "name": "Release pending"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/task_states/3" -d '{"task_state":{"name":"Release pending"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 76

Body

{
  "id": 3,
  "name": "Release pending",
  "is_working_on": false,
  "is_delivered": false
}

DELETE

/api/v1.0/task_states/:id

Destroy a Task State

Destroy a task state. Only account administrators can perform this action.

Request

Route

DELETE /api/v1.0/task_states/3

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/task_states/3" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Task Templates

GET

/api/v1.0/project_templates/:project_template_id/task_templates

List all Task Templates of this Project Template

Request

Route

GET /api/v1.0/project_templates/1/task_templates

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/project_templates/1/task_templates" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 505

Body

[
  {
    "id": 28,
    "title": "Task Template",
    "responsible_id": "coyote-290",
    "user_id": "coyote-290",
    "type_id": 7,
    "queue_position": null,
    "project_template_id": 1,
    "team_id": null,
    "tag_list": "",
    "created_at": "2017-01-17T18:08:00-02:00",
    "follower_ids": [

    ],
    "workflow_id": null
  },
  {
    "id": 27,
    "title": "Task Template",
    "responsible_id": "coyote-290",
    "user_id": "coyote-290",
    "type_id": 6,
    "queue_position": null,
    "project_template_id": 1,
    "team_id": null,
    "tag_list": "",
    "created_at": "2017-01-17T18:07:59-02:00",
    "follower_ids": [

    ],
    "workflow_id": null
  }
]

GET

/api/v1.0/project_templates/:project_template_id/task_templates/:id

Show a Task Template

Request

Route

GET /api/v1.0/project_templates/1/task_templates/29

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/project_templates/1/task_templates/29" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 251

Body

{
  "id": 29,
  "title": "Task Template",
  "responsible_id": "coyote-291",
  "user_id": "coyote-291",
  "type_id": 6,
  "queue_position": null,
  "project_template_id": 1,
  "team_id": null,
  "tag_list": "",
  "created_at": "2017-01-17T18:08:01-02:00",
  "follower_ids": [

  ],
  "workflow_id": null
}

POST

/api/v1.0/project_templates/:project_template_id/task_templates

Create a Task Template

Parameters

Name	Description	type
title required	Name of task template	string
responsible_id required	ID of user responsible for this task template	string
type_id required	ID of task template type	integer
team_id required	ID of team task template is assigned to	integer
tag_list	Tags for task (separated by commas)	string

Request

Route

POST /api/v1.0/project_templates/1/task_templates

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_template": {
    "responsible_id": "coyote-292",
    "team_id": null,
    "title": "Task Template",
    "type_id": 6
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/project_templates/1/task_templates" -d '{"task_template":{"responsible_id":"coyote-292","team_id":null,"title":"Task Template","type_id":6}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 247

Body

{
  "id": 1,
  "title": "Task Template",
  "responsible_id": "coyote-292",
  "user_id": "coyote-292",
  "type_id": 6,
  "queue_position": 1,
  "project_template_id": 1,
  "team_id": null,
  "tag_list": "",
  "created_at": "2017-01-17T18:08:02-02:00",
  "follower_ids": [

  ],
  "workflow_id": null
}

PUT

/api/v1.0/project_templates/:project_template_id/task_templates/:id

Update a Task Template

Request

Route

PUT /api/v1.0/project_templates/1/task_templates/31

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_template": {
    "title": "New Title",
    "responsible_id": "coyote-294",
    "type_id": 6,
    "team_id": 1
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/project_templates/1/task_templates/31" -d '{"task_template":{"title":"New Title","responsible_id":"coyote-294","type_id":6,"team_id":1}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 244

Body

{
  "id": 31,
  "title": "New Title",
  "responsible_id": "coyote-294",
  "user_id": "coyote-296",
  "type_id": 6,
  "queue_position": null,
  "project_template_id": 1,
  "team_id": 1,
  "tag_list": "",
  "created_at": "2017-01-17T18:08:05-02:00",
  "follower_ids": [

  ],
  "workflow_id": null
}

DELETE

/api/v1.0/project_templates/:project_template_id/task_templates/:id

Destroy a Task Template

Request

Route

DELETE /api/v1.0/project_templates/1/task_templates/32

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/project_templates/1/task_templates/32" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Task Followers

GET

/api/v1.0/tasks/:task_id/followers

List all followers

Responds with an array of users following the task. The format of each user is the same as the User endpoint.

Request

Route

GET /api/v1.0/tasks/74/followers

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/74/followers" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1615

Body

[
  {
    "id": "coyote-298",
    "name": "Coyote 298",
    "email": "coyote285@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_2.png",
    "super_compact_view": true,
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": true,
    "is_manager": false,
    "can_create_client_project_and_task_types": true,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "49537adb9",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true
  }
]

POST

/api/v1.0/tasks/:task_id/followers

Create a Task Follower

Parameters

Name	Description	type
id required	ID of user to add as follower	string

Request

Route

POST /api/v1.0/tasks/75/followers

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "id": "coyote-300"
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/75/followers" -d '{"id":"coyote-300"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1589

Body

{
  "id": "coyote-300",
  "name": "Coyote 300",
  "email": "coyote287@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_3.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_3.png",
  "compact_side_menu": null,
  "cost_hour": 0.0,
  "is_master": false,
  "is_manager": false,
  "can_create_client_project_and_task_types": false,
  "time_zone": "America/Sao_Paulo",
  "position": null,
  "on_vacation": false,
  "birthday": null,
  "phone": null,
  "gender": null,
  "marital_status": null,
  "in_company_since": null,
  "is_certified": false,
  "language": "pt-BR",
  "oid": "92a6f5b72",
  "see_archived_clients_and_projects": null,
  "budget_manager": false,
  "shifts": [
    {
      "weekday": 0,
      "work_day": false,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 1,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 2,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 3,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 4,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 5,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 6,
      "work_day": false,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    }
  ],
  "is_mensurable": true
}

DELETE

/api/v1.0/tasks/:task_id/followers/:id

Remove a Task Follower

Request

Route

DELETE /api/v1.0/tasks/76/followers/coyote-302

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/76/followers/coyote-302" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Task Workflows

GET

/api/v1.0/workflows

Show a Workflow

Parameters

Name	Description	type
task_id required	ID of the task the workflow belongs to	integer

Request

Route

GET /api/v1.0/workflows?task_id=77

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

task_id=77

cURL

curl "https://secure.runrun.it/api/v1.0/workflows?task_id=77" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 76

Body

{
  "id": 1,
  "task_id": 77,
  "current_workflow_element_id": 1,
  "is_last_element": true
}

POST

/api/v1.0/workflows

Create a Workflow

The workflow is eligible to be created if:

the task is not closed
the task is not on going
the task does not have a workflow

Parameters

Name	Description	type
task_id required	ID of the task the workflow belongs to	integer

Request

Route

POST /api/v1.0/workflows

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_id": 78
}

cURL

curl "https://secure.runrun.it/api/v1.0/workflows" -d '{"task_id":78}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 76

Body

{
  "id": 1,
  "task_id": 78,
  "current_workflow_element_id": 1,
  "is_last_element": true
}

DELETE

/api/v1.0/workflows

Destroy a workflow

Parameters

Name	Description	type
task_id required	ID of the task the workflow belongs to	integer

Request

Route

DELETE /api/v1.0/workflows

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_id": 80
}

cURL

curl "https://secure.runrun.it/api/v1.0/workflows" -d '{"task_id":80}' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Tasks

GET

/api/v1.0/tasks

Query tasks

Returns a paginated list of tasks that the user has permission to see. The number of tasks returned are limited by limit per page and are sorted based on sort and sort_dir. Use the following Parameters to narrow and customize your query.

Parameters

Name	Description	type	default
ids	IDs of tasks, separated by comma	string
user_id	ID of user who created this task	string
responsible_id	ID of user responsible for this task	string
follower_id	ID of user following the task	string
project_id	ID of the project the task belongs to	integer
is_closed	Task is delivered	boolean	false
is_working_on	Responsible is currently working on this task	boolean
sort	Sort strategy. Must be one of the following: id, queue_position, title, activities, user_name, responsible_name, team_name, type_name, client_name, project_name, task_state_name, state, created_at, start_date, close_date, overdue, current_estimate_seconds, time_worked, time_progress, tag_list, desired_date, estimated_delivery_date and requested_queue_position	string	closed_date if `ìs_closed=true`; otherwise queue_position
sort_dir	Sort direction. Must be asc or desc	string	desc if `ìs_closed=true`; otherwise asc
page	The page that will be displayed. Must be equal or greater than 1	integer	1
limit	The number of objects to return per page. The value must be between 1 and 100	integer	100
bypass_status_default	Set as true to bypass the default value of `is_closed` param	boolean	false

Request

Route

GET /api/v1.0/tasks?responsible_id=coyote-322&sort=close_date&sort_dir=desc&is_closed=true&project_id=1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

responsible_id=coyote-322
sort=close_date
sort_dir=desc
is_closed=true
project_id=1

cURL

curl "https://secure.runrun.it/api/v1.0/tasks?responsible_id=coyote-322&sort=close_date&sort_dir=desc&is_closed=true&project_id=1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 2566

Body

[
  {
    "id": 82,
    "uid": 82,
    "_permission_": true,
    "title": "Improve Task API",
    "is_working_on": false,
    "responsible_id": "coyote-322",
    "user_id": "coyote-324",
    "type_id": 7,
    "project_id": 1,
    "desired_date": null,
    "desired_date_with_time": null,
    "estimated_start_date": null,
    "estimated_delivery_date": null,
    "close_date": "2017-03-20T17:35:52-03:00",
    "priority": null,
    "task_state_id": null,
    "was_reopened": false,
    "is_closed": true,
    "on_going": false,
    "team_id": null,
    "tag_list": "",
    "estimated_delivery_date_updated": false,
    "queue_position": null,
    "scheduled_start_time": null,
    "created_at": "2017-03-21T17:35:52-03:00",
    "start_date": null,
    "current_estimate_seconds": 3600,
    "current_worked_time": 0,
    "current_evaluator_id": null,
    "approved": null,
    "attachments_count": 0,
    "client_name": "Test client 94",
    "project_name": "Test project 76",
    "type_name": "Type 120",
    "user_name": "Coyote 324",
    "responsible_name": "Coyote 322",
    "team_name": null,
    "task_state_name": null,
    "state": "closed",
    "overdue": "on_schedule",
    "time_worked": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.0,
    "activities_7_days_ago": 0,
    "activities_6_days_ago": 0,
    "activities_5_days_ago": 0,
    "activities_4_days_ago": 0,
    "activities_3_days_ago": 0,
    "activities_2_days_ago": 0,
    "activities_1_days_ago": 0,
    "activities": 0,
    "follower_ids": [

    ],
    "workflow_id": null,
    "repetition_rule_id": null,
    "checklist_id": null
  },
  {
    "id": 81,
    "uid": 81,
    "_permission_": true,
    "title": "Create Task API",
    "is_working_on": false,
    "responsible_id": "coyote-322",
    "user_id": "coyote-323",
    "type_id": 6,
    "project_id": 1,
    "desired_date": null,
    "desired_date_with_time": null,
    "estimated_start_date": null,
    "estimated_delivery_date": null,
    "close_date": "2017-03-19T17:35:51-03:00",
    "priority": null,
    "task_state_id": null,
    "was_reopened": false,
    "is_closed": true,
    "on_going": false,
    "team_id": null,
    "tag_list": "",
    "estimated_delivery_date_updated": false,
    "queue_position": null,
    "scheduled_start_time": null,
    "created_at": "2017-03-21T17:35:52-03:00",
    "start_date": null,
    "current_estimate_seconds": 3600,
    "current_worked_time": 0,
    "current_evaluator_id": null,
    "approved": null,
    "attachments_count": 0,
    "client_name": "Test client 94",
    "project_name": "Test project 76",
    "type_name": "Type 119",
    "user_name": "Coyote 323",
    "responsible_name": "Coyote 322",
    "team_name": null,
    "task_state_name": null,
    "state": "closed",
    "overdue": "on_schedule",
    "time_worked": 0,
    "time_pending": 0,
    "time_total": 0,
    "time_progress": 0.0,
    "activities_7_days_ago": 0,
    "activities_6_days_ago": 0,
    "activities_5_days_ago": 0,
    "activities_4_days_ago": 0,
    "activities_3_days_ago": 0,
    "activities_2_days_ago": 0,
    "activities_1_days_ago": 0,
    "activities": 0,
    "follower_ids": [

    ],
    "workflow_id": null,
    "repetition_rule_id": null,
    "checklist_id": null
  }
]

GET

/api/v1.0/tasks/:id

Show a Task

Request

Route

GET /api/v1.0/tasks/83

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/83" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID of task	integer
uid	[Deprecated, please use 'id' field]. ID of task	integer
title	Name of task	string
_permission_	Requestor has full-view access	boolean
is_working_on	Responsible is currently working on this task	boolean
responsible_id	ID of user responsible for this task	string
user_id	ID of user who created this task	string
type_id	ID of task type	integer
project_id	ID of the project the task belongs to	integer
desired_date	[Deprecated, please use `desired_date_with_time` field] Requested complete by date	datetime
desired_date_with_time	Requested complete by date and time	datetime
estimated_start_date	When the system estimates the task will be started	datetime
estimated_delivery_date	When the system estimates the task will be delivered	datetime
close_date	When the task was delivered	datetime
priority	Priority on responsible user's task list	integer
task_state_id	ID of task state	integer
was_reopened	Task has been reopened after being delivered	boolean
is_closed	Task is delivered	boolean
on_going	Task is an on-going task	boolean
team_id	ID of team task is assigned to	integer
tag_list	Tags for task (separated by commas)	string
estimated_delivery_date_updated	Estimates have been updated after potential change	boolean
queue_position	1-based index of position on responsible user's task list	integer
scheduled_start_time	When task was scheduled to start	datetime
created_at	Time task was created	datetime
start_date	First time task was being worked on	datetime
current_estimate_seconds	Current estimated effort (in seconds)	integer
current_worked_time	Current worked time (in seconds)	integer
current_evaluator_id	ID of current evaluator for this task	string
approved	Task is approved?	boolean
attachments_count	Number of attachment that belongs to Task	integer
client_name	Name of client	string
project_name	Name of project	string
project_group_name	Name of project group	string
project_group_is_default	Is the project group default?	boolean
project_sub_group_name	Name of project subgroup	string
project_sub_group_is_default	Is the project subgroup default?	boolean
type_name	Name of type	string
user_name	Name of user	string
responsible_name	Name of responsible	string
team_name	Name of team	string
task_state_name	Name of state	string
state	State	string
overdue	Overdue status of the task	string
time_worked	Time (in seconds) worked in the task	integer
time_pending	Time (in seconds) pending in the task	integer
time_total	Total seconds spent in the task	integer
time_progress	Progress of time worked on the task	float
activities_7_days_ago	Time (in seconds) worked in the task 7 days ago	integer
activities_6_days_ago	Time (in seconds) worked in the task 6 days ago	integer
activities_5_days_ago	Time (in seconds) worked in the task 5 days ago	integer
activities_4_days_ago	Time (in seconds) worked in the task 4 days ago	integer
activities_3_days_ago	Time (in seconds) worked in the task 3 days ago	integer
activities_2_days_ago	Time (in seconds) worked in the task 2 days ago	integer
activities_1_days_ago	Time (in seconds) worked in the task 1 days ago	integer
activities	Total time (in seconds) worked 7 days ago	integer
follower_ids	IDs of users following this task	array
workflow_id	ID of associated workflow (if any)	integer

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1290

Body

{
  "id": 83,
  "uid": 83,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-330",
  "user_id": "coyote-331",
  "type_id": 6,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "close_date": null,
  "priority": 1,
  "task_state_id": null,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": false,
  "queue_position": 1,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:35:57-03:00",
  "start_date": null,
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 95",
  "project_name": "Test project 77",
  "type_name": "Type 121",
  "user_name": "Coyote 331",
  "responsible_name": "Coyote 330",
  "team_name": null,
  "task_state_name": null,
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null,
  "unseen_since": "2017-03-21T17:35:57-03:00"
}

POST

/api/v1.0/tasks

Create a Task

Create a task. The user field will be set to the user on whose behalf the API request is issued.

Parameters

Name	Description	type
task[title] required	Name of task	string
task[on_going] required	Task is an on-going task	boolean
task[responsible_id] required	ID of user responsible for this task	string
task[team_id] required	ID of team task is assigned to	integer
task[type_id] required	ID of task type	integer
task[project_id] required	ID of the project the task belongs to	integer
task[scheduled_start_time] required	When task was scheduled to start	datetime
task[desired_date] required	[Deprecated, please use `desired_date_with_time` field] Requested complete by date	datetime
task[desired_date_with_time]	Requested complete by date and time	datetime
task[tag_list]	Tags for task (separated by commas)	string
task[workflow_id]	ID of workflow to connect to this task
task[preloaded_prereqs]	IDs of pre-requisite tasks	array
task[follower_ids]	IDs of users to follow this task	array
task[document_ids]	IDs of Document records to attach	array

Request

Route

POST /api/v1.0/tasks

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task": {
    "desired_date": null,
    "on_going": false,
    "project_id": 1,
    "responsible_id": "coyote-333",
    "scheduled_start_time": null,
    "team_id": null,
    "title": "Bla",
    "type_id": 6
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks" -d '{"task":{"desired_date":null,"on_going":false,"project_id":1,"responsible_id":"coyote-333","scheduled_start_time":null,"team_id":null,"title":"Bla","type_id":6}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1239

Body

{
  "id": 1,
  "uid": 1,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-333",
  "user_id": "coyote-333",
  "type_id": 6,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "close_date": null,
  "priority": 1,
  "task_state_id": null,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": false,
  "queue_position": 1,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:36:00-03:00",
  "start_date": null,
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 96",
  "project_name": "Test project 78",
  "type_name": "Type 122",
  "user_name": "Coyote 333",
  "responsible_name": "Coyote 333",
  "team_name": null,
  "task_state_name": null,
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

POST

/api/v1.0/tasks/:id/play

Play a Task

Indicate that a task is being worked on, if the responsible is currently working on a task it will be paused.

The task is eligible to be started if:

it's not already being working on
it's not closed
it does not have any open prerequisite tasks

Parameters

Name	Description	type
id	ID of task	integer

Request

Route

POST /api/v1.0/tasks/90/play

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/90/play" -d '' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1296

Body

{
  "id": 90,
  "uid": 90,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": true,
  "responsible_id": "coyote-346",
  "user_id": "coyote-347",
  "type_id": 6,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": "2017-03-21T18:36:19-03:00",
  "close_date": null,
  "priority": 1,
  "task_state_id": null,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": true,
  "queue_position": 1,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:36:18-03:00",
  "start_date": "2017-03-21T17:36:18-03:00",
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 103",
  "project_name": "Test project 85",
  "type_name": "Type 130",
  "user_name": "Coyote 347",
  "responsible_name": "Coyote 346",
  "team_name": null,
  "task_state_name": null,
  "state": "working_on",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

POST

/api/v1.0/tasks/:id/pause

Pause a Task

Pause the work on a task.

The task is eligible to be paused if:

it's currently being working on

Parameters

Name	Description	type
id	ID of task	integer

Request

Route

POST /api/v1.0/tasks/91/pause

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/91/pause" -d '' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1248

Body

{
  "id": 91,
  "uid": 91,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-348",
  "user_id": "coyote-349",
  "type_id": 6,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "close_date": null,
  "priority": 1,
  "task_state_id": null,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": false,
  "queue_position": 1,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:36:21-03:00",
  "start_date": null,
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 104",
  "project_name": "Test project 86",
  "type_name": "Type 131",
  "user_name": "Coyote 349",
  "responsible_name": "Coyote 348",
  "team_name": null,
  "task_state_name": null,
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

POST

/api/v1.0/tasks/:id/change_state

Change a Task state to another

Parameters

Name	Description	type
id	ID of task	integer
task_state_id required	ID of task state	integer

Request

Route

POST /api/v1.0/tasks/92/change_state

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_state_id": 3
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/92/change_state" -d '{"task_state_id":3}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1260

Body

{
  "id": 92,
  "uid": 92,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": true,
  "responsible_id": "coyote-350",
  "user_id": "coyote-351",
  "type_id": 6,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "close_date": null,
  "priority": 1,
  "task_state_id": 3,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": false,
  "queue_position": 1,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:36:23-03:00",
  "start_date": null,
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 105",
  "project_name": "Test project 87",
  "type_name": "Type 132",
  "user_name": "Coyote 351",
  "responsible_name": "Coyote 350",
  "team_name": null,
  "task_state_name": "New task state",
  "state": "working_on",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

POST

/api/v1.0/tasks/:id/schedule

Schedule a task

Parameters

Name	Description	type
id	ID of task	integer
scheduled_start_time required	When task was scheduled to start	datetime

Request

Route

POST /api/v1.0/tasks/94/schedule

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "scheduled_start_time": "2016-11-16T11:30:00-02:00"
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/94/schedule" -d '{"scheduled_start_time":"2016-11-16T11:30:00-02:00"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1365

Body

{
  "id": 94,
  "uid": 94,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-354",
  "user_id": "coyote-355",
  "type_id": 6,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": "2016-11-16T11:30:00-02:00",
  "estimated_delivery_date": "2016-11-16T13:30:00-02:00",
  "close_date": "2016-11-16T13:30:00-02:00",
  "priority": null,
  "task_state_id": null,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": true,
  "queue_position": 1,
  "scheduled_start_time": "2016-11-16T11:30:00-02:00",
  "created_at": "2016-11-16T11:00:00-02:00",
  "start_date": "2016-11-16T11:30:00-02:00",
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 107",
  "project_name": "Test project 89",
  "type_name": "Type 134",
  "user_name": "Coyote 355",
  "responsible_name": "Coyote 354",
  "team_name": null,
  "task_state_name": null,
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

POST

/api/v1.0/tasks/:id/unschedule

Unschedule a task

Parameters

Name	Description	type
id	ID of task	integer

Request

Route

POST /api/v1.0/tasks/95/unschedule

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/95/unschedule" -d '' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1251

Body

{
  "id": 95,
  "uid": 95,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-356",
  "user_id": "coyote-357",
  "type_id": 6,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "close_date": null,
  "priority": null,
  "task_state_id": null,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": false,
  "queue_position": 1,
  "scheduled_start_time": null,
  "created_at": "2016-11-16T11:00:00-02:00",
  "start_date": null,
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 108",
  "project_name": "Test project 90",
  "type_name": "Type 135",
  "user_name": "Coyote 357",
  "responsible_name": "Coyote 356",
  "team_name": null,
  "task_state_name": null,
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

POST

/api/v1.0/tasks/:id/close

Close a Task

Deliver a task.

The task is eligible to be delivered if:

it's not already closed
it does not have any open prerequisite tasks

Parameters

Name	Description	type
id	ID of task	integer

Request

Route

POST /api/v1.0/tasks/96/close

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/96/close" -d '' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1296

Body

{
  "id": 96,
  "uid": 96,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-358",
  "user_id": "coyote-359",
  "type_id": 6,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": null,
  "estimated_delivery_date": null,
  "close_date": "2017-03-21T17:36:34-03:00",
  "priority": null,
  "task_state_id": 1,
  "was_reopened": false,
  "is_closed": true,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": false,
  "queue_position": null,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:36:33-03:00",
  "start_date": "2017-03-21T17:36:34-03:00",
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 109",
  "project_name": "Test project 91",
  "type_name": "Type 136",
  "user_name": "Coyote 359",
  "responsible_name": "Coyote 358",
  "team_name": null,
  "task_state_name": "Entregue",
  "state": "closed",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 0,
  "time_total": 0,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

POST

/api/v1.0/tasks/:id/transfer

Transfer a Task

Transfer the task responsibility to another user. The task's team is related with the responsible. On change the responsibility, it's possible to set a task team that the new responsible belongs

The task is eligible to be transferred if:

it's not already closed

The task is authorized to be transferred if:

the new responsible is a partner of the original responsible
the new responsible is authorized to see the task's type
the new responsible is authorized to see the client of the task's project

Parameters

Name	Description	type
id	ID of task	integer
responsible_id required	ID of user responsible for this task	string
team_id	ID of team task is assigned to	integer

Request

Route

POST /api/v1.0/tasks/97/transfer

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "responsible_id": "coyote-363"
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/97/transfer" -d '{"responsible_id":"coyote-363"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1352

Body

{
  "id": 97,
  "uid": 97,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-363",
  "user_id": "coyote-362",
  "type_id": 11,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": "2017-03-21T17:36:38-03:00",
  "estimated_delivery_date": "2017-03-21T18:36:38-03:00",
  "close_date": "2017-03-21T18:36:38-03:00",
  "priority": 1,
  "task_state_id": null,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": true,
  "queue_position": 1,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:36:37-03:00",
  "start_date": "2017-03-21T17:36:38-03:00",
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 110",
  "project_name": "Test project 92",
  "type_name": "Type 137",
  "user_name": "Coyote 362",
  "responsible_name": "Coyote 363",
  "team_name": null,
  "task_state_name": null,
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [
    "coyote-361"
  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

POST

/api/v1.0/tasks/:id/reopen

Reopen a Task

Reopen a closed task.

IMPORTANT!!: If the task is prerequisite directly or indirectly in any task that has already been delivered or is under development, it is necessary to pause or reopen these tasks. You can set the parameter "reopen_or_pause_descendant_tasks" to automatically pause or reopen the necessary tasks. To complete this operation with success it's necessary that the current user is allowed to reopen and pause all these tasks.

The task is eligible to be reopened if:

it's closed
it's not a prerequisite of working on or closed tasks

Parameters

Name	Description	type
id required	ID of task	integer
reopen_or_pause_descendant_tasks	Force pause/reopen all descendant tasks	boolean

Request

Route

POST /api/v1.0/tasks/98/reopen

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/98/reopen" -d '' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1338

Body

{
  "id": 98,
  "uid": 98,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-364",
  "user_id": "coyote-365",
  "type_id": 6,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": "2017-03-21T17:36:41-03:00",
  "estimated_delivery_date": "2017-03-21T18:36:41-03:00",
  "close_date": "2017-03-21T18:36:41-03:00",
  "priority": 1,
  "task_state_id": null,
  "was_reopened": true,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": true,
  "queue_position": 1,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:36:40-03:00",
  "start_date": "2017-03-21T17:36:41-03:00",
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 111",
  "project_name": "Test project 93",
  "type_name": "Type 138",
  "user_name": "Coyote 365",
  "responsible_name": "Coyote 364",
  "team_name": null,
  "task_state_name": null,
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

POST

/api/v1.0/tasks/:id/reprioritize

Reprioritize a Task

Parameters

Name	Description	type
id required	ID of task	integer
priority required	The new priority on responsible user's task list	integer

Request

Route

POST /api/v1.0/tasks/102/reprioritize

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "priority": 2
}

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/102/reprioritize" -d '{"priority":2}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1342

Body

{
  "id": 102,
  "uid": 102,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-366",
  "user_id": "coyote-366",
  "type_id": 14,
  "project_id": 4,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": "2017-03-21T18:36:44-03:00",
  "estimated_delivery_date": "2017-03-22T10:36:44-03:00",
  "close_date": "2017-03-22T10:36:44-03:00",
  "priority": 2,
  "task_state_id": null,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": true,
  "queue_position": 2,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:36:43-03:00",
  "start_date": "2017-03-21T18:36:44-03:00",
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 115",
  "project_name": "Test project 97",
  "type_name": "Type 142",
  "user_name": "Coyote 366",
  "responsible_name": "Coyote 366",
  "team_name": null,
  "task_state_name": null,
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [

  ],
  "workflow_id": null,
  "repetition_rule_id": null,
  "checklist_id": null
}

GET

/api/v1.0/tasks/unseen_activities

List unseen activities of a task

List not seen activities of a task by the current user

Parameters

Name	Description	type
task_ids required	List of task ids separated by comma ','	array of integers

Request

Route

GET /api/v1.0/tasks/unseen_activities?task_ids=3003%2C1337

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

task_ids=3003,1337

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/unseen_activities?task_ids=3003%2C1337" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
task_id	ID of the related task	integer
has_unread_comments	True if the current user has unread comments on this task	boolean

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 91

Body

[
  {
    "task_id": 1337,
    "has_unread_comments": false
  },
  {
    "task_id": 3003,
    "has_unread_comments": false
  }
]

POST

/api/v1.0/tasks/:id/complete_workflow_step

Complete a workflow step

Parameters

Name	Description	type
id	ID of task	integer

Request

Route

POST /api/v1.0/tasks/104/complete_workflow_step

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/tasks/104/complete_workflow_step" -d '' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1352

Body

{
  "id": 104,
  "uid": 104,
  "_permission_": true,
  "title": "Bla",
  "is_working_on": false,
  "responsible_id": "coyote-372",
  "user_id": "coyote-371",
  "type_id": 11,
  "project_id": 1,
  "desired_date": null,
  "desired_date_with_time": null,
  "estimated_start_date": "2017-03-21T17:36:52-03:00",
  "estimated_delivery_date": "2017-03-21T18:36:52-03:00",
  "close_date": "2017-03-21T18:36:52-03:00",
  "priority": 1,
  "task_state_id": null,
  "was_reopened": false,
  "is_closed": false,
  "on_going": false,
  "team_id": null,
  "tag_list": "",
  "estimated_delivery_date_updated": true,
  "queue_position": 1,
  "scheduled_start_time": null,
  "created_at": "2017-03-21T17:36:49-03:00",
  "start_date": "2017-03-21T17:36:52-03:00",
  "current_estimate_seconds": 3600,
  "current_worked_time": 0,
  "current_evaluator_id": null,
  "approved": null,
  "attachments_count": 0,
  "client_name": "Test client 119",
  "project_name": "Test project 101",
  "type_name": "Type 146",
  "user_name": "Coyote 371",
  "responsible_name": "Coyote 372",
  "team_name": null,
  "task_state_name": null,
  "state": "queued",
  "overdue": "on_schedule",
  "time_worked": 0,
  "time_pending": 3600,
  "time_total": 3600,
  "time_progress": 0.0,
  "activities_7_days_ago": 0,
  "activities_6_days_ago": 0,
  "activities_5_days_ago": 0,
  "activities_4_days_ago": 0,
  "activities_3_days_ago": 0,
  "activities_2_days_ago": 0,
  "activities_1_days_ago": 0,
  "activities": 0,
  "follower_ids": [
    "coyote-371"
  ],
  "workflow_id": 1,
  "repetition_rule_id": null,
  "checklist_id": null
}

Team Authorizations

GET

/api/v1.0/types/:type_id/team_authorizations

List all team authorizations of a type

List all teams authorizations of a type that the current_user can view"

Request

Route

GET /api/v1.0/types/6/team_authorizations

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/types/6/team_authorizations" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 97

Body

[
  {
    "id": 21,
    "all_users": true,
    "team_id": 1,
    "team_authorizable_id": 6,
    "team_authorizable_type": "Type"
  }
]

POST

/api/v1.0/types/:type_id/team_authorizations

Create a team authorization of a type

Parameters

Name	Description	type
team_authorization[all_users]	Authorize all teams?	boolean
team_authorization[team_id]	Team ID	integer

Request

Route

POST /api/v1.0/types/6/team_authorizations

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "team_authorization": {
    "all_users": false,
    "team_id": 1
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/types/6/team_authorizations" -d '{"team_authorization":{"all_users":false,"team_id":1}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 95

Body

{
  "id": 6,
  "all_users": false,
  "team_id": 1,
  "team_authorizable_id": 6,
  "team_authorizable_type": "Type"
}

DELETE

/api/v1.0/types/:type_id/team_authorizations/:id

Destroy a team authorization of a type

Parameters

Name	Description	type
id required	ID of Team Authorization	integer

Request

Route

DELETE /api/v1.0/types/6/team_authorizations/21

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/types/6/team_authorizations/21" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

GET

/api/v1.0/clients/:client_id/team_authorizations

List all team authorizations of a client

List all teams authorizations of a client that the current_user can view"

Request

Route

GET /api/v1.0/clients/1/team_authorizations

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1/team_authorizations" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 199

Body

[
  {
    "id": 6,
    "all_users": true,
    "team_id": null,
    "team_authorizable_id": 1,
    "team_authorizable_type": "Client"
  },
  {
    "id": 22,
    "all_users": true,
    "team_id": 1,
    "team_authorizable_id": 1,
    "team_authorizable_type": "Client"
  }
]

POST

/api/v1.0/clients/:client_id/team_authorizations

Create a team authorization of a client

Parameters

Name	Description	type
team_authorization[all_users]	Authorize all teams?	boolean
team_authorization[team_id]	Team ID	integer

Request

Route

POST /api/v1.0/clients/1/team_authorizations

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "team_authorization": {
    "all_users": false,
    "team_id": 1
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1/team_authorizations" -d '{"team_authorization":{"all_users":false,"team_id":1}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 97

Body

{
  "id": 7,
  "all_users": false,
  "team_id": 1,
  "team_authorizable_id": 1,
  "team_authorizable_type": "Client"
}

DELETE

/api/v1.0/clients/:client_id/team_authorizations/:id

Destroy a team authorization of a client

Parameters

Name	Description	type
id required	ID of Team Authorization	integer

Request

Route

DELETE /api/v1.0/clients/1/team_authorizations/22

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/clients/1/team_authorizations/22" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Teams

GET

/api/v1.0/teams

List all teams

List all teams that the current user can view.

Request

Route

GET /api/v1.0/teams

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/teams" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 132

Body

[
  {
    "id": 1,
    "name": "Team1",
    "master_user_id": "coyote-388",
    "master_user_name": "Coyote 388",
    "cost_center": null,
    "user_ids": [
      "coyote-388"
    ]
  }
]

GET

/api/v1.0/teams

List all teams by id

List all teams that the current user can view.

Request

Route

GET /api/v1.0/teams?ids=1%2C2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

ids=1,2

cURL

curl "https://secure.runrun.it/api/v1.0/teams?ids=1%2C2" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 251

Body

[
  {
    "id": 1,
    "name": "Team1",
    "master_user_id": "coyote-2",
    "master_user_name": "Coyote 2",
    "cost_center": null,
    "user_ids": [
      "coyote-2"
    ]
  },
  {
    "id": 2,
    "name": "Team2",
    "master_user_id": "coyote-2",
    "master_user_name": "Coyote 2",
    "cost_center": null,
    "user_ids": [
      "coyote-2"
    ]
  }
]

GET

/api/v1.0/teams

Search by term

List all teams that the current user can view.

Request

Route

GET /api/v1.0/teams?search_term=Team2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

search_term=Team2

cURL

curl "https://secure.runrun.it/api/v1.0/teams?search_term=Team2" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 126

Body

[
  {
    "id": 2,
    "name": "Team2",
    "master_user_id": "coyote-3",
    "master_user_name": "Coyote 3",
    "cost_center": null,
    "user_ids": [
      "coyote-3"
    ]
  }
]

GET

/api/v1.0/teams/:id

Show a team

Parameters

Name	Description	type
id required	Id of the team	integer

Request

Route

GET /api/v1.0/teams/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/teams/1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 130

Body

{
  "id": 1,
  "name": "Team1",
  "master_user_id": "coyote-389",
  "master_user_name": "Coyote 389",
  "cost_center": null,
  "user_ids": [
    "coyote-389"
  ]
}

POST

/api/v1.0/teams

Create a team

Create a new team record with a master user.

Parameters

Name	Description	type
team[name] required	Name of the team	string
team[master_user_id]	Id of the user team leader. Default: current user id	string

Request

Route

POST /api/v1.0/teams

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "team": {
    "name": "Team1",
    "master_user_id": "coyote-390"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/teams" -d '{"team":{"name":"Team1","master_user_id":"coyote-390"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 130

Body

{
  "id": 1,
  "name": "Team1",
  "master_user_id": "coyote-390",
  "master_user_name": "Coyote 390",
  "cost_center": null,
  "user_ids": [
    "coyote-390"
  ]
}

PUT

/api/v1.0/teams/:id

Update a team

Update a existing team.

Parameters

Name	Description	type
id required	Id of the team	integer
team[name]	Name of the team	string
team[master_user_id]	Id of the user team leader. Default: current user id	string

Request

Route

PUT /api/v1.0/teams/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "team": {
    "name": "Team2",
    "master_user_id": "coyote-392"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/teams/1" -d '{"team":{"name":"Team2","master_user_id":"coyote-392"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 143

Body

{
  "id": 1,
  "name": "Team2",
  "master_user_id": "coyote-392",
  "master_user_name": "Coyote 392",
  "cost_center": null,
  "user_ids": [
    "coyote-391",
    "coyote-392"
  ]
}

DELETE

/api/v1.0/teams/:id

Destroy a team

Parameters

Name	Description	type
id required	Id of the team	integer

Request

Route

DELETE /api/v1.0/teams/1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/teams/1" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

GET

/api/v1.0/teams/:id/board_summary

Show the team board summary

Board summary information

Parameters

Name	Description	type
id required	Id of the team	integer

Request

Route

GET /api/v1.0/teams/1/board_summary

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/teams/1/board_summary" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 56

Body

{
  "open_tasks": 0,
  "working_tasks": 0,
  "ratings_average": 0.0
}

GET

/api/v1.0/teams/:id/load

Show the team load

Team load information

Parameters

Name	Description	type
id required	Id of the team	integer

Request

Route

GET /api/v1.0/teams/1/load

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/teams/1/load" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 52

Body

{
  "id": 1,
  "team_average": 0.0,
  "enterprise_average": 0.0
}

POST

/api/v1.0/teams/:id/add_member

Add a user to team

Parameters

Name	Description	type
team[id] required	Id of the team	integer
user_id required	New team member id	string
team_partnership	Flag to make the new team member and other members, partners	boolean

Request

Route

POST /api/v1.0/teams/1/add_member

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "user_id": "coyote-396"
}

cURL

curl "https://secure.runrun.it/api/v1.0/teams/1/add_member" -d '{"user_id":"coyote-396"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 143

Body

{
  "id": 1,
  "name": "Team1",
  "master_user_id": "coyote-397",
  "master_user_name": "Coyote 397",
  "cost_center": null,
  "user_ids": [
    "coyote-397",
    "coyote-396"
  ]
}

POST

/api/v1.0/teams/:id/remove_member

Remove a user from team

Parameters

Name	Description	type
team[id] required	Id of the team	integer
user_id required	Team member id	string

Request

Route

POST /api/v1.0/teams/1/remove_member

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "user_id": "coyote-398"
}

cURL

curl "https://secure.runrun.it/api/v1.0/teams/1/remove_member" -d '{"user_id":"coyote-398"}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 130

Body

{
  "id": 1,
  "name": "Team1",
  "master_user_id": "coyote-399",
  "master_user_name": "Coyote 399",
  "cost_center": null,
  "user_ids": [
    "coyote-399"
  ]
}

Types

GET

/api/v1.0/types

List all task types

List all task types that the current user can view.

Request

Route

GET /api/v1.0/types

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/types" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 544

Body

[
  {
    "id": 5,
    "name": "Criação",
    "is_visible": true,
    "standard_effort": "08:00",
    "avg_delivery": 0
  },
  {
    "id": 4,
    "name": "Desenvolvimento",
    "is_visible": true,
    "standard_effort": "08:00",
    "avg_delivery": 0
  },
  {
    "id": 3,
    "name": "Orçamento",
    "is_visible": true,
    "standard_effort": "04:00",
    "avg_delivery": 0
  },
  {
    "id": 2,
    "name": "Pesquisa",
    "is_visible": true,
    "standard_effort": "04:00",
    "avg_delivery": 0
  },
  {
    "id": 1,
    "name": "Planejamento",
    "is_visible": true,
    "standard_effort": "08:00",
    "avg_delivery": 0
  },
  {
    "id": 6,
    "name": "TaskType1",
    "is_visible": true,
    "standard_effort": "01:00",
    "avg_delivery": 0
  }
]

GET

/api/v1.0/types/:id

Show a task type

Parameters

Name	Description	type
id required	Id of the type	integer

Request

Route

GET /api/v1.0/types/6

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/types/6" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 88

Body

{
  "id": 6,
  "name": "TaskType1",
  "is_visible": true,
  "standard_effort": "01:00",
  "avg_delivery": 0
}

POST

/api/v1.0/types

Create a task type

Create a new task type record.

Parameters

Name	Description	type
type[name] required	Type name	string
type[is_visible]	Is the type visible to be chosen? Default: true	boolean
type[standard_effort]	Default effort to complete a task of this type. Default: '02:00'	string

Request

Route

POST /api/v1.0/types

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "type": {
    "name": "TaskType1",
    "is_visible": true,
    "standard_effort": "03:00"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/types" -d '{"type":{"name":"TaskType1","is_visible":true,"standard_effort":"03:00"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 88

Body

{
  "id": 6,
  "name": "TaskType1",
  "is_visible": true,
  "standard_effort": "03:00",
  "avg_delivery": 0
}

PUT

/api/v1.0/types/:id

Update a task type

Update a existing task type.

Parameters

Name	Description	type
id required	Id of the type	integer
type[name]	Type name	string
type[is_visible]	Is the type visible to be chosen? Default: true	boolean
type[standard_effort]	Default effort to complete a task of this type. Default: '02:00'	string

Request

Route

PUT /api/v1.0/types/6

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "type": {
    "name": "TaskType2",
    "is_visible": false,
    "standard_effort": "04:00"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/types/6" -d '{"type":{"name":"TaskType2","is_visible":false,"standard_effort":"04:00"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 89

Body

{
  "id": 6,
  "name": "TaskType2",
  "is_visible": false,
  "standard_effort": "04:00",
  "avg_delivery": 0
}

User Statistics

GET

/api/v1.0/user_statistics/:id

Get user's RR-Rating®

Get a user's RR-Rating® by id

Request

Route

GET /api/v1.0/user_statistics/coyote-404

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/user_statistics/coyote-404" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
total	User's RR-Rating	integer
created_at	Calculated as of	datetime
total_month_variation	Variation from last month

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 83

Body

{
  "total": 341,
  "created_at": "2017-01-17T18:10:41-02:00",
  "total_month_variation": null
}

Users

GET

/api/v1.0/users

List all Users

List all enterprise users based on the priviligies of the user_token owner.

Permission	JSON attribute	Response
Flagged as Administrator on Runrun.it	`is_master: true`	return a list of all users
Not flagged as Administrator on Runrun.it	`is_master: false`	return a list of teammates

Request

Route

GET /api/v1.0/users

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/users" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	User's ID	string
name	User's full name	string
email	User's email	string
avatar_url	User's chosen profile photo	url
avatar_large_url	User's chosen profile photo	url
super_compact_view	internal usage	boolean
compact_side_menu	internal usage	boolean
cost_hour	Current user cost per hour	decimal
is_master	User is an administrator	boolean
is_manager	User is a manager	boolean
can_create_client_project_and_task_types	User has permission to create client, projects and task types	boolean
time_zone	IANA Time Zone Database zone name	string
position	Job position in company	string
on_vacation	User currently on vacation	boolean
birthday	User's birthday	date
phone	User phone	string
gender	User gender	string
marital_status	User marital status	string
in_company_since	Joining date in company	date
is_certified	Whether the user has passed Runrun.it certification	boolean
language	User preference language	string
oid	Constant size ID (internal use only)	string
see_archived_clients_and_projects	Admin decides either to see or not archived clients and projects	boolean
budget_manager	Can edit project extra costs	boolean
shifts	User shifts	array
is_mensurable	Can process RR Ratings?	boolean
time_tracking_mode	Current Time tracking mode, 'smart' for automatic tracking time based on shift or 'manual'	string

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 3251

Body

[
  {
    "id": "coyote-1",
    "name": "Coyote 1",
    "email": "coyote1@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_2.png",
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "can_create_client_project_and_task_types": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "49537adb9",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  },
  {
    "id": "coyote-2",
    "name": "Coyote 2",
    "email": "coyote2@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_3.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_3.png",
    "super_compact_view": true,
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": true,
    "is_manager": false,
    "can_create_client_project_and_task_types": true,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "92a6f5b72",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  }
]

GET

/api/v1.0/users

List all Users by ids

List all enterprise users based on the priviligies of the user_token owner.

Permission	JSON attribute	Response
Flagged as Administrator on Runrun.it	`is_master: true`	return a list of all users
Not flagged as Administrator on Runrun.it	`is_master: false`	return a list of teammates

Request

Route

GET /api/v1.0/users?ids=coyote-5%2Ccoyote-3

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

ids=coyote-5,coyote-3

cURL

curl "https://secure.runrun.it/api/v1.0/users?ids=coyote-5%2Ccoyote-3" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	User's ID	string
name	User's full name	string
email	User's email	string
avatar_url	User's chosen profile photo	url
avatar_large_url	User's chosen profile photo	url
super_compact_view	internal usage	boolean
compact_side_menu	internal usage	boolean
cost_hour	Current user cost per hour	decimal
is_master	User is an administrator	boolean
is_manager	User is a manager	boolean
can_create_client_project_and_task_types	User has permission to create client, projects and task types	boolean
time_zone	IANA Time Zone Database zone name	string
position	Job position in company	string
on_vacation	User currently on vacation	boolean
birthday	User's birthday	date
phone	User phone	string
gender	User gender	string
marital_status	User marital status	string
in_company_since	Joining date in company	date
is_certified	Whether the user has passed Runrun.it certification	boolean
language	User preference language	string
oid	Constant size ID (internal use only)	string
see_archived_clients_and_projects	Admin decides either to see or not archived clients and projects	boolean
budget_manager	Can edit project extra costs	boolean
shifts	User shifts	array
is_mensurable	Can process RR Ratings?	boolean
time_tracking_mode	Current Time tracking mode, 'smart' for automatic tracking time based on shift or 'manual'	string

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 3251

Body

[
  {
    "id": "coyote-3",
    "name": "Coyote 3",
    "email": "coyote3@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_2.png",
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "can_create_client_project_and_task_types": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "49537adb9",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  },
  {
    "id": "coyote-5",
    "name": "Coyote 5",
    "email": "coyote5@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_4.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_4.png",
    "super_compact_view": true,
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": true,
    "is_manager": false,
    "can_create_client_project_and_task_types": true,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "dbfa7092b",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  }
]

GET

/api/v1.0/users

List all Users by team id

List all enterprise users based on the priviligies of the user_token owner.

Permission	JSON attribute	Response
Flagged as Administrator on Runrun.it	`is_master: true`	return a list of all users
Not flagged as Administrator on Runrun.it	`is_master: false`	return a list of teammates

Request

Route

GET /api/v1.0/users?team_id=1

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

team_id=1

cURL

curl "https://secure.runrun.it/api/v1.0/users?team_id=1" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	User's ID	string
name	User's full name	string
email	User's email	string
avatar_url	User's chosen profile photo	url
avatar_large_url	User's chosen profile photo	url
super_compact_view	internal usage	boolean
compact_side_menu	internal usage	boolean
cost_hour	Current user cost per hour	decimal
is_master	User is an administrator	boolean
is_manager	User is a manager	boolean
can_create_client_project_and_task_types	User has permission to create client, projects and task types	boolean
time_zone	IANA Time Zone Database zone name	string
position	Job position in company	string
on_vacation	User currently on vacation	boolean
birthday	User's birthday	date
phone	User phone	string
gender	User gender	string
marital_status	User marital status	string
in_company_since	Joining date in company	date
is_certified	Whether the user has passed Runrun.it certification	boolean
language	User preference language	string
oid	Constant size ID (internal use only)	string
see_archived_clients_and_projects	Admin decides either to see or not archived clients and projects	boolean
budget_manager	Can edit project extra costs	boolean
shifts	User shifts	array
is_mensurable	Can process RR Ratings?	boolean
time_tracking_mode	Current Time tracking mode, 'smart' for automatic tracking time based on shift or 'manual'	string

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 3251

Body

[
  {
    "id": "coyote-6",
    "name": "Coyote 6",
    "email": "coyote6@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_2.png",
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "can_create_client_project_and_task_types": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "49537adb9",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  },
  {
    "id": "coyote-7",
    "name": "Coyote 7",
    "email": "coyote7@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_3.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_3.png",
    "super_compact_view": true,
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": true,
    "is_manager": false,
    "can_create_client_project_and_task_types": true,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "92a6f5b72",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  }
]

GET

/api/v1.0/users

List all Users by a search term

List all enterprise users based on the priviligies of the user_token owner.

Permission	JSON attribute	Response
Flagged as Administrator on Runrun.it	`is_master: true`	return a list of all users
Not flagged as Administrator on Runrun.it	`is_master: false`	return a list of teammates

Request

Route

GET /api/v1.0/users?search_term=Coyote+25

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

search_term=Coyote 25

cURL

curl "https://secure.runrun.it/api/v1.0/users?search_term=Coyote+25" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	User's ID	string
name	User's full name	string
email	User's email	string
avatar_url	User's chosen profile photo	url
avatar_large_url	User's chosen profile photo	url
super_compact_view	internal usage	boolean
compact_side_menu	internal usage	boolean
cost_hour	Current user cost per hour	decimal
is_master	User is an administrator	boolean
is_manager	User is a manager	boolean
can_create_client_project_and_task_types	User has permission to create client, projects and task types	boolean
time_zone	IANA Time Zone Database zone name	string
position	Job position in company	string
on_vacation	User currently on vacation	boolean
birthday	User's birthday	date
phone	User phone	string
gender	User gender	string
marital_status	User marital status	string
in_company_since	Joining date in company	date
is_certified	Whether the user has passed Runrun.it certification	boolean
language	User preference language	string
oid	Constant size ID (internal use only)	string
see_archived_clients_and_projects	Admin decides either to see or not archived clients and projects	boolean
budget_manager	Can edit project extra costs	boolean
shifts	User shifts	array
is_mensurable	Can process RR Ratings?	boolean
time_tracking_mode	Current Time tracking mode, 'smart' for automatic tracking time based on shift or 'manual'	string

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1641

Body

[
  {
    "id": "coyote-25",
    "name": "Coyote 25",
    "email": "coyote25@acme.foo",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_3.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_3.png",
    "super_compact_view": true,
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": true,
    "is_manager": false,
    "can_create_client_project_and_task_types": true,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "92a6f5b72",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "10:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "13:00:00",
        "shift_end": "19:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  }
]

GET

/api/v1.0/users/:user_id

Get a user by id

Parameters

Name	Description	type
user_id required	User's ID	string

Request

Route

GET /api/v1.0/users/coyote-26

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/users/coyote-26" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	User's ID	string
name	User's full name	string
email	User's email	string
avatar_url	User's chosen profile photo	url
avatar_large_url	User's chosen profile photo	url
super_compact_view	internal usage	boolean
compact_side_menu	internal usage	boolean
cost_hour	Current user cost per hour	decimal
is_master	User is an administrator	boolean
is_manager	User is a manager	boolean
can_create_client_project_and_task_types	User has permission to create client, projects and task types	boolean
time_zone	IANA Time Zone Database zone name	string
position	Job position in company	string
on_vacation	User currently on vacation	boolean
birthday	User's birthday	date
phone	User phone	string
gender	User gender	string
marital_status	User marital status	string
in_company_since	Joining date in company	date
is_certified	Whether the user has passed Runrun.it certification	boolean
language	User preference language	string
oid	Constant size ID (internal use only)	string
see_archived_clients_and_projects	Admin decides either to see or not archived clients and projects	boolean
budget_manager	Can edit project extra costs	boolean
shifts	User shifts	array
is_mensurable	Can process RR Ratings?	boolean
time_tracking_mode	Current Time tracking mode, 'smart' for automatic tracking time based on shift or 'manual'	string

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1615

Body

{
  "id": "coyote-26",
  "name": "Coyote 26",
  "email": "coyote26@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_2.png",
  "compact_side_menu": null,
  "cost_hour": 0.0,
  "is_master": false,
  "is_manager": false,
  "can_create_client_project_and_task_types": false,
  "time_zone": "America/Sao_Paulo",
  "position": null,
  "on_vacation": false,
  "birthday": null,
  "phone": null,
  "gender": null,
  "marital_status": null,
  "in_company_since": null,
  "is_certified": false,
  "language": "pt-BR",
  "oid": "49537adb9",
  "see_archived_clients_and_projects": null,
  "budget_manager": false,
  "shifts": [
    {
      "weekday": 0,
      "work_day": false,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 1,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 2,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 3,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 4,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 5,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 6,
      "work_day": false,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    }
  ],
  "is_mensurable": true,
  "time_tracking_mode": "smart"
}

POST

/api/v1.0/users

Create a user

Create a user on an existing account. Upon creation a temporary password will be created and sent to the new user by email. Any locale settings (language, time zone, etc.) will be the same as the user issuing the API call. If the account has reached the maximum number of users a 403 Forbidden will be returned. The make_my_partner and make_everybody_mutual_partners flags are a convenience for when you may wish to assign tasks to the new user immediately (the same can be accomplished with the Partners API calls).

Parameters

Name	Description	type
user[name] required	User's full name	string
user[email] required	User's email	string
make_my_partner	Flag to make the new user a partner of the creating user	boolean
make_everybody_mutual_partners	Flag to make the new user a mutual partner of everybody in enterprise. If not set, defaults to enterprise's configuration	boolean

Request

Route

POST /api/v1.0/users

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "user": {
    "name": "Jon Smith",
    "email": "john@smith.com"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/users" -d '{"user":{"name":"Jon Smith","email":"john@smith.com"}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1660

Body

{
  "id": "jon-smith",
  "name": "Jon Smith",
  "email": "john@smith.com",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-9/jon-smith/984f2a10c494e2758f5936570402b360mini.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-9/jon-smith/984f2a10c494e2758f5936570402b360regular.png",
  "compact_side_menu": null,
  "cost_hour": 0.0,
  "is_master": false,
  "is_manager": false,
  "can_create_client_project_and_task_types": false,
  "time_zone": "America/Sao_Paulo",
  "position": null,
  "on_vacation": false,
  "birthday": null,
  "phone": null,
  "gender": null,
  "marital_status": null,
  "in_company_since": null,
  "is_certified": false,
  "language": "pt-BR",
  "oid": "92a6f5b72",
  "see_archived_clients_and_projects": null,
  "budget_manager": false,
  "shifts": [
    {
      "weekday": 0,
      "work_day": false,
      "shift_start": "09:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "12:30:00",
      "shift_end": "17:00:00"
    },
    {
      "weekday": 1,
      "work_day": true,
      "shift_start": "09:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "12:30:00",
      "shift_end": "17:00:00"
    },
    {
      "weekday": 2,
      "work_day": true,
      "shift_start": "09:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "12:30:00",
      "shift_end": "17:00:00"
    },
    {
      "weekday": 3,
      "work_day": true,
      "shift_start": "09:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "12:30:00",
      "shift_end": "17:00:00"
    },
    {
      "weekday": 4,
      "work_day": true,
      "shift_start": "09:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "12:30:00",
      "shift_end": "17:00:00"
    },
    {
      "weekday": 5,
      "work_day": true,
      "shift_start": "09:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "12:30:00",
      "shift_end": "17:00:00"
    },
    {
      "weekday": 6,
      "work_day": false,
      "shift_start": "09:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "12:30:00",
      "shift_end": "17:00:00"
    }
  ],
  "is_mensurable": true,
  "time_tracking_mode": "smart"
}

PUT

/api/v1.0/users/:id

Update a user

Parameters

Name	Description	type
user[id] required	User's ID	string

Request

Route

PUT /api/v1.0/users/jon-smith

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "user": {
    "name": "Steve Jobs"
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/users/jon-smith" -d '{"user":{"name":"Steve Jobs"}}' -X PUT \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 1614

Body

{
  "id": "jon-smith",
  "name": "Steve Jobs",
  "email": "coyote37@acme.foo",
  "avatar_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/mini_2.png",
  "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/defaults/avatars/defaults/user/regular_2.png",
  "compact_side_menu": null,
  "cost_hour": 0.0,
  "is_master": true,
  "is_manager": false,
  "can_create_client_project_and_task_types": true,
  "time_zone": "America/Sao_Paulo",
  "position": null,
  "on_vacation": false,
  "birthday": null,
  "phone": null,
  "gender": null,
  "marital_status": null,
  "in_company_since": null,
  "is_certified": false,
  "language": "pt-BR",
  "oid": "49537adb9",
  "see_archived_clients_and_projects": null,
  "budget_manager": false,
  "shifts": [
    {
      "weekday": 0,
      "work_day": false,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 1,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 2,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 3,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 4,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 5,
      "work_day": true,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    },
    {
      "weekday": 6,
      "work_day": false,
      "shift_start": "10:00:00",
      "lunch_start": "12:00:00",
      "lunch_end": "13:00:00",
      "shift_end": "19:00:00"
    }
  ],
  "is_mensurable": true,
  "time_tracking_mode": "smart"
}

POST

/api/v1.0/users/import

Import users

Create a collection of users. Upon creation a temporary password will be created and sent to each new user by email. Any locale settings (language, time zone, etc.) will be the same as the user issuing the API call. If the account has reached the maximum number of users, only the first users will be created and returned.

Parameters

Name	Description	type
users	Array of users with 'name' and 'email'	array
make_my_partners	Flag to make imported users as partners of the creating user	boolean
make_my_demanders	Flag to make imported users as demanders of the creating user	boolean
mutual_partners	Flag to make imported users mutual partners	boolean
team_id	Team ID. If present, all imported users will be added in the team	boolean

Request

Route

POST /api/v1.0/users/import

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "users": [
    {
      "name": "User 1",
      "email": "user1@email.com"
    },
    {
      "name": "User 2",
      "email": "user2@email.com"
    },
    {
      "name": "User 3",
      "email": "user3@email.com"
    },
    {
      "name": "User 4",
      "email": "user4@email.com"
    }
  ]
}

cURL

curl "https://secure.runrun.it/api/v1.0/users/import" -d '{"users":[{"name":"User 1","email":"user1@email.com"},{"name":"User 2","email":"user2@email.com"},{"name":"User 3","email":"user3@email.com"},{"name":"User 4","email":"user4@email.com"}]}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 6611

Body

[
  {
    "id": "user-1",
    "name": "User 1",
    "email": "user1@email.com",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-19/user-1/f46b537c1879ee4fa2b85c980a736e86mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-19/user-1/f46b537c1879ee4fa2b85c980a736e86regular.png",
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "can_create_client_project_and_task_types": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "92a6f5b72",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  },
  {
    "id": "user-2",
    "name": "User 2",
    "email": "user2@email.com",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-19/user-2/20b19229b756d5f98254adfdb5e9ec03mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-19/user-2/20b19229b756d5f98254adfdb5e9ec03regular.png",
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "can_create_client_project_and_task_types": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "dbfa7092b",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  },
  {
    "id": "user-3",
    "name": "User 3",
    "email": "user3@email.com",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-19/user-3/479e2a39ea0b3681aa247ad5e2de4d46mini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-19/user-3/479e2a39ea0b3681aa247ad5e2de4d46regular.png",
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "can_create_client_project_and_task_types": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "1254deb6e4",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  },
  {
    "id": "user-4",
    "name": "User 4",
    "email": "user4@email.com",
    "avatar_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-19/user-4/7b33f11976b1813ed581335b6eab92aamini.png",
    "avatar_large_url": "https://s3.amazonaws.com/runrunit_dev/avatars/acme-19/user-4/7b33f11976b1813ed581335b6eab92aaregular.png",
    "compact_side_menu": null,
    "cost_hour": 0.0,
    "is_master": false,
    "is_manager": false,
    "can_create_client_project_and_task_types": false,
    "time_zone": "America/Sao_Paulo",
    "position": null,
    "on_vacation": false,
    "birthday": null,
    "phone": null,
    "gender": null,
    "marital_status": null,
    "in_company_since": null,
    "is_certified": false,
    "language": "pt-BR",
    "oid": "16ea16649d",
    "see_archived_clients_and_projects": null,
    "budget_manager": false,
    "shifts": [
      {
        "weekday": 0,
        "work_day": false,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 1,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 2,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 3,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 4,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 5,
        "work_day": true,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      },
      {
        "weekday": 6,
        "work_day": false,
        "shift_start": "09:00:00",
        "lunch_start": "12:00:00",
        "lunch_end": "12:30:00",
        "shift_end": "17:00:00"
      }
    ],
    "is_mensurable": true,
    "time_tracking_mode": "smart"
  }
]

Work Periods

GET

/api/v1.0/work_periods

List all work periods

List all work periods. If a user_id or task_id is supplied, only work periods for the given user and/or task will be returned. starting_from, starting_before, ending_from and ending_before can be used to specify a date window. The default period is 1 month if not specified.

Parameters

Name	Description	type
work_period[task_id]	ID of task	integer
work_period[user_id]	ID of user who did the work	integer
work_period[starting_from]
work_period[starting_before]
work_period[ending_from]
work_period[ending_before]

Request

Route

GET /api/v1.0/work_periods?task_id=10531

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

task_id=10531

cURL

curl "https://secure.runrun.it/api/v1.0/work_periods?task_id=10531" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 115

Body

[
  {
    "id": 1,
    "task_id": 10531,
    "start": "2014-01-08T15:00:00-02:00",
    "end": null,
    "user_id": "coyote-435",
    "worked_time": 3600
  }
]

GET

/api/v1.0/work_periods/:id

Show a Work Period

Request

Route

GET /api/v1.0/work_periods/1?task_id=10531

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

task_id=10531

cURL

curl "https://secure.runrun.it/api/v1.0/work_periods/1?task_id=10531" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Response Fields

Name	Description	type
id	ID of timesheet	integer
task_id	ID of task	integer
start	Date time that user start working on the task	datetime
end	Date time that user stop working on the task	datetime
user_id	ID of user who did the work	integer
worked_time	Amount of time that user worked on the task in seconds	integer

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 136

Body

{
  "id": 1,
  "task_id": 10531,
  "start": "2014-01-08T15:00:00-02:00",
  "end": "2014-01-08T16:00:00-02:00",
  "user_id": "coyote-437",
  "worked_time": 3600
}

Workflow Elements

GET

/api/v1.0/workflows/:workflow_id/workflow_elements

List workflow elements

Parameters

Name	Description	type
workflow_id required	ID of workflow	integer

Request

Route

GET /api/v1.0/workflows/1/workflow_elements

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/workflows/1/workflow_elements" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 310

Body

[
  {
    "id": 1,
    "workflow_id": 1,
    "order": 1,
    "current": true,
    "completed": false,
    "completed_at": null,
    "started_at": "2017-01-17T18:12:11-02:00",
    "team_id": null,
    "user_id": "coyote-439"
  },
  {
    "id": 2,
    "workflow_id": 1,
    "order": 1,
    "current": false,
    "completed": false,
    "completed_at": null,
    "started_at": null,
    "team_id": 1,
    "user_id": "coyote-440"
  }
]

GET

/api/v1.0/workflows/:workflow_id/workflow_elements/:id

Show a workflow element

Parameters

Name	Description	type
id required	ID of workflow element	integer
workflow_id required	ID of workflow	integer

Request

Route

GET /api/v1.0/workflows/1/workflow_elements/2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/workflows/1/workflow_elements/2" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 141

Body

{
  "id": 2,
  "workflow_id": 1,
  "order": 2,
  "current": false,
  "completed": false,
  "completed_at": null,
  "started_at": null,
  "team_id": 1,
  "user_id": "coyote-444"
}

POST

/api/v1.0/workflows/:workflow_id/workflow_elements

Create a workflow element

Parameters

Name	Description	type
workflow_id required	ID of workflow	integer
user_id required	User ID	string
team_id	Team ID of the user	integer
order	Order of the element on workflow	integer

Request

Route

POST /api/v1.0/workflows/1/workflow_elements

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "workflow_element": {
    "user_id": "coyote-448",
    "team_id": 1,
    "order": 2
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/workflows/1/workflow_elements" -d '{"workflow_element":{"user_id":"coyote-448","team_id":1,"order":2}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 141

Body

{
  "id": 2,
  "workflow_id": 1,
  "order": 2,
  "current": false,
  "completed": false,
  "completed_at": null,
  "started_at": null,
  "team_id": 1,
  "user_id": "coyote-448"
}

POST

/api/v1.0/workflows/:workflow_id/workflow_elements/:id/reorder

Reorder a workflow element

Parameters

Name	Description	type
id required	ID of workflow element	integer
workflow_id required	ID of workflow	integer
order	Order of the element on workflow	integer

Request

Route

POST /api/v1.0/workflows/1/workflow_elements/3/reorder

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "order": 2
}

cURL

curl "https://secure.runrun.it/api/v1.0/workflows/1/workflow_elements/3/reorder" -d '{"order":2}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 141

Body

{
  "id": 3,
  "workflow_id": 1,
  "order": 2,
  "current": false,
  "completed": false,
  "completed_at": null,
  "started_at": null,
  "team_id": 1,
  "user_id": "coyote-455"
}

DELETE

/api/v1.0/workflows/:workflow_id/workflow_elements/:id

Destroy a workflow element

Parameters

Name	Description	type
id required	ID of workflow element	integer
workflow_id required	ID of workflow	integer

Request

Route

DELETE /api/v1.0/workflows/1/workflow_elements/2

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

cURL

curl "https://secure.runrun.it/api/v1.0/workflows/1/workflow_elements/2" -d '' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Workflows

GET

/api/v1.0/workflows

Show a task workflow

Parameters

Name	Description
task_id required	ID of the task the workflow belongs to

Request

Route

GET /api/v1.0/workflows?task_id=114

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

task_id=114

cURL

curl "https://secure.runrun.it/api/v1.0/workflows?task_id=114" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 77

Body

{
  "id": 1,
  "task_id": 114,
  "current_workflow_element_id": 1,
  "is_last_element": true
}

POST

/api/v1.0/workflows

Create a task workflow

Parameters

Name	Description
task_id required	ID of the task the workflow will be associated

Request

Route

POST /api/v1.0/workflows

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_id": 115,
  "workflow": {
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/workflows" -d '{"task_id":115,"workflow":{}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 77

Body

{
  "id": 1,
  "task_id": 115,
  "current_workflow_element_id": 1,
  "is_last_element": true
}

DELETE

/api/v1.0/workflows

Destroy task workflow

Parameters

Name	Description
task_id required	ID of the task the workflow belongs to

Request

Route

DELETE /api/v1.0/workflows

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_id": 117
}

cURL

curl "https://secure.runrun.it/api/v1.0/workflows" -d '{"task_id":117}' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

GET

/api/v1.0/workflows

Show a task_template workflow

Parameters

Name	Description
task_template_id required	ID of the task_template the workflow belongs to

Request

Route

GET /api/v1.0/workflows?task_template_id=33

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Query Parameters

task_template_id=33

cURL

curl "https://secure.runrun.it/api/v1.0/workflows?task_template_id=33" -X GET \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 88

Body

{
  "id": 1,
  "task_template_id": 33,
  "current_workflow_element_id": null,
  "is_last_element": true
}

POST

/api/v1.0/workflows

Create a task_template workflow

Parameters

Name	Description
task_template_id required	ID of the task_template the workflow will be associated

Request

Route

POST /api/v1.0/workflows

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_template_id": 34,
  "workflow": {
  }
}

cURL

curl "https://secure.runrun.it/api/v1.0/workflows" -d '{"task_template_id":34,"workflow":{}}' -X POST \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Status

Headers

Content-Type: application/json; charset=utf-8
Content-Length: 88

Body

{
  "id": 1,
  "task_template_id": 34,
  "current_workflow_element_id": null,
  "is_last_element": true
}

DELETE

/api/v1.0/workflows

Destroy task_template workflow

Parameters

Name	Description
task_template_id required	ID of the task_template the workflow belongs to

Request

Route

DELETE /api/v1.0/workflows

Headers

App-Key: 1a219437eab893dc115509bb85e06d77
User-Token: 9flMUzLxQtxohKGZjU5
Content-Type: application/json
Host: example.org

Body

{
  "task_template_id": 36
}

cURL

curl "https://secure.runrun.it/api/v1.0/workflows" -d '{"task_template_id":36}' -X DELETE \
	-H "App-Key: 1a219437eab893dc115509bb85e06d77" \
	-H "User-Token: 9flMUzLxQtxohKGZjU5" \
	-H "Content-Type: application/json"

Response

Simulated Response

Runrun.it API Documentation

How to authenticate to use the API

How to obtain authentication information to use the API

Data format

Monitoring

Contacting API Support

Checklist Items

/api/v1.0/checklists/:checklist_id/items

List checklist items

Request

Route

Headers

cURL

Response

Status

Headers

Body

/api/v1.0/checklists/:checklist_id/items

Create a checklist item

Request

Route

Headers

Body

cURL

Response

Status

Headers

Body

/api/v1.0/checklists/:checklist_id/items/:id

Show a checklist item

Request

Route

Headers

cURL

Response

Status

Headers

Body

/api/v1.0/checklists/:checklist_id/items/:id

Update a checklist item

Request

Route

Headers

Body

cURL

Response

Status

Headers

Body

/api/v1.0/checklists/:checklist_id/items/:id

Destroy a checklist item

Request

Route

Headers

cURL

Response

Status

Headers

Checklists

/api/v1.0/tasks/:task_id/checklist

Show a checklist from a task

Request

Route

Headers

cURL

Response

Status

Headers

Body

/api/v1.0/tasks/:task_id/checklist

Update a checklist from a task

Request

Route

Headers

Body

cURL

Response

Status

Headers

Body